pt.up.fe.dceg.neptus.imc

Class CcuEvent

java.lang.Object

pt.up.fe.dceg.neptus.imc.IMCMessage

pt.up.fe.dceg.neptus.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.up.fe.dceg.neptus.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

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

Method Summary

Methods

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()
void	setArg(IMCMessage arg)
void	setId(java.lang.String id)
void	setType(CcuEvent.TYPE type)
void	setType(short type)
void	setType(java.lang.String type)

Methods inherited from class pt.up.fe.dceg.neptus.imc.IMCMessage

asJSON, asXml, cloneMessage, cloneMessage, compareTo, decodeTupleList, dump, encodeTupleList, get, getAbbrev, getAsNumber, getAsString, getBitmask, getDate, getDouble, getDst, getDstEnt, getFieldNames, getFloat, getHeader, getHeaderValue, getInteger, getLong, getLongFieldName, getLongName, getMessage, getMessage, getMessageList, getMessageList, getMessageType, getMgid, getPayloadSize, getProtocolFactory, getRawData, getSize, getSourceName, getSrc, getSrcEnt, getString, getString, getTimestamp, getTimestampMillis, getTupleList, getTypeOf, getUnitsOf, getValue, hasFlag, hexdump, isNull, isPeriodic, main, parseXml, payloadMD5, serialize, serialize, setBitMask, setDst, setDstEnt, setHeader, setMessage, 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(IMCDefinition defs)

CcuEvent

public CcuEvent(short 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

getId

public java.lang.String getId()

Returns:

Identifier - plaintext

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

setType

public void setType(CcuEvent.TYPE type)

Parameters:

type - Event Type (enumerated)

setType

public void setType(java.lang.String type)

Parameters:

type - Event Type (as a String)

setType

public void setType(short type)

Parameters:

type - Event Type (integer value)

setId

public void setId(java.lang.String id)

Parameters:

id - Identifier

setArg

public void setArg(IMCMessage arg)

Parameters:

arg - Additional Data