Click or drag to resize

BoundaryItemTimeSeriesBase Class

Time series boundary item. Generel access to one time series item.

This is a base class for other time series classes, handling the time and values of a time series, time interpolation etc.

Inheritance Hierarchy

Namespace:  DHI.Mike1D.BoundaryModule
Assembly:  DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
Copy
public class BoundaryItemTimeSeriesBase : AbstractBoundaryItem, 
	IExtensibleDataObject

The BoundaryItemTimeSeriesBase type exposes the following members.

Constructors
  NameDescription
Public methodBoundaryItemTimeSeriesBase
Initializes a new instance of the BoundaryItemTimeSeriesBase class
Top
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 AbstractBoundaryItem.)
Public propertyApplicationEnd
End datetime of the application of the item

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

(Inherited from AbstractBoundaryItem.)
Public propertyEumQuantity
EUM quantity of boundary item.

Used for validation and in AD also for unit conversion.

(Overrides AbstractBoundaryItemEumQuantity.)
Public propertyExtensionData
Data from an extended DataContract not recognized here
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 AbstractBoundaryItem.)
Public propertyItem
TsItem contains the data for the specified time series.
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 AbstractBoundaryItem.)
Public propertySoftstartDuration
Duration of softstart period. Default 0
(Inherited from AbstractBoundaryItem.)
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 AbstractBoundaryItem.)
Public propertySoftstartValue
Softstart initial value. Default 0.0
(Inherited from AbstractBoundaryItem.)
Public propertyTime
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 AbstractBoundaryItem.)
Top
Methods
  NameDescription
Public methodEndTime
End time of time series
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 methodGetAccumulatedValue

Get boundary value accumulated over the specified period.

It is the callers responsibility to check if the item is applicable at the given datetime before calling GetAccumulatedValue.

If the item is only applicable over a part of the interval, it must return the accumulated value for that part of the interval.

(Overrides AbstractBoundaryItemGetAccumulatedValue(DateTime, DateTime).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetNextTransitionTime
Returns the next time when there is a different value (or transition value) in the TsItem after the given time.
(Overrides AbstractBoundaryItemGetNextTransitionTime(DateTime).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Get value for this source
(Overrides AbstractBoundaryItemGetValue(DateTime).)
Public methodIsApplicable(DateTime)
Checks whether the item is applicable at the given datetime.
(Inherited from AbstractBoundaryItem.)
Public methodIsApplicable(DateTime, DateTime)
Checks whether the item is applicable at the given time interval. It returns true also if the item covers only a part of the start-end interval
(Inherited from AbstractBoundaryItem.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Prepare item for simulation.
(Overrides AbstractBoundaryItemPrepare(DateTime, DateTime, IDiagnostics).)
Protected methodSoftstartAccumulatedWeighting
Weights the accumulatedValue with the hot-start value.
(Inherited from AbstractBoundaryItem.)
Protected methodSoftstartFactor
Calculate the strength factor of the softstart. Uses _applicationBegin as the startup Usage: a = SoftStartFactor(t); Value = (1-a)*_softstartValue + (a)*Value;
(Inherited from AbstractBoundaryItem.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodValidate (Overrides AbstractBoundaryItemValidate.)
Top
Fields
See Also