pt.lsts.imc

Class Launch

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.Maneuver

pt.lsts.imc.Launch

All Implemented Interfaces:

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

public class Launch
extends Maneuver

IMC Message Launch Maneuver (485)
A "Launch" is a maneuver specifying a movement of the vehicle to a
target waypoint after being launched from a ship or pier.
The waypoint is described by the WGS-84 waypoint coordinate and
target Z reference.
Mandatory parameters defined for a "Launch" are
timeout, speed and speed units.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Launch.SPEED_UNITS
static class	Launch.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
Launch()
Launch(IMCDefinition defs)
Launch(IMCMessage msg)
Launch(int timeout, double lat, double lon, float z, Launch.Z_UNITS z_units, float speed, Launch.SPEED_UNITS speed_units, java.lang.String custom)

Method Summary

Modifier and Type	Method and Description
static Launch	clone(IMCMessage msg)
static Launch	create(java.lang.Object... values)
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getCustom()
double	getLat()
double	getLon()
double	getSpeed()
Launch.SPEED_UNITS	getSpeedUnits()
java.lang.String	getSpeedUnitsStr()
short	getSpeedUnitsVal()
int	getTimeout()
double	getZ()
Launch.Z_UNITS	getZUnits()
java.lang.String	getZUnitsStr()
short	getZUnitsVal()
Launch	setCustom(java.util.LinkedHashMap<java.lang.String,?> custom)
Launch	setCustom(java.lang.String custom)
Launch	setLat(double lat)
Launch	setLon(double lon)
Launch	setSpeed(double speed)
Launch	setSpeedUnits(Launch.SPEED_UNITS speed_units)
Launch	setSpeedUnitsStr(java.lang.String speed_units)
Launch	setSpeedUnitsVal(short speed_units)
Launch	setTimeout(int timeout)
Launch	setZ(double z)
Launch	setZUnits(Launch.Z_UNITS z_units)
Launch	setZUnitsStr(java.lang.String z_units)
Launch	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

Launch

public Launch()

Launch

public Launch(IMCMessage msg)

Launch

public Launch(IMCDefinition defs)

Launch

public Launch(int timeout,
              double lat,
              double lon,
              float z,
              Launch.Z_UNITS z_units,
              float speed,
              Launch.SPEED_UNITS speed_units,
              java.lang.String custom)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getTimeout

public int getTimeout()

Returns:

Timeout (s) - uint16_t

setTimeout

public Launch setTimeout(int timeout)

Parameters:

timeout - Timeout (s)

getLat

public double getLat()

Returns:

Latitude WGS-84 (rad) - fp64_t

setLat

public Launch setLat(double lat)

Parameters:

lat - Latitude WGS-84 (rad)

getLon

public double getLon()

Returns:

Longitude WGS-84 (rad) - fp64_t

setLon

public Launch setLon(double lon)

Parameters:

lon - Longitude WGS-84 (rad)

getZ

public double getZ()

Returns:

Z Reference (m) - fp32_t

setZ

public Launch setZ(double z)

Parameters:

z - Z Reference (m)

getZUnits

public Launch.Z_UNITS getZUnits()

Returns:

Z Units (enumerated) - uint8_t

getZUnitsStr

public java.lang.String getZUnitsStr()

getZUnitsVal

public short getZUnitsVal()

setZUnits

public Launch setZUnits(Launch.Z_UNITS z_units)

Parameters:

z_units - Z Units (enumerated)

setZUnitsStr

public Launch setZUnitsStr(java.lang.String z_units)

Parameters:

z_units - Z Units (as a String)

setZUnitsVal

public Launch setZUnitsVal(short z_units)

Parameters:

z_units - Z Units (integer value)

getSpeed

public double getSpeed()

Returns:

Speed - fp32_t

setSpeed

public Launch setSpeed(double speed)

Parameters:

speed - Speed

getSpeedUnits

public Launch.SPEED_UNITS getSpeedUnits()

Returns:

Speed Units (enumerated) - uint8_t

getSpeedUnitsStr

public java.lang.String getSpeedUnitsStr()

getSpeedUnitsVal

public short getSpeedUnitsVal()

setSpeedUnits

public Launch setSpeedUnits(Launch.SPEED_UNITS speed_units)

Parameters:

speed_units - Speed Units (enumerated)

setSpeedUnitsStr

public Launch setSpeedUnitsStr(java.lang.String speed_units)

Parameters:

speed_units - Speed Units (as a String)

setSpeedUnitsVal

public Launch setSpeedUnitsVal(short speed_units)

Parameters:

speed_units - Speed Units (integer value)

getCustom

public java.util.LinkedHashMap<java.lang.String,java.lang.String> getCustom()

Returns:

Custom settings for maneuver (tuplelist) - plaintext

setCustom

public Launch setCustom(java.util.LinkedHashMap<java.lang.String,?> custom)

Parameters:

custom - Custom settings for maneuver (tuplelist)

setCustom

public Launch setCustom(java.lang.String custom)