pt.lsts.imc

Class FollowRefState

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.FollowRefState

All Implemented Interfaces:

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

public class FollowRefState
extends IMCMessage

IMC Message Follow Reference State (480)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FollowRefState.STATE

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_STATIC
static short	PROX_FAR
static short	PROX_XY_NEAR
static short	PROX_Z_NEAR

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
FollowRefState()
FollowRefState(IMCDefinition defs)
FollowRefState(IMCMessage msg)
FollowRefState(int control_src, short control_ent, Reference reference, FollowRefState.STATE state, short proximity)

Method Summary

Modifier and Type	Method and Description
static FollowRefState	clone(IMCMessage msg)
static FollowRefState	create(java.lang.Object... values)
short	getControlEnt()
int	getControlSrc()
short	getProximity()
Reference	getReference()
FollowRefState.STATE	getState()
java.lang.String	getStateStr()
short	getStateVal()
FollowRefState	setControlEnt(short control_ent)
FollowRefState	setControlSrc(int control_src)
FollowRefState	setProximity(short proximity)
FollowRefState	setReference(Reference reference)
FollowRefState	setState(FollowRefState.STATE state)
FollowRefState	setStateStr(java.lang.String state)
FollowRefState	setStateVal(short state)

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

PROX_FAR

public static final short PROX_FAR

See Also:

Constant Field Values

PROX_XY_NEAR

public static final short PROX_XY_NEAR

See Also:

Constant Field Values

PROX_Z_NEAR

public static final short PROX_Z_NEAR

See Also:

Constant Field Values

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

FollowRefState

public FollowRefState()

FollowRefState

public FollowRefState(IMCMessage msg)

FollowRefState

public FollowRefState(IMCDefinition defs)

FollowRefState

public FollowRefState(int control_src,
                      short control_ent,
                      Reference reference,
                      FollowRefState.STATE state,
                      short proximity)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getControlSrc

public int getControlSrc()

Returns:

Controlling Source - uint16_t

setControlSrc

public FollowRefState setControlSrc(int control_src)

Parameters:

control_src - Controlling Source

getControlEnt

public short getControlEnt()

Returns:

Controlling Entity - uint8_t

setControlEnt

public FollowRefState setControlEnt(short control_ent)

Parameters:

control_ent - Controlling Entity

getReference

public Reference getReference()

Returns:

Reference - message

setReference

public FollowRefState setReference(Reference reference)

Parameters:

reference - Reference

getState

public FollowRefState.STATE getState()

Returns:

State (enumerated) - uint8_t

getStateStr

public java.lang.String getStateStr()

getStateVal

public short getStateVal()

setState

public FollowRefState setState(FollowRefState.STATE state)

Parameters:

state - State (enumerated)

setStateStr

public FollowRefState setStateStr(java.lang.String state)

Parameters:

state - State (as a String)

setStateVal

public FollowRefState setStateVal(short state)

Parameters:

state - State (integer value)

getProximity

public short getProximity()

Returns:

Proximity (bitfield) - uint8_t

setProximity

public FollowRefState setProximity(short proximity)

Parameters:

proximity - Proximity (bitfield)