pt.lsts.imc

Class PopUp

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.Maneuver

pt.lsts.imc.PopUp

All Implemented Interfaces:

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

public class PopUp
extends Maneuver

IMC Message PopUp Maneuver (451)
The Pop Up maneuver makes the vehicle come to the surface at a
specific waypoint. This maneuver is restricted to underwater vehicles.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PopUp.SPEED_UNITS
static class	PopUp.Z_UNITS

Field Summary

Fields

Modifier and Type	Field and Description
static short	FLG_CURR_POS
static short	FLG_STATION_KEEP
static short	FLG_WAIT_AT_SURFACE
static int	ID_STATIC

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
PopUp()
PopUp(IMCDefinition defs)
PopUp(IMCMessage msg)
PopUp(int timeout, double lat, double lon, float z, PopUp.Z_UNITS z_units, float speed, PopUp.SPEED_UNITS speed_units, int duration, float radius, short flags, java.lang.String custom)

Method Summary

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

FLG_CURR_POS

public static final short FLG_CURR_POS

See Also:

Constant Field Values

FLG_WAIT_AT_SURFACE

public static final short FLG_WAIT_AT_SURFACE

See Also:

Constant Field Values

FLG_STATION_KEEP

public static final short FLG_STATION_KEEP

See Also:

Constant Field Values

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

PopUp

public PopUp()

PopUp

public PopUp(IMCMessage msg)

PopUp

public PopUp(IMCDefinition defs)

PopUp

public PopUp(int timeout,
             double lat,
             double lon,
             float z,
             PopUp.Z_UNITS z_units,
             float speed,
             PopUp.SPEED_UNITS speed_units,
             int duration,
             float radius,
             short flags,
             java.lang.String custom)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getTimeout

public int getTimeout()

Returns:

Timeout (s) - uint16_t

setTimeout

public PopUp setTimeout(int timeout)

Parameters:

timeout - Timeout (s)

getLat

public double getLat()

Returns:

Latitude WGS-84 (rad) - fp64_t

setLat

public PopUp setLat(double lat)

Parameters:

lat - Latitude WGS-84 (rad)

getLon

public double getLon()

Returns:

Longitude WGS-84 (rad) - fp64_t

setLon

public PopUp setLon(double lon)

Parameters:

lon - Longitude WGS-84 (rad)

getZ

public double getZ()

Returns:

Z Reference (m) - fp32_t

setZ

public PopUp setZ(double z)

Parameters:

z - Z Reference (m)

getZUnits

public PopUp.Z_UNITS getZUnits()

Returns:

Z Units (enumerated) - uint8_t

getZUnitsStr

public java.lang.String getZUnitsStr()

getZUnitsVal

public short getZUnitsVal()

setZUnits

public PopUp setZUnits(PopUp.Z_UNITS z_units)

Parameters:

z_units - Z Units (enumerated)

setZUnitsStr

public PopUp setZUnitsStr(java.lang.String z_units)

Parameters:

z_units - Z Units (as a String)

setZUnitsVal

public PopUp setZUnitsVal(short z_units)

Parameters:

z_units - Z Units (integer value)

getSpeed

public double getSpeed()

Returns:

Speed - fp32_t

setSpeed

public PopUp setSpeed(double speed)

Parameters:

speed - Speed

getSpeedUnits

public PopUp.SPEED_UNITS getSpeedUnits()

Returns:

Speed Units (enumerated) - uint8_t

getSpeedUnitsStr

public java.lang.String getSpeedUnitsStr()

getSpeedUnitsVal

public short getSpeedUnitsVal()

setSpeedUnits

public PopUp setSpeedUnits(PopUp.SPEED_UNITS speed_units)

Parameters:

speed_units - Speed Units (enumerated)

setSpeedUnitsStr

public PopUp setSpeedUnitsStr(java.lang.String speed_units)

Parameters:

speed_units - Speed Units (as a String)

setSpeedUnitsVal

public PopUp setSpeedUnitsVal(short speed_units)

Parameters:

speed_units - Speed Units (integer value)

getDuration

public int getDuration()

Returns:

Duration (s) - uint16_t

setDuration

public PopUp setDuration(int duration)

Parameters:

duration - Duration (s)

getRadius

public double getRadius()

Returns:

Radius (m) - fp32_t

setRadius

public PopUp setRadius(double radius)

Parameters:

radius - Radius (m)

getFlags

public short getFlags()

Returns:

Flags (bitfield) - uint8_t

setFlags

public PopUp setFlags(short flags)

Parameters:

flags - Flags (bitfield)

getCustom

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

Returns:

Custom settings for maneuver (tuplelist) - plaintext

setCustom

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

Parameters:

custom - Custom settings for maneuver (tuplelist)

setCustom

public PopUp setCustom(java.lang.String custom)