Class TimeOfDaySchedule
java.lang.Object
com.inductiveautomation.ignition.common.util.TimeOfDaySchedule
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
protected class
static class
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.protected static class
protected static class
protected static interface
-
Method Summary
Modifier and TypeMethodDescriptionprotected TimeOfDaySchedule.Index
indexOf
(long symbolicTime) boolean
isCovered
(long absoluteTime) nextEvent
(long absoluteTime) Returns the next scheduled event for the time, or the time event covering the specified time.static TimeOfDaySchedule
static TimeOfDaySchedule
protected static TimeOfDaySchedule.SymbolicTime
static TimeOfDaySchedule
protected long
toAbsoluteTime
(org.joda.time.DateTime baseTime, long symbolicTime, boolean nextDay) Takes the symbolic time and converts it back to an absolute time based on the baseTime.protected long
toAbsoluteTime
(org.joda.time.DateTime baseTime, long symbolicTime, boolean nextDay, long dstOffset) toString()
protected long
toSymbolicTime
(long absoluteTime) protected long
toSymbolicTime
(org.joda.time.DateTime absoluteTime)
-
Method Details
-
toSymbolicTime
protected long toSymbolicTime(long absoluteTime) -
toSymbolicTime
protected long toSymbolicTime(org.joda.time.DateTime absoluteTime) -
toAbsoluteTime
protected long toAbsoluteTime(org.joda.time.DateTime baseTime, long symbolicTime, boolean nextDay) Takes the symbolic time and converts it back to an absolute time based on the baseTime.It basically works by converting the base to symbolic, which is essentially how the calculation was made, and then adding the diff of the symbolic times to the base.
-
toAbsoluteTime
protected long toAbsoluteTime(org.joda.time.DateTime baseTime, long symbolicTime, boolean nextDay, long dstOffset) -
isCovered
public boolean isCovered(long absoluteTime) -
nextEvent
Returns the next scheduled event for the time, or the time event covering the specified time. If the time is covered, the returned time will be aligned to the range alignment, if that was specified during the parsing. -
indexOf
-
parseSafe
-
parse
- Throws:
Exception
-
parse
- Throws:
Exception
-
parsePart
- Throws:
Exception
-
toString
-