Click or drag to resize

EcoLabConstant Class

Class for an EcoLab constant. An EcoLab constant is constant in time, but may vary in space.
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.EcoLabDataAccessEcoLabConstant

Namespace:  DHI.Mike1D.EcoLabDataAccess
Assembly:  DHI.Mike1D.HDParameterDataAccess (in DHI.Mike1D.HDParameterDataAccess.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
Copy
public class EcoLabConstant : IEcoLabConstantForcingBase

The EcoLabConstant type exposes the following members.

Constructors
  NameDescription
Public methodEcoLabConstant
Initializes a new instance of the EcoLabConstant class
Top
Properties
  NameDescription
Public propertyBuildInId
BuildIn ID if an engine provided value
Public propertyDefaultValue
default value
Public propertyDescription
General description of constant
Public propertyEcoLabId
EcoLab ID, as defined in the template
Public propertyIsGlobal
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

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

If IsGlobal is set, only the GlobalValue is used.

Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also