pt.lsts.imc

Class EntityInfo

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.EntityInfo

All Implemented Interfaces:

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

public class EntityInfo
extends IMCMessage

IMC Message Entity Information (3)
This message describes an entity.

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
EntityInfo()
EntityInfo(IMCDefinition defs)
EntityInfo(IMCMessage msg)
EntityInfo(short id, java.lang.String label, java.lang.String component, int act_time, int deact_time)

Method Summary

Modifier and Type	Method and Description
static EntityInfo	clone(IMCMessage msg)
static EntityInfo	create(java.lang.Object... values)
int	getActTime()
java.lang.String	getComponent()
int	getDeactTime()
short	getId()
java.lang.String	getLabel()
EntityInfo	setActTime(int act_time)
EntityInfo	setComponent(java.lang.String component)
EntityInfo	setDeactTime(int deact_time)
EntityInfo	setId(short id)
EntityInfo	setLabel(java.lang.String label)

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

EntityInfo

public EntityInfo()

EntityInfo

public EntityInfo(IMCMessage msg)

EntityInfo

public EntityInfo(IMCDefinition defs)

EntityInfo

public EntityInfo(short id,
                  java.lang.String label,
                  java.lang.String component,
                  int act_time,
                  int deact_time)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getId

public short getId()

Returns:

Entity Identifier - uint8_t

setId

public EntityInfo setId(short id)

Parameters:

id - Entity Identifier

getLabel

public java.lang.String getLabel()

Returns:

Label - plaintext

setLabel

public EntityInfo setLabel(java.lang.String label)

Parameters:

label - Label

getComponent

public java.lang.String getComponent()

Returns:

Component name - plaintext

setComponent

public EntityInfo setComponent(java.lang.String component)

Parameters:

component - Component name

getActTime

public int getActTime()

Returns:

Activation Time (s) - uint16_t

setActTime

public EntityInfo setActTime(int act_time)

Parameters:

act_time - Activation Time (s)

getDeactTime

public int getDeactTime()

Returns:

Deactivation Time (s) - uint16_t

setDeactTime

public EntityInfo setDeactTime(int deact_time)

Parameters:

deact_time - Deactivation Time (s)