BoundaryItemPeriodicMonthly Class

A boundary item with constant values in each month

Inheritance Hierarchy

SystemObject
DHI.Mike1D.BoundaryModuleBoundaryItemPeriodicMonthly

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

Syntax

public class BoundaryItemPeriodicMonthly : IBoundaryItem, 
	IExtensibleDataObject

Public Class BoundaryItemPeriodicMonthly
	Implements IBoundaryItem, IExtensibleDataObject

public ref class BoundaryItemPeriodicMonthly : IBoundaryItem, 
	IExtensibleDataObject

The BoundaryItemPeriodicMonthly type exposes the following members.

Constructors

	Name	Description
	BoundaryItemPeriodicMonthly	Constructor
	BoundaryItemPeriodicMonthly(IListDouble)	Constructor, setting up monthly values.

Properties

	Name	Description
	EumQuantity	EUM quantity of boundary item. Used for validation and in AD also for unit conversion.
	ExtensionData	Gets or sets the structure that contains extra data.
	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.
	MonthlyValues	Monthly values, constant within each month.
	ScaleFactor	Global scale factor with which the values are scaled.

Methods

	Name	Description
	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	Gets the next time for which there is a different value in the boundary item.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	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.
	IsApplicable(DateTime)	Checks whether the item is applicable at the given datetime.
	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
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Prepare	Prepare item for simulation.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Validate	Validate this