pt.lsts.imc

Class UsblModem

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.UsblModem

All Implemented Interfaces:

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

public class UsblModem
extends IMCMessage

IMC Message USBL Modem Configuration (901)
Position and configuration of an Ultra-Short Base Line modem.

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
UsblModem()
UsblModem(IMCDefinition defs)
UsblModem(IMCMessage msg)
UsblModem(java.lang.String name, double lat, double lon, float z, pt.lsts.imc.def.ZUnits z_units)

Method Summary

Modifier and Type	Method and Description
static UsblModem	clone(IMCMessage msg)
static UsblModem	create(java.lang.Object... values)
double	getLat()
double	getLon()
java.lang.String	getName()
double	getZ()
pt.lsts.imc.def.ZUnits	getZUnits()
java.lang.String	getZUnitsStr()
short	getZUnitsVal()
UsblModem	setLat(double lat)
UsblModem	setLon(double lon)
UsblModem	setName(java.lang.String name)
UsblModem	setZ(double z)
UsblModem	setZUnits(pt.lsts.imc.def.ZUnits z_units)
UsblModem	setZUnitsStr(java.lang.String z_units)
UsblModem	setZUnitsVal(short z_units)

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

UsblModem

public UsblModem()

UsblModem

public UsblModem(IMCMessage msg)

UsblModem

public UsblModem(IMCDefinition defs)

UsblModem

public UsblModem(java.lang.String name,
                 double lat,
                 double lon,
                 float z,
                 pt.lsts.imc.def.ZUnits z_units)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getName

public java.lang.String getName()

Returns:

Modem Name - plaintext

setName

public UsblModem setName(java.lang.String name)

Parameters:

name - Modem Name

getLat

public double getLat()

Returns:

Latitude WGS-84 (rad) - fp64_t

setLat

public UsblModem setLat(double lat)

Parameters:

lat - Latitude WGS-84 (rad)

getLon

public double getLon()

Returns:

Longitude WGS-84 (rad) - fp64_t

setLon

public UsblModem setLon(double lon)

Parameters:

lon - Longitude WGS-84 (rad)

getZ

public double getZ()

Returns:

Z Reference (m) - fp32_t

setZ

public UsblModem setZ(double z)

Parameters:

z - Z Reference (m)

getZUnits

public pt.lsts.imc.def.ZUnits getZUnits()

Returns:

Z Units (enumerated) - uint8_t

getZUnitsStr

public java.lang.String getZUnitsStr()

getZUnitsVal

public short getZUnitsVal()

setZUnits

public UsblModem setZUnits(pt.lsts.imc.def.ZUnits z_units)

Parameters:

z_units - Z Units (enumerated)

setZUnitsStr

public UsblModem setZUnitsStr(java.lang.String z_units)

Parameters:

z_units - Z Units (as a String)

setZUnitsVal

public UsblModem setZUnitsVal(short z_units)

Parameters:

z_units - Z Units (integer value)