Click or drag to resize

IBoundaryItemPeriodic Properties

The IBoundaryItemPeriodic type exposes the following members.

Properties
  NameDescription
Public propertyApplicationBegin
Start datetime of the application of the item.

If user specified values are set, remember also to set the UseApplicationInterval

Remarks
If UseApplicationInterval is false, this is set automatically during prepare phase to either
  • Globally: Simulation start time
  • Locally: Item source start time (typically timeseries file start)
(Inherited from IAdvancedBoundaryItem.)
Public propertyApplicationEnd
End datetime of the application of the item

If user specified values are set, remember also to set the UseApplicationInterval

(Inherited from IAdvancedBoundaryItem.)
Public propertyAverageValue
Average value of this periodic boundary item.
Public propertyEumQuantity
EUM quantity of boundary item.

Used for validation and in AD also for unit conversion.

(Inherited from IBoundaryItem.)
Public propertyId
Id of periodic boundary item
Public propertyIsDryWeatherFlow
Boundary items can be marked as "dry weather flow" (used in MIKE URBAN). This is used in Long Term Simulation to exclude dry weather flow from the total inflow when evaluating how to start a new LTS job (if selecting a new hot start file)

This flag has no effect on the simulation, only on LTS job evaluations.

(Inherited from IBoundaryItem.)
Public propertyPeriodicScheduler
Periodic pattern that this boundary item is using.
Public propertyScaleFactor
A factor by which values are scaled. Default 1.0.

Only valid for certain item types, e.g., load/inflow types, not for types like waterlevel.

(Inherited from IAdvancedBoundaryItem.)
Public propertySoftstartDuration
Duration of softstart period. Default 0
(Inherited from IAdvancedBoundaryItem.)
Public propertySoftstartType
Type of softstart. Default none

Softstart does not make sense for all boundary types, typically only for those that otherwise can be disabled/left out of the simulation.

Softstart starttime is ApplicationBegin which if not set explicitly is either
  • Globally: Simulation start time
  • Locally: Item source start time (typically timeseries file start)
(Inherited from IAdvancedBoundaryItem.)
Public propertySoftstartValue
Softstart initial value. Default 0.0
(Inherited from IAdvancedBoundaryItem.)
Public propertyUseApplicationInterval
Boolean specifying whether the application of the item is limited in time

Set this flag if user specified values of ApplicationBegin and ApplicationEnd is to be used. If this flag is not set the application begin and end time will be overwritten/controlled by the Boundary Data, set in Prepare(DateTime, DateTime, IDiagnostics) or by the individual boundary item.

(Inherited from IAdvancedBoundaryItem.)
Top
See Also