|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amx.duet.tools.util.EventPacker
The EventPacker
class was created to package up NetLinx event data into a single
Event
object. The class provides a list of methods that can be used to create
Event
objects for routines such as processing advanced events or listening to
loopback data coming from a derived NetLinxDevice
.
Constructor Summary | |
EventPacker()
|
Method Summary | |
static com.amx.duet.core.master.netlinx.Event |
packError(com.amx.duet.core.master.netlinx.DPS dps,
int error)
Create an ERROR Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packOff(com.amx.duet.core.master.netlinx.DPS dps,
int channelId)
Create an OFF Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packOffInputChannel(com.amx.duet.core.master.netlinx.DPS dps,
int channelId)
Create a RELEASE Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packOffline(com.amx.duet.core.master.netlinx.DPS dps)
Create an OFFLINE Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packOn(com.amx.duet.core.master.netlinx.DPS dps,
int channelId)
Create an ON Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packOnInputChannel(com.amx.duet.core.master.netlinx.DPS dps,
int channelId)
Create a PUSH Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packOnline(com.amx.duet.core.master.netlinx.DPS dps)
Create an ONLINE Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendCommand(com.amx.duet.core.master.netlinx.DPS dps,
byte[] str)
Create a SEND_COMMAND Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendCommand(com.amx.duet.core.master.netlinx.DPS dps,
char[] str)
Create a SEND_COMMAND Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendCommand(com.amx.duet.core.master.netlinx.DPS dps,
java.lang.String str)
Create a SEND_COMMAND Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendCommandWide(com.amx.duet.core.master.netlinx.DPS dps,
java.lang.String str)
Create a wide string SEND_COMMAND Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendCustom(com.amx.duet.core.master.netlinx.DPS dps,
int id,
int eventType,
int flag,
int value1,
int value2,
int value3,
byte[] eventData,
byte[] encode)
Create a CUSTOM Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendCustom(com.amx.duet.core.master.netlinx.DPS dps,
int id,
int eventType,
int flag,
int value1,
int value2,
int value3,
char[] eventData,
byte[] encode)
Create a CUSTOM Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendCustom(com.amx.duet.core.master.netlinx.DPS dps,
int id,
int eventType,
int flag,
int value1,
int value2,
int value3,
java.lang.String eventData,
byte[] encode)
Create a CUSTOM Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendCustomWide(com.amx.duet.core.master.netlinx.DPS dps,
int id,
int eventType,
int flag,
int value1,
int value2,
int value3,
java.lang.String eventData,
byte[] encode)
Create a wide string CUSTOM Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendLevel(com.amx.duet.core.master.netlinx.DPS dps,
int levelId,
float value)
Create a LEVEL Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendLevel(com.amx.duet.core.master.netlinx.DPS dps,
int levelId,
int value)
Create a LEVEL Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendLevel(com.amx.duet.core.master.netlinx.DPS dps,
int levelId,
com.amx.duet.core.master.netlinx.Level value)
Create a LEVEL Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendString(com.amx.duet.core.master.netlinx.DPS dps,
byte[] str)
Create a SEND_STRING Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendString(com.amx.duet.core.master.netlinx.DPS dps,
char[] str)
Create a SEND_STRING Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendString(com.amx.duet.core.master.netlinx.DPS dps,
java.lang.String str)
Create a SEND_STRING Event for the passed in DPS. |
static com.amx.duet.core.master.netlinx.Event |
packSendStringWide(com.amx.duet.core.master.netlinx.DPS dps,
java.lang.String str)
Create a wide string SEND_STRING Event for the passed in DPS. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public EventPacker()
Method Detail |
public static final com.amx.duet.core.master.netlinx.Event packError(com.amx.duet.core.master.netlinx.DPS dps, int error)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDeviceerror
- Error value to be reported
public static final com.amx.duet.core.master.netlinx.Event packOnline(com.amx.duet.core.master.netlinx.DPS dps)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevice
public static final com.amx.duet.core.master.netlinx.Event packOffline(com.amx.duet.core.master.netlinx.DPS dps)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevice
public static final com.amx.duet.core.master.netlinx.Event packOff(com.amx.duet.core.master.netlinx.DPS dps, int channelId)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicechannelId
- is the index of the channel (1 based)
public static final com.amx.duet.core.master.netlinx.Event packOffInputChannel(com.amx.duet.core.master.netlinx.DPS dps, int channelId)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicechannelId
- is the index of the channel (1 based)
public static final com.amx.duet.core.master.netlinx.Event packOn(com.amx.duet.core.master.netlinx.DPS dps, int channelId)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicechannelId
- is the index of the channel (1 based)
public static final com.amx.duet.core.master.netlinx.Event packOnInputChannel(com.amx.duet.core.master.netlinx.DPS dps, int channelId)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicechannelId
- is the index of the channel (1 based)
public static final com.amx.duet.core.master.netlinx.Event packSendCommand(com.amx.duet.core.master.netlinx.DPS dps, byte[] str)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicestr
- is a string containing the command data
public static final com.amx.duet.core.master.netlinx.Event packSendCommand(com.amx.duet.core.master.netlinx.DPS dps, char[] str)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicestr
- is a string containing the command data
public static final com.amx.duet.core.master.netlinx.Event packSendCommand(com.amx.duet.core.master.netlinx.DPS dps, java.lang.String str)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicestr
- is a string containing the command data
public static final com.amx.duet.core.master.netlinx.Event packSendCommandWide(com.amx.duet.core.master.netlinx.DPS dps, java.lang.String str)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicestr
- is a string containing the command data
public static final com.amx.duet.core.master.netlinx.Event packSendCustom(com.amx.duet.core.master.netlinx.DPS dps, int id, int eventType, int flag, int value1, int value2, int value3, byte[] eventData, byte[] encode)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDeviceid
- eventType
- flag
- value1
- value2
- value3
- eventData
- a string containing the custom event dataencode
-
public static final com.amx.duet.core.master.netlinx.Event packSendCustom(com.amx.duet.core.master.netlinx.DPS dps, int id, int eventType, int flag, int value1, int value2, int value3, char[] eventData, byte[] encode)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDeviceid
- eventType
- flag
- value1
- value2
- value3
- eventData
- a string containing the custom event dataencode
-
public static final com.amx.duet.core.master.netlinx.Event packSendCustom(com.amx.duet.core.master.netlinx.DPS dps, int id, int eventType, int flag, int value1, int value2, int value3, java.lang.String eventData, byte[] encode)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDeviceid
- eventType
- flag
- value1
- value2
- value3
- eventData
- a string containing the custom event dataencode
-
public static final com.amx.duet.core.master.netlinx.Event packSendCustomWide(com.amx.duet.core.master.netlinx.DPS dps, int id, int eventType, int flag, int value1, int value2, int value3, java.lang.String eventData, byte[] encode)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDeviceid
- eventType
- flag
- value1
- value2
- value3
- eventData
- a string containing the custom event dataencode
-
public static final com.amx.duet.core.master.netlinx.Event packSendLevel(com.amx.duet.core.master.netlinx.DPS dps, int levelId, com.amx.duet.core.master.netlinx.Level value)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicelevelId
- a one based integer representing the level to sendvalue
- a Level object containing the level value to send
public static final com.amx.duet.core.master.netlinx.Event packSendLevel(com.amx.duet.core.master.netlinx.DPS dps, int levelId, int value)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicelevelId
- a one based integer representing the level to sendvalue
- int level value to send
public static final com.amx.duet.core.master.netlinx.Event packSendLevel(com.amx.duet.core.master.netlinx.DPS dps, int levelId, float value)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicelevelId
- a one based integer representing the level to sendvalue
- int level value to send
public static final com.amx.duet.core.master.netlinx.Event packSendString(com.amx.duet.core.master.netlinx.DPS dps, byte[] str)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicestr
- is a string buffer containing the string data
public static final com.amx.duet.core.master.netlinx.Event packSendString(com.amx.duet.core.master.netlinx.DPS dps, char[] str)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicestr
- is a string buffer containing the string data
public static final com.amx.duet.core.master.netlinx.Event packSendString(com.amx.duet.core.master.netlinx.DPS dps, java.lang.String str)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicestr
- is a string buffer containing the string data
public static final com.amx.duet.core.master.netlinx.Event packSendStringWide(com.amx.duet.core.master.netlinx.DPS dps, java.lang.String str)
Event
for the passed in DPS.
dps
- a DPS object representing the D:P:S of an IcspNetLinxDevicestr
- is a string buffer containing the string data
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |