BoundaryItemTimeSeries Class |
Inheritance HierarchyDHI.Mike1D.BoundaryModuleAbstractBoundaryItem
DHI.Mike1D.BoundaryModuleBoundaryItemTimeSeriesBase
DHI.Mike1D.BoundaryModuleBoundaryItemTimeSeries
Namespace: DHI.Mike1D.BoundaryModule
Assembly: DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe BoundaryItemTimeSeries type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BoundaryItemTimeSeries | Initializes a new instance of the BoundaryItemTimeSeries class |
Properties| Name | Description | |
|---|---|---|
 | ApplicationBegin |
Start datetime of the application of the item.
(Inherited from AbstractBoundaryItem.)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
|
| ApplicationEnd |
End datetime of the application of the item
(Inherited from AbstractBoundaryItem.)If user specified values are set, remember also to set the UseApplicationInterval |
| EumQuantity |
EUM quantity of boundary item.
(Overrides BoundaryItemTimeSeriesBaseEumQuantity.)Used for validation and in AD also for unit conversion. |
| ExtensionData |
Data from an extended DataContract not recognized here
(Inherited from BoundaryItemTimeSeriesBase.) |
| FilePath |
File path of time series file
|
| IsDryWeatherFlow |
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)
(Inherited from AbstractBoundaryItem.)This flag has no effect on the simulation, only on LTS job evaluations. |
| Item |
TsItem contains the data for the specified time series.
(Inherited from BoundaryItemTimeSeriesBase.) |
| ItemIndex |
Index of item in the time series file
|
| ScaleFactor |
A factor by which values are scaled. Default 1.0.
(Inherited from AbstractBoundaryItem.)Only valid for certain item types, e.g., load/inflow types, not for types like waterlevel. |
| SoftstartDuration |
Duration of softstart period. Default 0
(Inherited from AbstractBoundaryItem.) |
| SoftstartType |
Type of softstart. Default none
(Inherited from AbstractBoundaryItem.)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
|
| SoftstartValue |
Softstart initial value. Default 0.0
(Inherited from AbstractBoundaryItem.) |
| Time | (Inherited from BoundaryItemTimeSeriesBase.) |
| TsBuffer |
TsBuffer, common object containing all time series loaded in the setup, for reuse.
|
| TSCollection | TSCollection that this item is part of.
|
| UseApplicationInterval |
Boolean specifying whether the application of the item is limited in time
(Inherited from AbstractBoundaryItem.)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. |
| ValueType |
Type of value in time.
|
Methods| Name | Description | |
|---|---|---|
 | Create(IFilePath, Int32) |
Create a new boundary item, using the input to set it up
|
| Create(IFilePath, Int32, TsCollection) |
Create a new boundary item, using the input to set it up
|
| Create(IFilePath, Int32, TsCollection, eumQuantity) |
Create a new boundary item, using the input to set it up
|
| EndTime |
End time of time series
(Inherited from BoundaryItemTimeSeriesBase.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetAccumulatedValue | 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. |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetNextTransitionTime |
Returns the next time when there is a different value (or transition value)
in the TsItem after the given time.
(Inherited from BoundaryItemTimeSeriesBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue |
Get value for this source
(Inherited from BoundaryItemTimeSeriesBase.) |
| IsApplicable(DateTime) |
Checks whether the item is applicable at the given datetime.
(Inherited from AbstractBoundaryItem.) |
| IsApplicable(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.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Prepare |
Prepare item for simulation.
(Overrides BoundaryItemTimeSeriesBasePrepare(DateTime, DateTime, IDiagnostics).) |
| SoftstartAccumulatedWeighting |
Weights the accumulatedValue with the hot-start value.
(Inherited from AbstractBoundaryItem.) |
| SoftstartFactor |
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.) |
| ToString |
Custom textual representation
(Overrides ObjectToString.) |
| Validate |
Validate this
(Overrides BoundaryItemTimeSeriesBaseValidate.) |
Fields| Name | Description | |
|---|---|---|
 | _applicationBegin | See ApplicationBegin (Inherited from AbstractBoundaryItem.) |
| _applicationEnd | See ApplicationEnd (Inherited from AbstractBoundaryItem.) |
| _scaleFactor | See ScaleFactor (Inherited from AbstractBoundaryItem.) |
| _softstartDuration | (Inherited from AbstractBoundaryItem.) |
| _softstartType | See SoftstartType (Inherited from AbstractBoundaryItem.) |
| _softstartValue | See SoftstartValue (Inherited from AbstractBoundaryItem.) |
| _tsItem |
TsItem contains the data for the specified time series.
(Inherited from BoundaryItemTimeSeriesBase.) |
| _tsTime | (Inherited from BoundaryItemTimeSeriesBase.) |
| _useApplicationInterval | (Inherited from AbstractBoundaryItem.) |
See Also