org.wcb.autohome.implementations
Class MacroEvent

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

All Implemented Interfaces:

IMacroEvent, java.io.Serializable, X10DeviceConstants

public class MacroEvent

extends java.lang.Object

implements IMacroEvent, java.io.Serializable, X10DeviceConstants

Filename: $Id: MacroEvent.java,v 1.5 2004/02/28 00:21:49 wbogaardt Exp $ Abstract: This is the events for an assigned macro $Log: MacroEvent.java,v $ Revision 1.5 2004/02/28 00:21:49 wbogaardt fixed formating to be compliant with sun coding convention Revision 1.4 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.3 2004/01/15 21:05:20 wbogaardt major revamp of Modules and interfaces changes overall structure of how information is stored Revision 1.2 2003/12/13 05:36:52 wbogaardt fixed javadoc comments.

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

MacroEvent()
Default constructor with a macro name of Macro1 and default X10 Module set to A1 and an ON_Action call

MacroEvent(IMacroEvent newO)
Clone constructor for the macro event using the passed in interface.

MacroEvent(java.lang.String n, IX10Module iMod, int act)
Macro events are events that take place when a stored macro is executed

Method Summary

int	getAction() Get the action type for the macro event these can be on or off actions.
java.lang.String	getMacroName() Gets the name of the macro
IX10Module	getX10Module() Gets the X10module object interface for this event.
void	print() Print routine for debugging purpose
void	setAction(int act) Sets the action when the event is told to execute
void	setMacroName(java.lang.String n) Sets the macro name
void	setX10Module(IX10Module iMod) Sets the x10 module identifier

Methods inherited from class java.lang.Object

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

Constructor Detail

MacroEvent

public MacroEvent(java.lang.String n,
                  IX10Module iMod,
                  int act)

Macro events are events that take place when a stored macro is executed

Parameters:

n - Event or macro name

iMod - X10 module that will execute the event

act - The event action that the X10 Mondule will execute ON_ACTION or OFF_ACTION

MacroEvent

public MacroEvent()

Default constructor with a macro name of Macro1 and default X10 Module set to A1 and an ON_Action call

MacroEvent

public MacroEvent(IMacroEvent newO)

Clone constructor for the macro event using the passed in interface.

Parameters:

newO - Interface to clone as an object

Method Detail

print

public void print()

Print routine for debugging purpose

setMacroName

public void setMacroName(java.lang.String n)

Sets the macro name

Specified by:

setMacroName in interface IMacroEvent

Parameters:

n - Name of the macro

setX10Module

public void setX10Module(IX10Module iMod)

Sets the x10 module identifier

Specified by:

setX10Module in interface IMacroEvent

Parameters:

iMod - X10Module object

setAction

public void setAction(int act)

Sets the action when the event is told to execute

Specified by:

setAction in interface IMacroEvent

Parameters:

act - ON_ACTION or OFF_ACTION events

getMacroName

public java.lang.String getMacroName()

Gets the name of the macro

Specified by:

getMacroName in interface IMacroEvent

Returns:

name of macro

getX10Module

public IX10Module getX10Module()

Gets the X10module object interface for this event.

Specified by:

getX10Module in interface IMacroEvent

Returns:

X10Module interface for event.

getAction

public int getAction()

Get the action type for the macro event these can be on or off actions.

Specified by:

getAction in interface IMacroEvent

Returns:

Int value of action constants ON_ACTION or OFF_ACTION