pt.lsts.imc

Class StateReport

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.StateReport

All Implemented Interfaces:

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

public class StateReport
extends IMCMessage

IMC Message State Report (514)
Concise representation of entire system 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
StateReport()
StateReport(IMCDefinition defs)
StateReport(IMCMessage msg)
StateReport(long stime, float latitude, float longitude, int altitude, int depth, int heading, short speed, byte fuel, byte exec_state, int plan_checksum)

Method Summary

Modifier and Type	Method and Description
static StateReport	clone(IMCMessage msg)
static StateReport	create(java.lang.Object... values)
int	getAltitude()
int	getDepth()
byte	getExecState()
byte	getFuel()
int	getHeading()
double	getLatitude()
double	getLongitude()
int	getPlanChecksum()
short	getSpeed()
long	getStime()
StateReport	setAltitude(int altitude)
StateReport	setDepth(int depth)
StateReport	setExecState(byte exec_state)
StateReport	setFuel(byte fuel)
StateReport	setHeading(int heading)
StateReport	setLatitude(double latitude)
StateReport	setLongitude(double longitude)
StateReport	setPlanChecksum(int plan_checksum)
StateReport	setSpeed(short speed)
StateReport	setStime(long stime)

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

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

StateReport

public StateReport()

StateReport

public StateReport(IMCMessage msg)

StateReport

public StateReport(IMCDefinition defs)

StateReport

public StateReport(long stime,
                   float latitude,
                   float longitude,
                   int altitude,
                   int depth,
                   int heading,
                   short speed,
                   byte fuel,
                   byte exec_state,
                   int plan_checksum)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getStime

public long getStime()

Returns:

Time Stamp (s) - uint32_t

setStime

public StateReport setStime(long stime)

Parameters:

stime - Time Stamp (s)

getLatitude

public double getLatitude()

Returns:

Latitude (°) - fp32_t

setLatitude

public StateReport setLatitude(double latitude)

Parameters:

latitude - Latitude (°)

getLongitude

public double getLongitude()

Returns:

Longitude (°) - fp32_t

setLongitude

public StateReport setLongitude(double longitude)

Parameters:

longitude - Longitude (°)

getAltitude

public int getAltitude()

Returns:

Altitude (dm) - uint16_t

setAltitude

public StateReport setAltitude(int altitude)

Parameters:

altitude - Altitude (dm)

getDepth

public int getDepth()

Returns:

Depth (dm) - uint16_t

setDepth

public StateReport setDepth(int depth)

Parameters:

depth - Depth (dm)

getHeading

public int getHeading()

Returns:

Heading - uint16_t

setHeading

public StateReport setHeading(int heading)

Parameters:

heading - Heading

getSpeed

public short getSpeed()

Returns:

Speed (cm/s) - int16_t

setSpeed

public StateReport setSpeed(short speed)

Parameters:

speed - Speed (cm/s)

getFuel

public byte getFuel()

Returns:

Fuel (%) - int8_t

setFuel

public StateReport setFuel(byte fuel)

Parameters:

fuel - Fuel (%)

getExecState

public byte getExecState()

Returns:

Execution State (%) - int8_t

setExecState

public StateReport setExecState(byte exec_state)

Parameters:

exec_state - Execution State (%)

getPlanChecksum

public int getPlanChecksum()

Returns:

Plan Checksum - uint16_t

setPlanChecksum

public StateReport setPlanChecksum(int plan_checksum)

Parameters:

plan_checksum - Plan Checksum