pt.lsts.imc

Class FollowPoint

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.Maneuver

pt.lsts.imc.FollowPoint

All Implemented Interfaces:

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

public class FollowPoint
extends Maneuver

IMC Message Follow Point Maneuver (494)
This maneuver behaves by following a point.

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
FollowPoint()
FollowPoint(IMCDefinition defs)
FollowPoint(IMCMessage msg)
FollowPoint(java.lang.String target, float max_speed, pt.lsts.imc.def.SpeedUnits speed_units, double lat, double lon, float z, pt.lsts.imc.def.ZUnits z_units, java.lang.String custom)

Method Summary

Modifier and Type	Method and Description
static FollowPoint	clone(IMCMessage msg)
static FollowPoint	create(java.lang.Object... values)
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getCustom()
double	getLat()
double	getLon()
double	getMaxSpeed()
pt.lsts.imc.def.SpeedUnits	getSpeedUnits()
java.lang.String	getSpeedUnitsStr()
short	getSpeedUnitsVal()
java.lang.String	getTarget()
double	getZ()
pt.lsts.imc.def.ZUnits	getZUnits()
java.lang.String	getZUnitsStr()
short	getZUnitsVal()
FollowPoint	setCustom(java.util.LinkedHashMap<java.lang.String,?> custom)
FollowPoint	setCustom(java.lang.String custom)
FollowPoint	setLat(double lat)
FollowPoint	setLon(double lon)
FollowPoint	setMaxSpeed(double max_speed)
FollowPoint	setSpeedUnits(pt.lsts.imc.def.SpeedUnits speed_units)
FollowPoint	setSpeedUnitsStr(java.lang.String speed_units)
FollowPoint	setSpeedUnitsVal(short speed_units)
FollowPoint	setTarget(java.lang.String target)
FollowPoint	setZ(double z)
FollowPoint	setZUnits(pt.lsts.imc.def.ZUnits z_units)
FollowPoint	setZUnitsStr(java.lang.String z_units)
FollowPoint	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

FollowPoint

public FollowPoint()

FollowPoint

public FollowPoint(IMCMessage msg)

FollowPoint

public FollowPoint(IMCDefinition defs)

FollowPoint

public FollowPoint(java.lang.String target,
                   float max_speed,
                   pt.lsts.imc.def.SpeedUnits speed_units,
                   double lat,
                   double lon,
                   float z,
                   pt.lsts.imc.def.ZUnits z_units,
                   java.lang.String custom)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getTarget

public java.lang.String getTarget()

Returns:

Source To Follow - plaintext

setTarget

public FollowPoint setTarget(java.lang.String target)

Parameters:

target - Source To Follow

getMaxSpeed

public double getMaxSpeed()

Returns:

Maximum Speed (m/s) - fp32_t

setMaxSpeed

public FollowPoint setMaxSpeed(double max_speed)

Parameters:

max_speed - Maximum Speed (m/s)

getSpeedUnits

public pt.lsts.imc.def.SpeedUnits getSpeedUnits()

Returns:

Speed Units (enumerated) - uint8_t

getSpeedUnitsStr

public java.lang.String getSpeedUnitsStr()

getSpeedUnitsVal

public short getSpeedUnitsVal()

setSpeedUnits

public FollowPoint setSpeedUnits(pt.lsts.imc.def.SpeedUnits speed_units)

Parameters:

speed_units - Speed Units (enumerated)

setSpeedUnitsStr

public FollowPoint setSpeedUnitsStr(java.lang.String speed_units)

Parameters:

speed_units - Speed Units (as a String)

setSpeedUnitsVal

public FollowPoint setSpeedUnitsVal(short speed_units)

Parameters:

speed_units - Speed Units (integer value)

getLat

public double getLat()

Returns:

Latitude WGS-84 (rad) - fp64_t

setLat

public FollowPoint setLat(double lat)

Parameters:

lat - Latitude WGS-84 (rad)

getLon

public double getLon()

Returns:

Longitude WGS-84 (rad) - fp64_t

setLon

public FollowPoint setLon(double lon)

Parameters:

lon - Longitude WGS-84 (rad)

getZ

public double getZ()

Returns:

Z (m) - fp32_t

setZ

public FollowPoint setZ(double z)

Parameters:

z - Z (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 FollowPoint setZUnits(pt.lsts.imc.def.ZUnits z_units)

Parameters:

z_units - Z Units (enumerated)

setZUnitsStr

public FollowPoint setZUnitsStr(java.lang.String z_units)

Parameters:

z_units - Z Units (as a String)

setZUnitsVal

public FollowPoint setZUnitsVal(short z_units)

Parameters:

z_units - Z Units (integer value)

getCustom

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

Returns:

Custom settings for maneuver (tuplelist) - plaintext

setCustom

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

Parameters:

custom - Custom settings for maneuver (tuplelist)

setCustom

public FollowPoint setCustom(java.lang.String custom)