Click or drag to resize

EcoLabForcing Properties

The EcoLabForcing type exposes the following members.

Properties
  NameDescription
Public propertyBuildInId
builtinID if engine provided value
Public propertyConstantValue
Constant value, used if Timetype is Constant
Public propertyDescription
General description of forcing
Public propertyEcoLabId
EcoLab ID, as defined in the template
Public propertyIsGlobal
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

Public propertyTimetype
Temporal variation.
Public propertyTsFileName
Time series file, used if Timetype is TimeSeries
Public propertyTsItemNumber
Item number in time series file, used if Timetype is TimeSeries
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
Constant, local values of Forcing.

If IsGlobal is set, only the GlobalValue is used.

Top
See Also