org.wcb.autohome.implementations
Class X10Events

java.lang.Object
  org.wcb.autohome.implementations.X10Events

All Implemented Interfaces:

IX10Events, java.io.Serializable, X10DeviceConstants

public class X10Events

extends java.lang.Object

implements IX10Events, java.io.Serializable, X10DeviceConstants

Filename: $Id: X10Events.java,v 1.7 2004/02/28 00:21:49 wbogaardt Exp $ Abstract: This is the events to take place when we are running the EventsDaemon It is also a type a wrapper or solution to the CM17A not being able to execute macros and in part run a set a programed timed events. These events are only associated on the Events Panel and should not be confused with the MacroEvent module which is for CM11A uploading of macro information. $Log: X10Events.java,v $ Revision 1.7 2004/02/28 00:21:49 wbogaardt fixed formating to be compliant with sun coding convention Revision 1.6 2004/02/24 23:16:19 wbogaardt fixed formating to be compliant with checkstyles Revision 1.5 2004/01/16 00:53:43 wbogaardt Fixed a very obscure bug with the Macro Panel that it didn't added new x10 devices to the drop down of available x10 device for the macro. Modified Macro triggers to change the events to integer verses strings cleaner this way. Revision 1.4 2004/01/15 21:05:20 wbogaardt major revamp of Modules and interfaces changes overall structure of how information is stored Revision 1.3 2003/12/12 23:17:36 wbogaardt javadoc comments refactored methods so they are more descriptive Revision 1.2 2003/10/10 18:39:12 wbogaardt changed date time information from a string to a calendar object

Version:

1.1

Author:

wbogaardt

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.wcb.autohome.interfaces.X10DeviceConstants

APPLIANCE_MODULE_OFF, APPLIANCE_MODULE_ON, BAUD, BAUD_RATE_ARRAY, BRIGHT_ACTION, BROWSER, CM11A_TRANSMITTER, CM17A_TRANSMITTER, CONNECT_ON_START, COUNTRY, DATA_BIT, DATA_BITS_ARRAY, DEVICE_ARRAY, DIM_ACTION, EMAIL_AUTHORIZE, EMAIL_FREQUENCY, EMAIL_FROM, EMAIL_PASSWORD, EMAIL_SMTP, EMAIL_TO, EMAIL_USERNAME, FALSE, HOUSE_CODES_ARRAY, INTERFACE_TYPE, LAMP_MODULE_OFF, LAMP_MODULE_ON, LANGUAGE, LAST_FILE, LOCALHOST, LOOK_AND_FEEL, MAC, METAL, MOTIF, OFF_ACTION, ON_ACTION, PARITY, PARITY_ARRAY, RECOVER_CM11A, RMI_HOST, SEPARATOR, SERIAL_PORT, SPEECH_ENGINE, STOP_BIT, STOP_BITS_ARRAY, TEST_TRANSMITTER, TIMER_EVENT, TRIGGER_EVENT, TRUE, USER_HOME, WINDOWS

Constructor Summary

X10Events()
Default constructor

X10Events(IX10Events newO)
Cloning constructor

X10Events(IX10Module iModule, java.lang.String desc, java.lang.String act, java.util.Calendar time)
This creates the X10Event with the bar minimum parameters to make a functional event.

Method Summary

java.lang.String	getAction() Get the action type for the event this is a string of on, off, dim, or brighten
java.lang.String	getDescription() Gets the description of the event
boolean	getFriday() Get the Enable/disable value of the event for Friday
IX10Module	getModule() The X10 Module associated with this event
boolean	getMonday() Get the Enable/disable value of the event for Monday
boolean	getSaturday() Get the Enable/disable value of the event for Saturday
boolean	getSunday() Get the Enable/disable value of the event for Sunday
boolean	getThursday() Get the Enable/disable value of the event for Thursday
java.util.Calendar	getTime() The time of day to execute the event
boolean	getTuesday() Get the Enable/disable value of the event for Tuesday
boolean	getWednesday() Get the Enable/disable value of the event for Wednesday
void	print() method to allow printing to console some information.
void	setAction(java.lang.String act) actions to take when this event is scheduled for executing.
void	setDescription(java.lang.String desc) User description for this event
void	setDeviceModule(IX10Module imodule) Set the x10 module device to this event
void	setFriday(boolean f) Enable Friday weekday to execute event
void	setMonday(boolean m) Enable Monday weekday to execute event
void	setSaturday(boolean s) Enable Saturday weekday to execute event
void	setSunday(boolean s) Enable Sunday dates to execute event
void	setThursday(boolean t) Enable Thursday weekday to execute event
void	setTime(java.util.Calendar time) Set the time of the event
void	setTuesday(boolean t) Enable Tuesday weekday to execute event
void	setWednesday(boolean w) Enable Wednesday weekday to execute event

Methods inherited from class java.lang.Object

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

Constructor Detail

X10Events

public X10Events(IX10Module iModule,
                 java.lang.String desc,
                 java.lang.String act,
                 java.util.Calendar time)

This creates the X10Event with the bar minimum parameters to make a functional event.

Parameters:

iModule - X10 Module for the event

desc - Description of the event

act - string action of the event

time - time to execute the event.

X10Events

public X10Events()

Default constructor

X10Events

public X10Events(IX10Events newO)

Cloning constructor

Parameters:

newO - Interface used to clone object

Method Detail

print

public void print()

method to allow printing to console some information.

setDeviceModule

public void setDeviceModule(IX10Module imodule)

Set the x10 module device to this event

Specified by:

setDeviceModule in interface IX10Events

Parameters:

imodule - The module device that this event will fire action on.

setDescription

public void setDescription(java.lang.String desc)

User description for this event

Specified by:

setDescription in interface IX10Events

Parameters:

desc - - description

setAction

public void setAction(java.lang.String act)

actions to take when this event is scheduled for executing. This could be turning on or off devices or Brightening or diming lights.

Specified by:

setAction in interface IX10Events

Parameters:

act - - Value of action

setTime

public void setTime(java.util.Calendar time)

Set the time of the event

Specified by:

setTime in interface IX10Events

Parameters:

time - Time to set the event to execute.

setSunday

public void setSunday(boolean s)

Enable Sunday dates to execute event

Specified by:

setSunday in interface IX10Events

Parameters:

s - enable/disable Sunday

setMonday

public void setMonday(boolean m)

Enable Monday weekday to execute event

Specified by:

setMonday in interface IX10Events

Parameters:

m - enable/disable Monday

setTuesday

public void setTuesday(boolean t)

Enable Tuesday weekday to execute event

Specified by:

setTuesday in interface IX10Events

Parameters:

t - enable/disable Tuesday

setWednesday

public void setWednesday(boolean w)

Enable Wednesday weekday to execute event

Specified by:

setWednesday in interface IX10Events

Parameters:

w - enable/disable Wednesday

setThursday

public void setThursday(boolean t)

Enable Thursday weekday to execute event

Specified by:

setThursday in interface IX10Events

Parameters:

t - enable/disable Thursday

setFriday

public void setFriday(boolean f)

Enable Friday weekday to execute event

Specified by:

setFriday in interface IX10Events

Parameters:

f - enable/disable Friday

setSaturday

public void setSaturday(boolean s)

Enable Saturday weekday to execute event

Specified by:

setSaturday in interface IX10Events

Parameters:

s - enable/disable Saturday

getSunday

public boolean getSunday()

Get the Enable/disable value of the event for Sunday

Specified by:

getSunday in interface IX10Events

Returns:

true enable, false don't execute

getMonday

public boolean getMonday()

Get the Enable/disable value of the event for Monday

Specified by:

getMonday in interface IX10Events

Returns:

true enable, false don't execute

getTuesday

public boolean getTuesday()

Get the Enable/disable value of the event for Tuesday

Specified by:

getTuesday in interface IX10Events

Returns:

true enable, false don't execute

getWednesday

public boolean getWednesday()

Get the Enable/disable value of the event for Wednesday

Specified by:

getWednesday in interface IX10Events

Returns:

true enable, false don't execute

getThursday

public boolean getThursday()

Get the Enable/disable value of the event for Thursday

Specified by:

getThursday in interface IX10Events

Returns:

true enable, false don't execute

getFriday

public boolean getFriday()

Get the Enable/disable value of the event for Friday

Specified by:

getFriday in interface IX10Events

Returns:

true enable, false don't execute

getSaturday

public boolean getSaturday()

Get the Enable/disable value of the event for Saturday

Specified by:

getSaturday in interface IX10Events

Returns:

true enable, false don't execute

getModule

public IX10Module getModule()

The X10 Module associated with this event

Specified by:

getModule in interface IX10Events

Returns:

X10module interface for the event

getDescription

public java.lang.String getDescription()

Gets the description of the event

Specified by:

getDescription in interface IX10Events

Returns:

Defaults to NO DESCRIPTION

getAction

public java.lang.String getAction()

Get the action type for the event this is a string of on, off, dim, or brighten

Specified by:

getAction in interface IX10Events

Returns:

String of action to send to module.

getTime

public java.util.Calendar getTime()

The time of day to execute the event

Specified by:

getTime in interface IX10Events

Returns:

Gregorian Calendar of time to execute.