pt.lsts.imc

Class ReportedState

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.ReportedState

All Implemented Interfaces:

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

public class ReportedState
extends IMCMessage

IMC Message Reported State (600)
A vehicle state that is reported to other consoles (including PDAConsole). Source can be acoustic tracker, SMS, Wi-Fi, etc...

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReportedState.S_TYPE

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
ReportedState()
ReportedState(double lat, double lon, double depth, double roll, double pitch, double yaw, double rcp_time, java.lang.String sid, ReportedState.S_TYPE s_type)
ReportedState(IMCDefinition defs)
ReportedState(IMCMessage msg)

Method Summary

Modifier and Type	Method and Description
static ReportedState	clone(IMCMessage msg)
static ReportedState	create(java.lang.Object... values)
double	getDepth()
double	getLat()
double	getLon()
double	getPitch()
double	getRcpTime()
double	getRoll()
java.lang.String	getSid()
ReportedState.S_TYPE	getSType() How the position was received/calculated
double	getYaw()
ReportedState	setDepth(double depth)
ReportedState	setLat(double lat)
ReportedState	setLon(double lon)
ReportedState	setPitch(double pitch)
ReportedState	setRcpTime(double rcp_time)
ReportedState	setRoll(double roll)
ReportedState	setSid(java.lang.String sid)
ReportedState	setSType(ReportedState.S_TYPE s_type)
ReportedState	setSType(short s_type)
ReportedState	setSType(java.lang.String s_type)
ReportedState	setYaw(double yaw)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asXml, cloneMessage, cloneMessage, compareTo, copyFrom, 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, getValues, hasFlag, hexdump, isNull, isPeriodic, main, makeImmutable, parseXml, payloadMD5, serialize, serialize, setBitMask, setDst, setDstEnt, setHeader, 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

ReportedState

public ReportedState()

ReportedState

public ReportedState(IMCMessage msg)

ReportedState

public ReportedState(IMCDefinition defs)

ReportedState

public ReportedState(double lat,
                     double lon,
                     double depth,
                     double roll,
                     double pitch,
                     double yaw,
                     double rcp_time,
                     java.lang.String sid,
                     ReportedState.S_TYPE s_type)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getLat

public double getLat()

Returns:

Latitude (rad) - fp64_t

getLon

public double getLon()

Returns:

Longitude (rad) - fp64_t

getDepth

public double getDepth()

Returns:

Depth (m) - fp64_t

getRoll

public double getRoll()

Returns:

Roll (rad) - fp64_t

getPitch

public double getPitch()

Returns:

Pitch (rad) - fp64_t

getYaw

public double getYaw()

Returns:

Yaw (rad) - fp64_t

getRcpTime

public double getRcpTime()

Returns:

Reception Time (s) - fp64_t

getSid

public java.lang.String getSid()

Returns:

System Identifier - plaintext

getSType

public ReportedState.S_TYPE getSType()

How the position was received/calculated

Returns:

Source Type (enumerated) - uint8_t

setLat

public ReportedState setLat(double lat)

Parameters:

lat - Latitude (rad)

setLon

public ReportedState setLon(double lon)

Parameters:

lon - Longitude (rad)

setDepth

public ReportedState setDepth(double depth)

Parameters:

depth - Depth (m)

setRoll

public ReportedState setRoll(double roll)

Parameters:

roll - Roll (rad)

setPitch

public ReportedState setPitch(double pitch)

Parameters:

pitch - Pitch (rad)

setYaw

public ReportedState setYaw(double yaw)

Parameters:

yaw - Yaw (rad)

setRcpTime

public ReportedState setRcpTime(double rcp_time)

Parameters:

rcp_time - Reception Time (s)

setSid

public ReportedState setSid(java.lang.String sid)

Parameters:

sid - System Identifier

setSType

public ReportedState setSType(ReportedState.S_TYPE s_type)

Parameters:

s_type - Source Type (enumerated)

setSType

public ReportedState setSType(java.lang.String s_type)

Parameters:

s_type - Source Type (as a String)

setSType

public ReportedState setSType(short s_type)

Parameters:

s_type - Source Type (integer value)