|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.jpeterson.x10.module.TimerInitiator
Field Summary | |
static int |
SIZEOF_TIMER_INITIATOR
|
Constructor Summary | |
TimerInitiator()
Create a new TimerInitiator. |
Method Summary | |
void |
addDayOfWeek(int weekDay)
Add a day of the week that this TimerInitiator is for. |
boolean |
checkDayOfWeek(int weekDay)
Check to see if a day of the week is set for this TimerInitiator. |
void |
clearDaysOfWeek()
Clear the days of the week for this TimerInitiator. |
byte[] |
getBytes(int startMacroOffset,
int stopMacroOffset)
Get the byte array representing this macro initiator. |
int[] |
getDaysOfWeek()
Retrieve an array of the weekdays set for this TimerInitiator. |
int |
getStartDay()
Retrieve the start day for this TimerInitiator. |
int |
getStartHour()
Get the start hour for this TimerInitiator. |
Macro |
getStartMacro()
Get the start macro. |
int |
getStartMinute()
Get the start minute for this TimerInitiator. |
int |
getStartMonth()
Retrieve the start month for this TimerInitiator. |
int |
getStopDay()
Retrieve the stop day for this TimerInitiator. |
int |
getStopHour()
Get the stop hour for this TimerInitiator. |
Macro |
getStopMacro()
Get the stop macro. |
int |
getStopMinute()
Get the stop minute for this TimerInitiator. |
int |
getStopMonth()
Retrieve the stop month for this TimerInitiator. |
void |
removeDayOfWeek(int weekDay)
Remove a day of the week that this TimerInitiator is for. |
void |
setStartDate(int month,
int day)
Set the start date for this TimerInitiator. |
void |
setStartMacro(Macro macro)
Set the start macro. |
void |
setStartTime(int hour,
int minute)
Set the start time for this TimerInitiator. |
void |
setStopDate(int month,
int day)
Set the stop day for this TimerInitiator. |
void |
setStopMacro(Macro macro)
Set the stop macro. |
void |
setStopTime(int hour,
int minute)
Set the stop time for this TimerInitiator. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int SIZEOF_TIMER_INITIATOR
Constructor Detail |
public TimerInitiator()
Method Detail |
public void addDayOfWeek(int weekDay)
weekDay
- A day of the week constant from the class
java.util.Calendar
. Should be one of the following:
Calendar.SUNDAY
, Calendar.MONDAY
,
Calendar.TUESDAY
, Calendar.WEDNESDAY
,
Calendar.THURSDAY
, Calendar.FRIDAY
,
or Calendar.SATURDAY
.Calendar
public void removeDayOfWeek(int weekDay)
weekDay
- A day of the week constant from the class
java.util.Calendar
. Should be one of the following:
Calendar.SUNDAY
, Calendar.MONDAY
,
Calendar.TUESDAY
, Calendar.WEDNESDAY
,
Calendar.THURSDAY
, Calendar.FRIDAY
,
or Calendar.SATURDAY
.Calendar
public boolean checkDayOfWeek(int weekDay)
weekDay
- A day of the week constant from the class
java.util.Calendar
. Should be one of the following:
Calendar.SUNDAY
, Calendar.MONDAY
,
Calendar.TUESDAY
, Calendar.WEDNESDAY
,
Calendar.THURSDAY
, Calendar.FRIDAY
,
or Calendar.SATURDAY
.Calendar
public int[] getDaysOfWeek()
Calendar.SUNDAY
, Calendar.MONDAY
,
Calendar.TUESDAY
, Calendar.WEDNESDAY
,
Calendar.THURSDAY
, Calendar.FRIDAY
,
or Calendar.SATURDAY
. TheCalendar
public void clearDaysOfWeek()
public void setStartDate(int month, int day)
month
- Month, zero based. e.g., 0 for January, 1 for February.day
- Daypublic int getStartDay()
public int getStartMonth()
public void setStartTime(int hour, int minute)
hour
- Hour in 24 hour time, 0 - 23. Example: 14 = 2 PM.minute
- Minute, 0 - 59.public int getStartHour()
public int getStartMinute()
public void setStopDate(int month, int day)
month
- Month, zero based. e.g., 0 for January, 1 for February.day
- Daypublic int getStopDay()
public int getStopMonth()
public void setStopTime(int hour, int minute)
hour
- Hour in 24 hour time, 0 - 23. Example: 14 = 2 PM.minute
- Minute, 0 - 59.public int getStopHour()
public int getStopMinute()
public void setStartMacro(Macro macro)
macro
- Macro to invoke.public Macro getStartMacro()
public void setStopMacro(Macro macro)
macro
- Macro to invoke.public Macro getStopMacro()
public byte[] getBytes(int startMacroOffset, int stopMacroOffset)
startMacroOffset
- Integer offset to start macro to initiate.stopMacroOffset
- Integer offset to stop macro to initiate.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |