IPeriodicScheduler Interface

Interface for a periodic scheduler. A periodic scheduler has a number of IPeriodicSchedule with each their IOneDayProfile attached. It searches through the list of IPeriodicSchedules and finds the first active one and uses its IOneDayProfile Special days can be added, in order to change the weekday behavior of some special days, using a given date as a sunday or similar.

Definition

Namespace: DHI.Mike1D.BoundaryModule.PeriodicItem
Assembly: DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public interface IPeriodicScheduler

Properties

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.

Methods

Add Add a schedule and a dailyPattern to the PeriodicScheduler
Count Number of Schedule-Pattern pairs
GetAccumulatedValue Get the accumulated value in the time span.
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
GetValue Get the value at the given date.
Prepare Prepare item for simulation.
RemoveAt Remove a schedule and a dailyPattern at the specified index
Validate Validate this

See Also