PeriodicScheduler Class

Default implementation of IPeriodicScheduler The GetValue results are buffered. If updating the SpecialDays or the SchedulePatternMatch, call Reset() in order to reset the buffer.

Inheritance Hierarchy

SystemObject
DHI.Mike1D.BoundaryModule.PeriodicItemPeriodicScheduler

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 class PeriodicScheduler : IPeriodicScheduler, 
	IExtensibleDataObject

Public Class PeriodicScheduler
	Implements IPeriodicScheduler, IExtensibleDataObject

public ref class PeriodicScheduler : IPeriodicScheduler, 
	IExtensibleDataObject

The PeriodicScheduler type exposes the following members.

Constructors

	Name	Description
	PeriodicScheduler	Initializes a new instance of the PeriodicScheduler class

Top

Properties

	Name	Description
	ExtensionData	Data from an extended DataContract not recognized here
	Id	Id of Periodic Pattern
	ScheduleProfileMap	Schedule-DailyPattern map, ordered such that the top most ones are tested first
	SpecialDays	Special days. Set to null to remove existing/disable.

Top

Methods

	Name	Description
	Add	Add a schedule and a dailyPattern to the PeriodicScheduler
	Count	Number of Schedule-Pattern pairs
	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 the accumulated value in the time span.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetProfileAt	Return the Schedule for the Schedule-dailyPattern pair at the specified index
	GetScheduleAt	Return the Schedule for the Schedule-dailyPattern pair at the specified index
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Get the value of the periodic pattern at the given date.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Prepare	Prepare item for simulation.
	RemoveAt	Remove a schedule and a dailyPattern at the specified index
	ResetBuffer	Reset the buffer, in case changes have been made to the object, the buffer may no longer contain the correct value.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Validate	Validate this

Top

Reference

DHI.Mike1D.BoundaryModule.PeriodicItem Namespace