pt.lsts.imc

Class PlanControlState

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.PlanControlState

All Implemented Interfaces:

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

public class PlanControlState
extends IMCMessage

IMC Message Plan Control State (560)
State of plan control.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlanControlState.LAST_OUTCOME
static class	PlanControlState.STATE

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
PlanControlState()
PlanControlState(IMCDefinition defs)
PlanControlState(IMCMessage msg)
PlanControlState(PlanControlState.STATE state, java.lang.String plan_id, int plan_eta, float plan_progress, java.lang.String man_id, int man_type, int man_eta, PlanControlState.LAST_OUTCOME last_outcome)

Method Summary

Modifier and Type	Method and Description
static PlanControlState	clone(IMCMessage msg)
static PlanControlState	create(java.lang.Object... values)
PlanControlState.LAST_OUTCOME	getLastOutcome()
java.lang.String	getLastOutcomeStr()
short	getLastOutcomeVal()
int	getManEta()
java.lang.String	getManId()
int	getManType()
int	getPlanEta()
java.lang.String	getPlanId()
double	getPlanProgress()
PlanControlState.STATE	getState()
java.lang.String	getStateStr()
short	getStateVal()
PlanControlState	setLastOutcome(PlanControlState.LAST_OUTCOME last_outcome)
PlanControlState	setLastOutcomeStr(java.lang.String last_outcome)
PlanControlState	setLastOutcomeVal(short last_outcome)
PlanControlState	setManEta(int man_eta)
PlanControlState	setManId(java.lang.String man_id)
PlanControlState	setManType(int man_type)
PlanControlState	setPlanEta(int plan_eta)
PlanControlState	setPlanId(java.lang.String plan_id)
PlanControlState	setPlanProgress(double plan_progress)
PlanControlState	setState(PlanControlState.STATE state)
PlanControlState	setStateStr(java.lang.String state)
PlanControlState	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

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

PlanControlState

public PlanControlState()

PlanControlState

public PlanControlState(IMCMessage msg)

PlanControlState

public PlanControlState(IMCDefinition defs)

PlanControlState

public PlanControlState(PlanControlState.STATE state,
                        java.lang.String plan_id,
                        int plan_eta,
                        float plan_progress,
                        java.lang.String man_id,
                        int man_type,
                        int man_eta,
                        PlanControlState.LAST_OUTCOME last_outcome)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getState

public PlanControlState.STATE getState()

Returns:

State (enumerated) - uint8_t

getStateStr

public java.lang.String getStateStr()

getStateVal

public short getStateVal()

setState

public PlanControlState setState(PlanControlState.STATE state)

Parameters:

state - State (enumerated)

setStateStr

public PlanControlState setStateStr(java.lang.String state)

Parameters:

state - State (as a String)

setStateVal

public PlanControlState setStateVal(short state)

Parameters:

state - State (integer value)

getPlanId

public java.lang.String getPlanId()

Returns:

Plan -- ID - plaintext

setPlanId

public PlanControlState setPlanId(java.lang.String plan_id)

Parameters:

plan_id - Plan -- ID

getPlanEta

public int getPlanEta()

Returns:

Plan -- ETA (s) - int32_t

setPlanEta

public PlanControlState setPlanEta(int plan_eta)

Parameters:

plan_eta - Plan -- ETA (s)

getPlanProgress

public double getPlanProgress()

Returns:

Plan -- Progress (%) - fp32_t

setPlanProgress

public PlanControlState setPlanProgress(double plan_progress)

Parameters:

plan_progress - Plan -- Progress (%)

getManId

public java.lang.String getManId()

Returns:

Maneuver -- ID - plaintext

setManId

public PlanControlState setManId(java.lang.String man_id)

Parameters:

man_id - Maneuver -- ID

getManType

public int getManType()

Returns:

Maneuver -- Type - uint16_t

setManType

public PlanControlState setManType(int man_type)

Parameters:

man_type - Maneuver -- Type

getManEta

public int getManEta()

Returns:

Maneuver -- ETA (s) - int32_t

setManEta

public PlanControlState setManEta(int man_eta)

Parameters:

man_eta - Maneuver -- ETA (s)

getLastOutcome

public PlanControlState.LAST_OUTCOME getLastOutcome()

Returns:

Last Plan Outcome (enumerated) - uint8_t

getLastOutcomeStr

public java.lang.String getLastOutcomeStr()

getLastOutcomeVal

public short getLastOutcomeVal()

setLastOutcome

public PlanControlState setLastOutcome(PlanControlState.LAST_OUTCOME last_outcome)

Parameters:

last_outcome - Last Plan Outcome (enumerated)

setLastOutcomeStr

public PlanControlState setLastOutcomeStr(java.lang.String last_outcome)

Parameters:

last_outcome - Last Plan Outcome (as a String)

setLastOutcomeVal

public PlanControlState setLastOutcomeVal(short last_outcome)

Parameters:

last_outcome - Last Plan Outcome (integer value)