com.anylogic.engine.Schedule<V>

Type Parameters:: V - the type of schedule values

All Implemented Interfaces:: com.anylogic.engine.internal.Child, Serializable

Direct Known Subclasses:: ScheduleWithUnits

public class Schedule<V extends Serializable>
extends Object
implements Serializable, com.anylogic.engine.internal.Child

Schedule class. Allows to track moments specified using time table with some period. Also, annual and single exceptions may be added to the schedule.
Schedule provides 4 types of information:

the current value: getValue()
the moment since the schedule has been holding its current value: getTimeOfValue(), getDateOfValue()
the next value of the schedule (which will be set in future): getNextValue()
the time of the moment schedule switches to the next value: getTimeOfNextValue(), getDateOfNextValue(), getTimeoutToNextValue()

All these accessor methods are available in several forms:

without any argument - data is retrieved for the current model time
with argument time of type double: data is retrieved for the provided model time. In case of +/-infinity or NaN argument value, getValue* and getDate* methods return null, and getTime* and getTimeout* methods return Double.NaN
with argument date of type Date: data is retrieved for the provided model date. In case of null argument value, getValue* and getDate* methods return null, and getTime* and getTimeout* methods return Double.NaN

This object may be used for event scheduling. See the following code example (please note, that it is more preferable to use getTimeOfNextValue() method instead of getTimeoutToNextValue() because of possible numeric calculation errors). Create the timeout event which occurs once at the time:

        schedule.getTimeOfValue() == time() ? time() : schedule.getTimeOfNextValue()

and has the following action code:

        // ...your custom actions are here...
        event.restartTo( schedule.getTimeOfNextValue() );

Author:: AnyLogic North America, LLC https://anylogic.com
See Also:: Serialized Form

Constructor Summary

Constructor	Description
`Schedule()`	Creates new schedule object
`Schedule(Utilities owner, boolean calendarType, int firstDayOfWeek, long period, long timeUnits, Long snapTo, V defaultValue, long[] starts, long[] ends, Object[] values, boolean glueIntervals, boolean[] exceptionsAnnually, boolean singleThreadMode)`	Creates new schedule object
`Schedule(Utilities owner, boolean calendarType, int firstDayOfWeek, long period, long timeUnits, Long snapTo, V defaultValue, long[] exStarts, long[] exEnds, Object[] exValues, boolean glueIntervals, boolean[] exceptionsAnnually, boolean singleThreadMode, boolean isLateInit)`	This method is internal and shouldn't be called by user. it may be removed/renamed in future.

Method Summary

Modifier and Type	Method	Description
`void`	`addException(int startYear, int startMonth, int startDay, int startHour, int startMinute, int startSecond, int endYear, int endMonth, int endDay, int endHour, int endMinute, int endSecond, V value, boolean annually)`	Adds new particular time intervals when the value defined by this schedule should have other values
`void`	`addInterval(int startWeek, int startDayOfWeek, int startHour, int startMinute, int startSecond, int endWeek, int endDayOfWeek, int endHour, int endMinute, int endSecond, V value)`	Adds new particular time interval to this schedule
`void`	`addInterval(int startDay, int startHour, int startMinute, int startSecond, int endDay, int endHour, int endMinute, int endSecond, V value)`	Adds new particular time interval to this schedule
`void`	`addInterval(int startHour, int startMinute, int startSecond, int endHour, int endMinute, int endSecond, V value)`	Adds new particular time interval to this schedule
`void`	`addInterval(int startHour, int startMinute, int startSecond, int endHour, int endMinute, int endSecond, V value, int[] weekDays)`	Adds new particular time intervals to this schedule
`void`	`addInterval(long start, long end, V value)`	Adds new particular time interval to this schedule
`void`	`addMoment(int week, int dayOfWeek, int hour, int minute, int second, V value)`	Adds new particular time moment to this schedule
`void`	`addMoment(int day, int hour, int minute, int second, V value)`	Adds new particular time moment to this schedule
`void`	`addMoment(int hour, int minute, int second, V value)`	Adds new particular time moment to this schedule
`void`	`addMoment(int hour, int minute, int second, V value, int[] weekDays)`	Adds new particular time moment to this schedule
`void`	`addMoment(long time, V value)`	Adds new particular time moment to this schedule
`Date`	`getDateOfNextValue()`	Returns the model date of the next change moment in the schedule. In case when there is no 'next' value, returns `null`
`Date`	`getDateOfNextValue(double time)`	Returns the model date of the schedule change moment next to the given model `time`. In case when there is no 'next' value, returns `null`. In case of `+/-infinity` or `NaN` argument value, returns `null`
`Date`	`getDateOfNextValue(Date date)`	Returns the model date of the schedule change moment next to the given model `date`. In case when there is no 'next' value, returns `null`. In case of `null` argument value, returns `null`
`Date`	`getDateOfValue()`	Returns the model date the current value of the schedule has been held since. If the schedule has always been holding the current value, the method returns `null`
`Date`	`getDateOfValue(double time)`	Returns the model date of the schedule change moment of the value corresponding to the given model `time`. If the schedule has always been holding the current value (up to the given `time`), the method returns `null`. In case of `+/-infinity` or `NaN` argument value, returns `null`
`Date`	`getDateOfValue(Date date)`	Returns the model date of the schedule change moment of the value corresponding to the given model `date`. If the schedule has always been holding the current value (up to the given `date`), the method returns `null`. In case of `null` argument value, returns `null`
`Set<V>`	`getDistinctValues_xjal()`	This method is internal and shouldn't be called by user. it may be removed/renamed in future.
`V`	`getNextValue()`	Returns the value of the next change moment in the schedule. In case when there is no 'next' value, returns `null`
`V`	`getNextValue(double time)`	Returns the value of the schedule change moment next to the given model `time`. In case when there is no 'next' value, returns `null`. In case of `+/-infinity` or `NaN` argument value, returns `null`
`V`	`getNextValue(double time, TimeUnits units)`	Returns the value of the schedule change moment next to the given `time`. In case when there is no 'next' value, returns `null`. In case of `+/-infinity` or `NaN` argument value, returns `null`
`V`	`getNextValue(Date date)`	Returns the value of the schedule change moment next to the given model `date`. In case when there is no 'next' value, returns `null`. In case of `null` argument value, returns `null`
`double`	`getTimeOfNextValue()`	Returns the model time of the next change moment in the schedule. In case when there is no 'next' value, returns positive infinity
`double`	`getTimeOfNextValue(double time)`	Returns the model time of the schedule change moment next to the given model `time`. In case when there is no 'next' value, returns positive infinity. In case of `+/-infinity` or `NaN` argument value, returns `Double.NaN`
`double`	`getTimeOfNextValue(Date date)`	Returns the model time of the schedule change moment next to the given model `date`. In case when there is no 'next' value, returns positive infinity. In case of `null` argument value, returns `Double.NaN`
`double`	`getTimeOfValue()`	Returns the model time the current value of the schedule has been held since. If the schedule has always been holding the current value, the method returns negative infinity
`double`	`getTimeOfValue(double time)`	Returns the model time of the schedule change moment of the value corresponding to the given model `time`. If the schedule has always been holding the current value (up to the given `time`), the method returns negative infinity. In case of `+/-infinity` or `NaN` argument value, returns `Double.NaN`
`double`	`getTimeOfValue(Date date)`	Returns the model time of the schedule change moment of the value corresponding to the given model `date`. If the schedule has always been holding the current value (up to the given `date`), the method returns negative infinity. In case of `null` argument value, returns `Double.NaN`
`double`	`getTimeoutToNextValue()`	Returns timeout to the next change moment in the schedule, measured in the model time units from the current model time. In case when there is no 'next' value, returns positive infinity
`double`	`getTimeoutToNextValue(double time)`	Returns timeout to the schedule change moment next to the given `time`, measured in the model time units from that `time`. In case when there is no 'next' value, returns positive infinity. In case of `+/-infinity` or `NaN` argument value, returns `Double.NaN`
`double`	`getTimeoutToNextValue(Date date)`	Returns timeout to the schedule change moment next to the given model `date`, measured in the model time units from that model `date`. In case when there is no 'next' value, returns positive infinity. In case of `null` argument value, returns `Double.NaN`
`long`	`getTimeUnits()`	Returns time units of the schedule
`V`	`getValue()`	Returns the value corresponding to the current model time
`V`	`getValue(double time)`	Returns the value of the schedule corresponding to the given model `time`. In case of `+/-infinity` or `NaN` argument value, returns `null`
`V`	`getValue(double time, TimeUnits units)`	Returns the value of the schedule corresponding to the given `time`. In case of `+/-infinity` or `NaN` argument value, returns `null`
`V`	`getValue(Date date)`	Returns the value of the schedule corresponding to the given model `date`. In case of `null` argument value, returns `null`
`void`	`initialize()`
`boolean`	`isInitialized()`
`void`	`lazyInit(long[] starts, long[] ends, Object[] values)`	This method is internal and shouldn't be called by user. it may be removed/renamed in future.
`void`	`restoreOwner(Object owner)`	Deprecated.
`void`	`setCalendarType(boolean calendarType)`	Sets the calendar type
`void`	`setDefaultValue(V defaultValue)`	Sets the default value used when there is no interval defined in the schedule
`void`	`setFirstDayOfWeek(int firstDayOfWeek)`	Sets the first day of the week
`void`	`setGlueIntervals(boolean glueIntervals)`
`void`	`setOwner(Utilities owner)`	Sets the owner agent or experiment owning the schedule
`void`	`setPeriod(int period)`	Sets the recurrence period of the schedule
`void`	`setSingleThreadMode(boolean singleThreadMode)`	Sets the thread mode
`void`	`setSnapTo(int year, int month, int day, int hour, int minute, int second)`	Sets start time of the schedule
`void`	`setSnapTo(long snapTo)`	Sets start time of the schedule
`void`	`setTimeUnits(long timeUnits)`	Sets the time units of the schedule
`String`	`toString()`

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Schedule

public Schedule()

Creates new schedule object

Schedule

@AnyLogicInternalAPI
public Schedule(Utilities owner,
 boolean calendarType,
 int firstDayOfWeek,
 long period,
 long timeUnits,
 Long snapTo,
 V defaultValue,
 long[] exStarts,
 long[] exEnds,
 Object[] exValues,
 boolean glueIntervals,
 boolean[] exceptionsAnnually,
 boolean singleThreadMode,
 boolean isLateInit)

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.

Schedule

public Schedule(Utilities owner,
 boolean calendarType,
 int firstDayOfWeek,
 long period,
 long timeUnits,
 Long snapTo,
 V defaultValue,
 long[] starts,
 long[] ends,
 Object[] values,
 boolean glueIntervals,
 boolean[] exceptionsAnnually,
 boolean singleThreadMode)

Creates new schedule object

Parameters:: owner - agent or experiment owning the schedule; calendarType - if true then schedule works with calendar dates. For example, if you create a schedule for 8:00-17:00 each day - these times will be preserved even during the days of Daylight Saving Time switching.
If this parameter is false, "1 day" will be treated as 24*60*60 seconds - this is good for modeling the behavior of some automatic machines which don't watch at the wall-clock during e.g. self-maintenance procedures.; firstDayOfWeek - the first day of the week, this parameter is actually used when calendarType == true and timeUnit is week; period - recurrence period of the schedule, measured in milliseconds. Milliseconds may be actual - if calendarType is false, and hypothetical - if true, which means that 1000*60*60*24 milliseconds denotes one day independently on Daylight Saving Time switching.; timeUnits - time units of the schedule, one of TIME_UNIT_* constants
In the calendar-mode the only supported time units are day and week; snapTo - the absolute date (if calendarType==true) or the number of milliseconds from the zero model time (if calendarType==false) which points to the start of some period. All schedule periods are cloned, started from the given time moment in both directions.; defaultValue - the value used when there is no interval defined in the schedule; starts - start times of intervals, measured in milliseconds from the beginning of the period (milliseconds may be actual - if calendarType is false, and hypothetical - if true, which means that 1000*60*60*24 milliseconds denotes one day independently on Daylight Saving Time switching). This array may also contain starts of exceptions (see exceptionsAnnually parameter); ends - end times of intervals, the same description as for starts; values - values for intervals; glueIntervals - if true then intersecting intervals with the same 'value' will be merged, e.g. two intervals "Day1 18:00-24:00 value=5" and "Day2 00:00-02:00 value=5" will be treated as one interval "Day1 18:00 - Day2 02:00 value=5"; exceptionsAnnually - the array of exception flags (true means annual exception, false - single occurrence), may be empty. The number of exceptions equals the length of exceptionsAnnually array. The exceptions are read from starts, ends, values arrays. Exceptions data is located in the tails of these arrays. Note that for exceptions, starts and ends arrays contain absolute dates encoded as long numbers (see Date.getTime()).; singleThreadMode - this parameter indicates whether schedule will work in single thread environment or will be used by multiple concurrent threads. This parameter is usually set to true for schedules inside agents and experiment which don't allow parallel execution (e.g. simulation experiment). But for schedules, located in optimization and parameter variation experiment which allow parallel execution this parameter should be set to false.

Method Details

isInitialized

@AnyLogicInternalCodegenAPI
public boolean isInitialized()

lazyInit

@AnyLogicInternalAPI
public void lazyInit(long[] starts,
 long[] ends,
 Object[] values)

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.

initialize

public void initialize()

setOwner

public void setOwner(Utilities owner)

Sets the owner agent or experiment owning the schedule

Parameters:: owner - - agent or experiment owning the schedule

setCalendarType

public void setCalendarType(boolean calendarType)

Sets the calendar type

Parameters:: calendarType - - if true then schedule works with calendar dates. For example, if you create a schedule for 8:00-17:00 each day - these times will be preserved even during the days of Daylight Saving Time switching.
If this parameter is false, "1 day" will be treated as 24*60*60 seconds - this is good for modeling the behavior of some automatic machines which don't watch at the wall-clock during e.g. self-maintenance procedures.

setFirstDayOfWeek

public void setFirstDayOfWeek(int firstDayOfWeek)

Sets the first day of the week

Parameters:: firstDayOfWeek - - the first day of the week, this parameter is actually used when calendarType == true and timeUnit is week

setTimeUnits

public void setTimeUnits(long timeUnits)

Sets the time units of the schedule

Parameters:: timeUnits - - time units of the schedule, one of TIME_UNIT_* constants
In the calendar-mode the only supported time units are day and week; snapTo - the absolute date (if calendarType==true) or the number of milliseconds from the zero model time (if calendarType==false) which points to the start of some period. All schedule periods are cloned, started from the given time moment in both directions

setPeriod

public void setPeriod(int period)

Sets the recurrence period of the schedule

Parameters:: period - - recurrence period of the schedule, measured in milliseconds. Milliseconds may be actual - if calendarType is false, and hypothetical - if true, which means that 1000*60*60*24 milliseconds denotes one day independently on Daylight Saving Time switching.

setSnapTo

public void setSnapTo(long snapTo)

Sets start time of the schedule

Parameters:: snapTo - - the absolute date (if calendarType==true) or the number of milliseconds from the zero model time

setSnapTo

public void setSnapTo(int year,
 int month,
 int day,
 int hour,
 int minute,
 int second)

Sets start time of the schedule

Parameters:: year - - year; month - - month; day - - day; hour - - hour; minute - - minute; second - - second

setDefaultValue

public void setDefaultValue(V defaultValue)

Sets the default value used when there is no interval defined in the schedule

Parameters:: defaultValue - - the value used when there is no interval defined in the schedule

setGlueIntervals

public void setGlueIntervals(boolean glueIntervals)

Parameters:: glueIntervals - if true then intersecting intervals with the same 'value' will be merged, e.g. two intervals "Day1 18:00-24:00 value=5" and "Day2 00:00-02:00 value=5" will be treated as one interval "Day1 18:00 - Day2 02:00 value=5"

setSingleThreadMode

public void setSingleThreadMode(boolean singleThreadMode)

Sets the thread mode

Parameters:: singleThreadMode - - this parameter indicates whether schedule will work in single thread environment or will be used by multiple concurrent threads. This parameter is usually set to true for schedules inside agents and experiment which don't allow parallel execution (e.g. simulation experiment). But for schedules, located in optimization and parameter variation experiment which allow parallel execution this parameter should be set to false.

addInterval

public void addInterval(long start,
 long end,
 V value)

Adds new particular time interval to this schedule

Parameters:: start - - start time of the interval, measured in milliseconds; end - - end time of the interval, measured in milliseconds; value - - value of the interval

addInterval

public void addInterval(int startWeek,
 int startDayOfWeek,
 int startHour,
 int startMinute,
 int startSecond,
 int endWeek,
 int endDayOfWeek,
 int endHour,
 int endMinute,
 int endSecond,
 V value)

Adds new particular time interval to this schedule

Parameters:: startWeek - - start week of the interval; startDayOfWeek - - start day of week of the interval; startHour - - start hour of the interval; startMinute - - start minute of the interval; startSecond - - start second of the interval; endWeek - - end week of the interval; endDayOfWeek - - end day of week of the interval; endHour - - end hour of the interval; endMinute - - end minute of the interval; endSecond - - end second of the interval; value - - value of the interval

addInterval

public void addInterval(int startDay,
 int startHour,
 int startMinute,
 int startSecond,
 int endDay,
 int endHour,
 int endMinute,
 int endSecond,
 V value)

Adds new particular time interval to this schedule

Parameters:: startDay - - start day of the interval; startHour - - start hour of the interval; startMinute - - start minute of the interval; startSecond - - start second of the interval; endDay - - end day of the interval; endHour - - end hour of the interval; endMinute - - end minute of the interval; endSecond - - end second of the interval; value - - value of the interval

addInterval

public void addInterval(int startHour,
 int startMinute,
 int startSecond,
 int endHour,
 int endMinute,
 int endSecond,
 V value)

Adds new particular time interval to this schedule

Parameters:: startHour - - start hour for interval; startMinute - - start minute for interval; startSecond - - start second for interval; endHour - - end hour for interval; endMinute - - end minute for interval; endSecond - - end second for interval; value - - value for interval

addInterval

public void addInterval(int startHour,
 int startMinute,
 int startSecond,
 int endHour,
 int endMinute,
 int endSecond,
 V value,
 int[] weekDays)

Adds new particular time intervals to this schedule

Parameters:: startHour - - start hour of the interval; startMinute - - start minute of the interval; startSecond - - start second of the interval; endHour - - end hour of the interval; endMinute - - end minute of the interval; endSecond - - end second of the interval; value - - value of the interval; weekDays - - week days of the intervals