pt.lsts.imc

Class Elevator

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.Maneuver

pt.lsts.imc.Elevator

All Implemented Interfaces:

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

public class Elevator
extends Maneuver

IMC Message Elevator Maneuver (462)
The Elevator maneuver specifies a vehicle to reach a target
waypoint using a cruise altitude/depth and then ascend or
descend to another target altitude/depth. The ascent/descent
slope and radius can also be optionally specified.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Elevator.END_Z_UNITS
static class	Elevator.SPEED_UNITS
static class	Elevator.START_Z_UNITS

Field Summary

Fields

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

Fields inherited from class pt.lsts.imc.IMCMessage

DEFAULT_ENTITY_ID, DEFAULT_SYSTEM_ID

Constructor Summary

Constructors

Constructor and Description
Elevator()
Elevator(IMCDefinition defs)
Elevator(IMCMessage msg)
Elevator(int timeout, short flags, double lat, double lon, float start_z, Elevator.START_Z_UNITS start_z_units, float end_z, Elevator.END_Z_UNITS end_z_units, float radius, float speed, Elevator.SPEED_UNITS speed_units, java.lang.String custom)

Method Summary

Modifier and Type	Method and Description
static Elevator	clone(IMCMessage msg)
static Elevator	create(java.lang.Object... values)
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getCustom()
double	getEndZ()
Elevator.END_Z_UNITS	getEndZUnits()
java.lang.String	getEndZUnitsStr()
short	getEndZUnitsVal()
short	getFlags()
double	getLat()
double	getLon()
double	getRadius()
double	getSpeed()
Elevator.SPEED_UNITS	getSpeedUnits()
java.lang.String	getSpeedUnitsStr()
short	getSpeedUnitsVal()
double	getStartZ()
Elevator.START_Z_UNITS	getStartZUnits()
java.lang.String	getStartZUnitsStr()
short	getStartZUnitsVal()
int	getTimeout()
Elevator	setCustom(java.util.LinkedHashMap<java.lang.String,?> custom)
Elevator	setCustom(java.lang.String custom)
Elevator	setEndZ(double end_z)
Elevator	setEndZUnits(Elevator.END_Z_UNITS end_z_units)
Elevator	setEndZUnitsStr(java.lang.String end_z_units)
Elevator	setEndZUnitsVal(short end_z_units)
Elevator	setFlags(short flags)
Elevator	setLat(double lat)
Elevator	setLon(double lon)
Elevator	setRadius(double radius)
Elevator	setSpeed(double speed)
Elevator	setSpeedUnits(Elevator.SPEED_UNITS speed_units)
Elevator	setSpeedUnitsStr(java.lang.String speed_units)
Elevator	setSpeedUnitsVal(short speed_units)
Elevator	setStartZ(double start_z)
Elevator	setStartZUnits(Elevator.START_Z_UNITS start_z_units)
Elevator	setStartZUnitsStr(java.lang.String start_z_units)
Elevator	setStartZUnitsVal(short start_z_units)
Elevator	setTimeout(int timeout)

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

ID_STATIC

public static final int ID_STATIC

See Also:

Constant Field Values

Constructor Detail

Elevator

public Elevator()

Elevator

public Elevator(IMCMessage msg)

Elevator

public Elevator(IMCDefinition defs)

Elevator

public Elevator(int timeout,
                short flags,
                double lat,
                double lon,
                float start_z,
                Elevator.START_Z_UNITS start_z_units,
                float end_z,
                Elevator.END_Z_UNITS end_z_units,
                float radius,
                float speed,
                Elevator.SPEED_UNITS speed_units,
                java.lang.String custom)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getTimeout

public int getTimeout()

Returns:

Timeout (s) - uint16_t

setTimeout

public Elevator setTimeout(int timeout)

Parameters:

timeout - Timeout (s)

getFlags

public short getFlags()

Returns:

Flags (bitfield) - uint8_t

setFlags

public Elevator setFlags(short flags)

Parameters:

flags - Flags (bitfield)

getLat

public double getLat()

Returns:

Latitude WGS-84 (rad) - fp64_t

setLat

public Elevator setLat(double lat)

Parameters:

lat - Latitude WGS-84 (rad)

getLon

public double getLon()

Returns:

Longitude WGS-84 (rad) - fp64_t

setLon

public Elevator setLon(double lon)

Parameters:

lon - Longitude WGS-84 (rad)

getStartZ

public double getStartZ()

Returns:

Start Point -- Z Reference (m) - fp32_t

setStartZ

public Elevator setStartZ(double start_z)

Parameters:

start_z - Start Point -- Z Reference (m)

getStartZUnits

public Elevator.START_Z_UNITS getStartZUnits()

Returns:

Start Point -- Z Units (enumerated) - uint8_t

getStartZUnitsStr

public java.lang.String getStartZUnitsStr()

getStartZUnitsVal

public short getStartZUnitsVal()

setStartZUnits

public Elevator setStartZUnits(Elevator.START_Z_UNITS start_z_units)

Parameters:

start_z_units - Start Point -- Z Units (enumerated)

setStartZUnitsStr

public Elevator setStartZUnitsStr(java.lang.String start_z_units)

Parameters:

start_z_units - Start Point -- Z Units (as a String)

setStartZUnitsVal

public Elevator setStartZUnitsVal(short start_z_units)

Parameters:

start_z_units - Start Point -- Z Units (integer value)

getEndZ

public double getEndZ()

Returns:

End Point -- Z Reference (m) - fp32_t

setEndZ

public Elevator setEndZ(double end_z)

Parameters:

end_z - End Point -- Z Reference (m)

getEndZUnits

public Elevator.END_Z_UNITS getEndZUnits()

Returns:

End Point -- Z Units (enumerated) - uint8_t

getEndZUnitsStr

public java.lang.String getEndZUnitsStr()

getEndZUnitsVal

public short getEndZUnitsVal()

setEndZUnits

public Elevator setEndZUnits(Elevator.END_Z_UNITS end_z_units)

Parameters:

end_z_units - End Point -- Z Units (enumerated)

setEndZUnitsStr

public Elevator setEndZUnitsStr(java.lang.String end_z_units)

Parameters:

end_z_units - End Point -- Z Units (as a String)

setEndZUnitsVal

public Elevator setEndZUnitsVal(short end_z_units)

Parameters:

end_z_units - End Point -- Z Units (integer value)

getRadius

public double getRadius()

Returns:

Radius (m) - fp32_t

setRadius

public Elevator setRadius(double radius)

Parameters:

radius - Radius (m)

getSpeed

public double getSpeed()

Returns:

Speed - fp32_t

setSpeed

public Elevator setSpeed(double speed)

Parameters:

speed - Speed

getSpeedUnits

public Elevator.SPEED_UNITS getSpeedUnits()

Returns:

Speed Units (enumerated) - uint8_t

getSpeedUnitsStr

public java.lang.String getSpeedUnitsStr()

getSpeedUnitsVal

public short getSpeedUnitsVal()

setSpeedUnits

public Elevator setSpeedUnits(Elevator.SPEED_UNITS speed_units)

Parameters:

speed_units - Speed Units (enumerated)

setSpeedUnitsStr

public Elevator setSpeedUnitsStr(java.lang.String speed_units)

Parameters:

speed_units - Speed Units (as a String)

setSpeedUnitsVal

public Elevator 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 Elevator setCustom(java.util.LinkedHashMap<java.lang.String,?> custom)

Parameters:

custom - Custom settings for maneuver (tuplelist)

setCustom

public Elevator setCustom(java.lang.String custom)