EcoLabConstant Class

Class for an EcoLab constant. An EcoLab constant is constant in time, but may vary in space.

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 EcoLabConstant : IEcoLabConstantForcingBase
Inheritance
Object    EcoLabConstant
Implements
IEcoLabConstantForcingBase

Constructors

EcoLabConstantInitializes a new instance of the EcoLabConstant class

Properties

BuildInId BuildIn ID if an engine provided value
DefaultValue default value
Description General description of constant
EcoLabId EcoLab ID, as defined in the template
IsGlobal Flag specifying whether the constant is global in EcoLab terms (Spatial variation = None). If constant is not global, it will be set for all computational points.

The constant may only be defined with one global value, but still have this set to false. Then that global value is applied on all computational points.

If this is set to true, only the global value in Values is used.

This must match the Spatial Variation value in the ECO Lab template

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 Values of constant.

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