pt.lsts.imc

Class EntityState

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.EntityState

All Implemented Interfaces:

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

public class EntityState
extends IMCMessage

IMC Message Entity State (1)
State reported by an entity in the vehicle. The source entity is
identified in the message header.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityState.STATE

Field Summary

Fields

Modifier and Type	Field and Description
static short	EFLA_HUMAN_INTERVENTION
static int	ID_STATIC

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
EntityState()
EntityState(EntityState.STATE state, short flags, java.lang.String description)
EntityState(IMCDefinition defs)
EntityState(IMCMessage msg)

Method Summary

Modifier and Type	Method and Description
static EntityState	clone(IMCMessage msg)
static EntityState	create(java.lang.Object... values)
java.lang.String	getDescription()
short	getFlags()
EntityState.STATE	getState()
java.lang.String	getStateStr()
short	getStateVal()
EntityState	setDescription(java.lang.String description)
EntityState	setFlags(short flags)
EntityState	setState(EntityState.STATE state)
EntityState	setStateStr(java.lang.String state)
EntityState	setStateVal(short state)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asJSON, asMap, asXml, asXmlStripped, cloneMessage, cloneMessage, compareTo, copyFrom, copyToClipoard, 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, makeImmutable, parseJson, parseXml, pasteFromClipoard, payloadMD5, serialize, serialize, serialize, serializePayload, setBitMask, setDst, setDstEnt, setHeader, setMessageInfo, setMessageList, setSrc, setSrcEnt, setTimestamp, setTimestampMillis, setType, setValue, setValues, toByteArray, toByteArray, toString, validate

Methods inherited from class java.lang.Object

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

Field Detail

EFLA_HUMAN_INTERVENTION

public static final short EFLA_HUMAN_INTERVENTION

See Also:

Constant Field Values

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

EntityState

public EntityState()

EntityState

public EntityState(IMCMessage msg)

EntityState

public EntityState(IMCDefinition defs)

EntityState

public EntityState(EntityState.STATE state,
                   short flags,
                   java.lang.String description)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getState

public EntityState.STATE getState()

Returns:

State (enumerated) - uint8_t

getStateStr

public java.lang.String getStateStr()

getStateVal

public short getStateVal()

setState

public EntityState setState(EntityState.STATE state)

Parameters:

state - State (enumerated)

setStateStr

public EntityState setStateStr(java.lang.String state)

Parameters:

state - State (as a String)

setStateVal

public EntityState setStateVal(short state)

Parameters:

state - State (integer value)

getFlags

public short getFlags()

Returns:

Flags (bitfield) - uint8_t

setFlags

public EntityState setFlags(short flags)

Parameters:

flags - Flags (bitfield)

getDescription

public java.lang.String getDescription()

Returns:

Complementary description - plaintext

setDescription

public EntityState setDescription(java.lang.String description)

Parameters:

description - Complementary description