IBoundaryItemPeriodic Interface

Interface for periodic boundary item. A periodic boundary item has a IPeriodicScheduler The value from the IPeriodicScheduler is multiplied with the AverageValue to get the value of the item. The PeriodicScheduler usually returns a value that accumulates to 1 over one day, hence the IBoundaryItemPeriodic will in that case have the AverageValue as the average of the day.

Namespace: DHI.Mike1D.BoundaryModule.PeriodicItem
Assembly: DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public interface IBoundaryItemPeriodic : IAdvancedBoundaryItem, 
	IBoundaryItem

Public Interface IBoundaryItemPeriodic
	Inherits IAdvancedBoundaryItem, IBoundaryItem

public interface class IBoundaryItemPeriodic : IAdvancedBoundaryItem, 
	IBoundaryItem

The IBoundaryItemPeriodic type exposes the following members.

Properties

	Name	Description
	ApplicationBegin	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.)
	ApplicationEnd	End datetime of the application of the item If user specified values are set, remember also to set the UseApplicationInterval (Inherited from IAdvancedBoundaryItem.)
	AverageValue	Average value of this periodic boundary item.
	EumQuantity	EUM quantity of boundary item. Used for validation and in AD also for unit conversion. (Inherited from IBoundaryItem.)
	Id	Id of periodic boundary item
	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) This flag has no effect on the simulation, only on LTS job evaluations. (Inherited from IBoundaryItem.)
	PeriodicScheduler	Periodic pattern that this boundary item is using.
	ScaleFactor	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.)
	SoftstartDuration	Duration of softstart period. Default 0 (Inherited from IAdvancedBoundaryItem.)
	SoftstartType	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.)
	SoftstartValue	Softstart initial value. Default 0.0 (Inherited from IAdvancedBoundaryItem.)
	UseApplicationInterval	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

Methods

	Name	Description
	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. (Inherited from IBoundaryItem.)
	GetNextTransitionTime	Gets the next time for which there is a different value in the boundary item. (Inherited from IBoundaryItem.)
	GetValue	Get boundary value at specified date/time. It is the callers responsibility to check if the item is applicable at the given datetime before calling GetValue. (Inherited from IBoundaryItem.)
	IsApplicable(DateTime)	Checks whether the item is applicable at the given datetime. (Inherited from IBoundaryItem.)
	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 IBoundaryItem.)
	Prepare	Prepare item for simulation. (Inherited from IBoundaryItem.)
	Validate	Validate this (Inherited from IBoundaryItem.)

Top

Reference

DHI.Mike1D.BoundaryModule.PeriodicItem Namespace