pt.lsts.imc

Class FollowPath

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.Maneuver

pt.lsts.imc.FollowPath

All Implemented Interfaces:

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

public class FollowPath
extends Maneuver

IMC Message Follow Path Maneuver (457)
Maneuver constituted by a list of Path Points.

Nested Class Summary

Nested Classes

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

Method Summary

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

FollowPath

public FollowPath()

FollowPath

public FollowPath(IMCMessage msg)

FollowPath

public FollowPath(IMCDefinition defs)

FollowPath

public FollowPath(int timeout,
                  double lat,
                  double lon,
                  float z,
                  FollowPath.Z_UNITS z_units,
                  float speed,
                  FollowPath.SPEED_UNITS speed_units,
                  java.util.Collection<PathPoint> points,
                  java.lang.String custom)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getTimeout

public int getTimeout()

Returns:

Timeout (s) - uint16_t

setTimeout

public FollowPath setTimeout(int timeout)

Parameters:

timeout - Timeout (s)

getLat

public double getLat()

Returns:

Latitude WGS-84 (rad) - fp64_t

setLat

public FollowPath setLat(double lat)

Parameters:

lat - Latitude WGS-84 (rad)

getLon

public double getLon()

Returns:

Longitude WGS-84 (rad) - fp64_t

setLon

public FollowPath setLon(double lon)

Parameters:

lon - Longitude WGS-84 (rad)

getZ

public double getZ()

Returns:

Z Reference (m) - fp32_t

setZ

public FollowPath setZ(double z)

Parameters:

z - Z Reference (m)

getZUnits

public FollowPath.Z_UNITS getZUnits()

Returns:

Z Units (enumerated) - uint8_t

getZUnitsStr

public java.lang.String getZUnitsStr()

getZUnitsVal

public short getZUnitsVal()

setZUnits

public FollowPath setZUnits(FollowPath.Z_UNITS z_units)

Parameters:

z_units - Z Units (enumerated)

setZUnitsStr

public FollowPath setZUnitsStr(java.lang.String z_units)

Parameters:

z_units - Z Units (as a String)

setZUnitsVal

public FollowPath setZUnitsVal(short z_units)

Parameters:

z_units - Z Units (integer value)

getSpeed

public double getSpeed()

Returns:

Speed - fp32_t

setSpeed

public FollowPath setSpeed(double speed)

Parameters:

speed - Speed

getSpeedUnits

public FollowPath.SPEED_UNITS getSpeedUnits()

Returns:

Speed Units (enumerated) - uint8_t

getSpeedUnitsStr

public java.lang.String getSpeedUnitsStr()

getSpeedUnitsVal

public short getSpeedUnitsVal()

setSpeedUnits

public FollowPath setSpeedUnits(FollowPath.SPEED_UNITS speed_units)

Parameters:

speed_units - Speed Units (enumerated)

setSpeedUnitsStr

public FollowPath setSpeedUnitsStr(java.lang.String speed_units)

Parameters:

speed_units - Speed Units (as a String)

setSpeedUnitsVal

public FollowPath setSpeedUnitsVal(short speed_units)

Parameters:

speed_units - Speed Units (integer value)

getPoints

public java.util.Vector<PathPoint> getPoints()

Returns:

Path Points - message-list

setPoints

public FollowPath setPoints(java.util.Collection<PathPoint> points)

Parameters:

points - Path Points

getCustom

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

Returns:

Custom settings for maneuver (tuplelist) - plaintext

setCustom

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

Parameters:

custom - Custom settings for maneuver (tuplelist)

setCustom

public FollowPath setCustom(java.lang.String custom)