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.

Definition

Namespace: DHI.Mike1D.EcoLabDataAccess
Assembly: DHI.Mike1D.HDParameterDataAccess (in DHI.Mike1D.HDParameterDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class EcoLabForcing : IEcoLabConstantForcingBase
Inheritance
Object    EcoLabForcing
Implements
IEcoLabConstantForcingBase

Constructors

EcoLabForcingInitializes a new instance of the EcoLabForcing class

Properties

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.

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also