sophware.home.x10
Class X10Event

java.lang.Object
  extended by sophware.home.io.HomeEvent
      extended by sophware.home.x10.X10Event
All Implemented Interfaces:
java.io.Serializable

public class X10Event
extends HomeEvent
implements java.io.Serializable

The X10Event extends HomeEvent to represent an X10 event.

See Also:
Serialized Form

Field Summary
static short ALL_LIGHTS_OFF
           
static short ALL_LIGHTS_ON
           
static short ALL_UNITS_OFF
           
static short BRIGHT
           
static short DIM
           
static short EXTENDED_CODE
           
static short EXTENDED_DATA
           
static short HAIL_ACKNOWLEDGE
           
static short HAIL_REQUEST
           
static java.lang.String[] m_funcNames
           
static short OFF
           
static short ON
           
static short PRESET_DIM
           
static short PRESET_DIM2
           
static long serialVersionUID
           
static short STATUS_OFF
           
static short STATUS_ON
           
static short STATUS_REQUEST
           
 
Constructor Summary
X10Event(byte[] buf, int len)
          Creates and X10 event
X10Event(HomeCommand command)
          Creates and X10 event
 
Method Summary
 java.util.Enumeration<X10Address> getAddresses()
          Get all X10Addresss associated with this event.
 short getDimValue()
          Get dim value associated with this event
 byte[] getExtData(byte[] data)
          Get extended data associated with this event
 short getFunction()
          Get function associated with this event
 java.lang.String toString()
          String representation of this event.
 
Methods inherited from class sophware.home.io.HomeEvent
getDate, getEventHandler
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values

m_funcNames

public static final java.lang.String[] m_funcNames

ALL_UNITS_OFF

public static final short ALL_UNITS_OFF
See Also:
Constant Field Values

ALL_LIGHTS_ON

public static final short ALL_LIGHTS_ON
See Also:
Constant Field Values

ON

public static final short ON
See Also:
Constant Field Values

OFF

public static final short OFF
See Also:
Constant Field Values

DIM

public static final short DIM
See Also:
Constant Field Values

BRIGHT

public static final short BRIGHT
See Also:
Constant Field Values

ALL_LIGHTS_OFF

public static final short ALL_LIGHTS_OFF
See Also:
Constant Field Values

EXTENDED_CODE

public static final short EXTENDED_CODE
See Also:
Constant Field Values

HAIL_REQUEST

public static final short HAIL_REQUEST
See Also:
Constant Field Values

HAIL_ACKNOWLEDGE

public static final short HAIL_ACKNOWLEDGE
See Also:
Constant Field Values

PRESET_DIM

public static final short PRESET_DIM
See Also:
Constant Field Values

PRESET_DIM2

public static final short PRESET_DIM2
See Also:
Constant Field Values

EXTENDED_DATA

public static final short EXTENDED_DATA
See Also:
Constant Field Values

STATUS_ON

public static final short STATUS_ON
See Also:
Constant Field Values

STATUS_OFF

public static final short STATUS_OFF
See Also:
Constant Field Values

STATUS_REQUEST

public static final short STATUS_REQUEST
See Also:
Constant Field Values
Constructor Detail

X10Event

public X10Event(HomeCommand command)
         throws HomeException
Creates and X10 event

Parameters:
command - a X10Command
Throws:
HomeException

X10Event

public X10Event(byte[] buf,
                int len)
         throws HomeException
Creates and X10 event

Parameters:
buf - the transmission buffer
len - length of the transmission buffer
Throws:
HomeException
Method Detail

getAddresses

public java.util.Enumeration<X10Address> getAddresses()
Get all X10Addresss associated with this event.

Returns:
addresses associated with this event

getFunction

public short getFunction()
Get function associated with this event

Returns:
function associated with this event

getDimValue

public short getDimValue()
Get dim value associated with this event

Returns:
dim value associated with this event

getExtData

public byte[] getExtData(byte[] data)
Get extended data associated with this event

Returns:
2 byte extended data associated with this event

toString

public java.lang.String toString()
String representation of this event.

Overrides:
toString in class java.lang.Object
Returns:
string representing the event.