pt.lsts.imc

Class EntityList

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.EntityList

All Implemented Interfaces:

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

public class EntityList
extends IMCMessage

IMC Message Entity List (5)
This message describes the names and identification numbers of
all entities in the system.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityList.OP

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
EntityList()
EntityList(EntityList.OP op, java.lang.String list)
EntityList(IMCDefinition defs)
EntityList(IMCMessage msg)

Method Summary

Modifier and Type	Method and Description
static EntityList	clone(IMCMessage msg)
static EntityList	create(java.lang.Object... values)
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getList()
EntityList.OP	getOp()
java.lang.String	getOpStr()
short	getOpVal()
EntityList	setList(java.util.LinkedHashMap<java.lang.String,?> list)
EntityList	setList(java.lang.String list)
EntityList	setOp(EntityList.OP op)
EntityList	setOpStr(java.lang.String op)
EntityList	setOpVal(short op)

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

EntityList

public EntityList()

EntityList

public EntityList(IMCMessage msg)

EntityList

public EntityList(IMCDefinition defs)

EntityList

public EntityList(EntityList.OP op,
                  java.lang.String list)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getOp

public EntityList.OP getOp()

Returns:

operation (enumerated) - uint8_t

getOpStr

public java.lang.String getOpStr()

getOpVal

public short getOpVal()

setOp

public EntityList setOp(EntityList.OP op)

Parameters:

op - operation (enumerated)

setOpStr

public EntityList setOpStr(java.lang.String op)

Parameters:

op - operation (as a String)

setOpVal

public EntityList setOpVal(short op)

Parameters:

op - operation (integer value)

getList

public java.util.LinkedHashMap<java.lang.String,java.lang.String> getList()

Returns:

list (tuplelist) - plaintext

setList

public EntityList setList(java.util.LinkedHashMap<java.lang.String,?> list)

Parameters:

list - list (tuplelist)

setList

public EntityList setList(java.lang.String list)