pt.up.fe.dceg.neptus.imc

Class EntityState

java.lang.Object

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

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

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static EntityState	clone(IMCMessage msg)
static EntityState	create(java.lang.Object... values)
java.lang.String	getDescription()
short	getFlags() Complementary entity state flags.
EntityState.STATE	getState() State of entity.
void	setDescription(java.lang.String description)
void	setFlags(short flags)
void	setState(EntityState.STATE state)
void	setState(short state)
void	setState(java.lang.String state)

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

EFLA_HUMAN_INTERVENTION

public static final short EFLA_HUMAN_INTERVENTION

See Also:

Constant Field Values

Constructor Detail

EntityState

public EntityState()

EntityState

public EntityState(IMCDefinition defs)

EntityState

public EntityState(short 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()

State of entity.

Returns:

State (enumerated) - uint8_t

getFlags

public short getFlags()

Complementary entity state flags.

Returns:

Flags (bitfield) - uint8_t

getDescription

public java.lang.String getDescription()

Returns:

Complementary description - plaintext

setState

public void setState(EntityState.STATE state)

Parameters:

state - State (enumerated)

setState

public void setState(java.lang.String state)

Parameters:

state - State (as a String)

setState

public void setState(short state)

Parameters:

state - State (integer value)

setFlags

public void setFlags(short flags)

Parameters:

flags - Flags (bitfield)

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - Complementary description