com.inductiveautomation.ignition.common.util

Class TimeOfDaySchedule.ScheduledTime

java.lang.Object

com.inductiveautomation.ignition.common.util.TimeOfDaySchedule.ScheduledTime

Enclosing class:

TimeOfDaySchedule

public static class TimeOfDaySchedule.ScheduledTime
extends java.lang.Object

This class provides information about the specific absolute time to run, but also the symbolic time of day, and the id of the event that was used to generate it.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScheduledTime(int id, java.util.Date absoluteDate, long timeOfDay)

Method Summary

Modifier and Type	Method and Description
java.util.Date	getAbsoluteDate() Returns the time as an absolute java date.
int	getId() Returns an id for the time, in order to be able to distinguish different time events.
long	getTimeOfDay() Returns the value as the time of day, milliseconds between [0-24) hours.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScheduledTime

protected ScheduledTime(int id,
                        java.util.Date absoluteDate,
                        long timeOfDay)

Method Detail

getId

public int getId()

Returns an id for the time, in order to be able to distinguish different time events. The id will be the same for each time of day event, for any absolute time. In other words, a "9am" time event would have the same id each day.

getAbsoluteDate

public java.util.Date getAbsoluteDate()

Returns the time as an absolute java date.

getTimeOfDay

public long getTimeOfDay()

Returns the value as the time of day, milliseconds between [0-24) hours.