com.inductiveautomation.ignition.common.util

Class TimeOfDaySchedule

java.lang.Object

com.inductiveautomation.ignition.common.util.TimeOfDaySchedule

public class TimeOfDaySchedule
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeOfDaySchedule.HitType
protected class	TimeOfDaySchedule.Index
static class	TimeOfDaySchedule.ScheduledTime 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	TimeOfDaySchedule.SymbolicTime
protected static class	TimeOfDaySchedule.SymbolicTimeFrame
protected static interface	TimeOfDaySchedule.Timeframe

Method Summary

Modifier and Type	Method and Description
protected TimeOfDaySchedule.Index	indexOf(long symbolicTime)
boolean	isCovered(long absoluteTime)
TimeOfDaySchedule.ScheduledTime	nextEvent(long absoluteTime) Returns the next scheduled event for the time, or the time event covering the specified time.
static TimeOfDaySchedule	parse(java.lang.String value)
static TimeOfDaySchedule	parse(java.lang.String value, int alignmentMS)
protected static TimeOfDaySchedule.SymbolicTime	parsePart(java.lang.String value)
static TimeOfDaySchedule	parseSafe(java.lang.String value)
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)
java.lang.String	toString()
protected long	toSymbolicTime(org.joda.time.DateTime absoluteTime)
protected long	toSymbolicTime(long absoluteTime)

Methods inherited from class java.lang.Object

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

Method Detail

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

public TimeOfDaySchedule.ScheduledTime nextEvent(long absoluteTime)

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

protected TimeOfDaySchedule.Index indexOf(long symbolicTime)

parseSafe

public static TimeOfDaySchedule parseSafe(java.lang.String value)

parse

public static TimeOfDaySchedule parse(java.lang.String value)
                               throws java.lang.Exception

Throws:

java.lang.Exception

parse

public static TimeOfDaySchedule parse(java.lang.String value,
                                      int alignmentMS)
                               throws java.lang.Exception

Throws:

java.lang.Exception

parsePart

protected static TimeOfDaySchedule.SymbolicTime parsePart(java.lang.String value)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object