Click or drag to resize

PeriodicSchedule Class

Default implementation of IPeriodicSchedule.

In this schedule you define individually which of the days (1-31), months (1-12) and weekdays (Monday-Sunday) that the schedule it is active. All checks must return true before a schedule is active.

When checking for a given date/time, the weekday is provided explicitly. The weekday of a given date may have been overridden by a special day.

Inheritance Hierarchy
SystemObject
  DHI.Mike1D.BoundaryModule.PeriodicItemPeriodicSchedule

Namespace:  DHI.Mike1D.BoundaryModule.PeriodicItem
Assembly:  DHI.Mike1D.BoundaryModule (in DHI.Mike1D.BoundaryModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class PeriodicSchedule : IPeriodicSchedule, 
	IExtensibleDataObject

The PeriodicSchedule type exposes the following members.

Constructors
  NameDescription
Public methodPeriodicSchedule
Initializes a new instance of the PeriodicSchedule class
Top
Properties
  NameDescription
Public propertyDays
Array of length 31 indicating which days of the month that is part of this schedule. First element (index zero) is the first of the month. If month has less than 31 days, the last elements are just ignored. Set to null to disable use of days, i.e., all days are part of this schedule.
Public propertyDaysOfWeek
Array of length 7 indicating which days of the week that is part of this schedule. First element (index zero) is sunday, last is saturday. Set to null to disable use of DaysOfWeek, i.e., all days of the week are part of this schedule.
Public propertyExtensionData
Data from an extended DataContract not recognized here
Public propertyId
ID of periodic schedule
Public propertyMonths
Array of length 12 indicating which months of the year that is part of this schedule. First element (index zero) is January, last is December. Set to null to disable use of months, i.e., all months are part of the schedule.
Top
Methods
  NameDescription
Public methodCheck(DateTime, Int32)
Check whether this date is part of the schedule. Use if date is to be checked only against this schedule. Otherwice, precalculate date.DayOfWeek, date.Day and date.Months and used optimized version of Check.
Public methodCheck(Int32, Int32, Int32)
Check whether a date, defined by its dayOfWeek, dayOfMonth and month is part of this schedule. Use if dayOfWeek, dayOfMonth and month is precalculated from a date (for optimization)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also