EcoLabForcing Class

Class for an EcoLab forcing. An EcoLab forcing may vary in time and space.

The only forcings that vary in space, are the build-in ones. If the forcing is user specified, it is either specified as a constant in ConstantValue or as a time series file in TsFileName and TsItemNumber, depending on Timetype.

Inheritance Hierarchy

SystemObject
DHI.Mike1D.EcoLabDataAccessEcoLabForcing

Namespace: DHI.Mike1D.EcoLabDataAccess
Assembly: DHI.Mike1D.HDParameterDataAccess (in DHI.Mike1D.HDParameterDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public class EcoLabForcing : IEcoLabConstantForcingBase

Public Class EcoLabForcing
	Implements IEcoLabConstantForcingBase

public ref class EcoLabForcing : IEcoLabConstantForcingBase

The EcoLabForcing type exposes the following members.

Constructors

	Name	Description
	EcoLabForcing	Initializes a new instance of the EcoLabForcing class

Top

Properties

	Name	Description
	BuildInId	builtinID if engine provided value
	ConstantValue	Constant value, used if Timetype is Constant
	Description	General description of forcing
	EcoLabId	EcoLab ID, as defined in the template
	IsGlobal	Flag specifying whether the forcing is global in EcoLab terms (Spatial variation = None). If the forcing is not global, it will be set for all computational points. The forcing may only be defined with one global value (time series), but still have this set to false. Then that global value is applied on all computational points. This must match the Spatial Variation value in the ECO Lab template
	Timetype	Temporal variation.
	TsFileName	Time series file, used if Timetype is TimeSeries
	TsItemNumber	Item number in time series file, used if Timetype is TimeSeries
	UserSpecified	Flag defining if the value is user specified. The flag must be set if BuildInId is not defined. It can also be set if the BuildInId is defined, then the user specified value overrides the build in value.
	Values	Constant, local values of Forcing. If IsGlobal is set, only the GlobalValue is used.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

DHI.Mike1D.EcoLabDataAccess Namespace