|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.util.EventObject | +--com.jpeterson.x10.event.X10Event
An X10 event represents an X10 transmission packet. This is the base class for subclasses that implement the different X10 messages.
Fields inherited from class java.util.EventObject |
source |
Constructor Summary | |
X10Event(java.lang.Object source,
boolean function,
byte hiNibble,
byte loNibble)
Create an X10 event. |
|
X10Event(java.lang.Object source,
int dims,
boolean function,
boolean extended,
byte hiNibble,
byte loNibble,
int dimMax)
Create an X10 event, specifying all parameters. |
Method Summary | |
boolean |
equals(java.lang.Object object)
Determines if two objects are equals. |
byte |
getChecksum()
Retrieve the checksum of the bytes in the message or the X10 transmission. |
int |
getDimMax()
Retrieve the maximum number of dims in the event. |
int |
getDims()
Retrieve the number of dims in the event. |
byte |
getHiNibble()
Retrieve the high nibble of the 'code' portion of the packet. |
byte |
getLoNibble()
Retrieve the low nibble of the 'code' portion of the packet. |
byte[] |
getPacket()
Retrieve the bytes that compose the X10 event. |
int |
hashCode()
Calculate a hash code for the event. |
boolean |
isExtended()
Determine if the event is an extended event. |
boolean |
isFunction()
Determine if the event is a function or address event. |
java.lang.String |
toString()
Create a string that represents the X10 event. |
Methods inherited from class java.util.EventObject |
getSource |
Methods inherited from class java.lang.Object |
clone,
finalize,
getClass,
notify,
notifyAll,
wait,
wait,
wait |
Constructor Detail |
public X10Event(java.lang.Object source, int dims, boolean function, boolean extended, byte hiNibble, byte loNibble, int dimMax)
source
- The event source.dims
- The number of dims.funtion
- True if the event is a function event, false
if the event is an address event.extended
- True if the event is an extended event, false
otherwisehiNibble
- The upper four bits of the 'Code' portion of the
X10 event. This is usually the housecodeloNibble
- The lower four bits of the 'Code' portion of the
X10 event. This is typically the device code in an address
event or the function code in a function event.dimMax
- The maximum number of dims for the event.public X10Event(java.lang.Object source, boolean function, byte hiNibble, byte loNibble)
source
- The event source.funtion
- True if the event is a function event, false
if the event is an address event.hiNibble
- The upper four bits of the 'Code' portion of the
X10 event. This is usually the housecodeloNibble
- The lower four bits of the 'Code' portion of the
X10 event. This is typically the device code in an address
event or the function code in a function event.Method Detail |
public byte[] getPacket()
public byte getChecksum()
public boolean isFunction()
public boolean isExtended()
public int getDims()
public int getDimMax()
public byte getHiNibble()
public byte getLoNibble()
public int hashCode()
public boolean equals(java.lang.Object object)
public java.lang.String toString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |