pt.lsts.imc

Class CcuEvent

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.CcuEvent

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<IMCMessage>, IMessage

public class CcuEvent
extends IMCMessage

IMC Message CCU Event (606)
This message is used to signal events among running CCUs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CcuEvent.TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_STATIC

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
CcuEvent()
CcuEvent(CcuEvent.TYPE type, java.lang.String id, IMCMessage arg)
CcuEvent(IMCDefinition defs)
CcuEvent(IMCMessage msg)

Method Summary

Modifier and Type	Method and Description
static CcuEvent	clone(IMCMessage msg)
static CcuEvent	create(java.lang.Object... values)
IMCMessage	getArg()
<T extends IMCMessage> T	getArg(java.lang.Class<T> clazz)
java.lang.String	getId()
CcuEvent.TYPE	getType()
java.lang.String	getTypeStr()
short	getTypeVal()
CcuEvent	setArg(IMCMessage arg)
CcuEvent	setId(java.lang.String id)
CcuEvent	setType(CcuEvent.TYPE type)
CcuEvent	setTypeStr(java.lang.String type)
CcuEvent	setTypeVal(short type)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asJSON, asMap, asXml, asXmlStripped, cloneMessage, cloneMessage, compareTo, copyFrom, decodeTupleList, dump, encodeTupleList, get, getAbbrev, getAgeInSeconds, getAsNumber, getAsString, getBitmask, getDate, getDouble, getDst, getDstEnt, getEntityName, getFieldNames, getFloat, getHeader, getHeaderValue, getInteger, getLong, getLongFieldName, getLongName, getMessage, getMessage, getMessageInfo, getMessageList, getMessageList, getMessageType, getMgid, getPayloadSize, getProtocolFactory, getRawData, getSize, getSourceName, getSrc, getSrcEnt, getString, getString, getTimestamp, getTimestampMillis, getTupleList, getTypeOf, getUnitsOf, getValue, getValues, hasFlag, hexdump, isNull, isPeriodic, main, makeImmutable, parseJson, parseXml, payloadMD5, serialize, serialize, serialize, serializePayload, setBitMask, setDst, setDstEnt, setHeader, setMessageInfo, setMessageList, setSrc, setSrcEnt, setTimestamp, setTimestampMillis, setType, setValue, setValues, toString, validate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

CcuEvent

public CcuEvent()

CcuEvent

public CcuEvent(IMCMessage msg)

CcuEvent

public CcuEvent(IMCDefinition defs)

CcuEvent

public CcuEvent(CcuEvent.TYPE type,
                java.lang.String id,
                IMCMessage arg)

Method Detail

create

public static CcuEvent create(java.lang.Object... values)

clone

public static CcuEvent clone(IMCMessage msg)
                      throws java.lang.Exception

Throws:

java.lang.Exception

getType

public CcuEvent.TYPE getType()

Returns:

Event Type (enumerated) - uint8_t

getTypeStr

public java.lang.String getTypeStr()

getTypeVal

public short getTypeVal()

setType

public CcuEvent setType(CcuEvent.TYPE type)

Parameters:

type - Event Type (enumerated)

setTypeStr

public CcuEvent setTypeStr(java.lang.String type)

Parameters:

type - Event Type (as a String)

setTypeVal

public CcuEvent setTypeVal(short type)

Parameters:

type - Event Type (integer value)

getId

public java.lang.String getId()

Returns:

Identifier - plaintext

setId

public CcuEvent setId(java.lang.String id)

Parameters:

id - Identifier

getArg

public IMCMessage getArg()

Returns:

Additional Data - message

getArg

public <T extends IMCMessage> T getArg(java.lang.Class<T> clazz)
                                throws java.lang.Exception

Throws:

java.lang.Exception

setArg

public CcuEvent setArg(IMCMessage arg)

Parameters:

arg - Additional Data