pt.lsts.imc

Class UsblFix

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.UsblFix

All Implemented Interfaces:

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

public class UsblFix
extends IMCMessage

IMC Message USBL Fix (892)
This message contains the WGS-84 position of a target computed using
USBL.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UsblFix.Z_UNITS

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
UsblFix()
UsblFix(IMCDefinition defs)
UsblFix(IMCMessage msg)
UsblFix(int target, double lat, double lon, UsblFix.Z_UNITS z_units, float z)

Method Summary

Modifier and Type	Method and Description
static UsblFix	clone(IMCMessage msg)
static UsblFix	create(java.lang.Object... values)
double	getLat()
double	getLon()
int	getTarget()
double	getZ()
UsblFix.Z_UNITS	getZUnits()
java.lang.String	getZUnitsStr()
short	getZUnitsVal()
UsblFix	setLat(double lat)
UsblFix	setLon(double lon)
UsblFix	setTarget(int target)
UsblFix	setZ(double z)
UsblFix	setZUnits(UsblFix.Z_UNITS z_units)
UsblFix	setZUnitsStr(java.lang.String z_units)
UsblFix	setZUnitsVal(short z_units)

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

UsblFix

public UsblFix()

UsblFix

public UsblFix(IMCMessage msg)

UsblFix

public UsblFix(IMCDefinition defs)

UsblFix

public UsblFix(int target,
               double lat,
               double lon,
               UsblFix.Z_UNITS z_units,
               float z)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getTarget

public int getTarget()

Returns:

Target - uint16_t

setTarget

public UsblFix setTarget(int target)

Parameters:

target - Target

getLat

public double getLat()

Returns:

Latitude (WGS-84) (rad) - fp64_t

setLat

public UsblFix setLat(double lat)

Parameters:

lat - Latitude (WGS-84) (rad)

getLon

public double getLon()

Returns:

Longitude (WGS-84) (rad) - fp64_t

setLon

public UsblFix setLon(double lon)

Parameters:

lon - Longitude (WGS-84) (rad)

getZUnits

public UsblFix.Z_UNITS getZUnits()

Returns:

Z Units (enumerated) - uint8_t

getZUnitsStr

public java.lang.String getZUnitsStr()

getZUnitsVal

public short getZUnitsVal()

setZUnits

public UsblFix setZUnits(UsblFix.Z_UNITS z_units)

Parameters:

z_units - Z Units (enumerated)

setZUnitsStr

public UsblFix setZUnitsStr(java.lang.String z_units)

Parameters:

z_units - Z Units (as a String)

setZUnitsVal

public UsblFix setZUnitsVal(short z_units)

Parameters:

z_units - Z Units (integer value)

getZ

public double getZ()

Returns:

Z Reference (m) - fp32_t

setZ

public UsblFix setZ(double z)

Parameters:

z - Z Reference (m)