pt.lsts.imc

Class VehicleFormation

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.Maneuver

pt.lsts.imc.VehicleFormation

All Implemented Interfaces:

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

public class VehicleFormation
extends Maneuver

IMC Message Vehicle Formation (466)
Coordinate maneuver using two or more cooperating systems.

Nested Class Summary

Nested Classes

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

Method Summary

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

VehicleFormation

public VehicleFormation()

VehicleFormation

public VehicleFormation(IMCMessage msg)

VehicleFormation

public VehicleFormation(IMCDefinition defs)

VehicleFormation

public VehicleFormation(double lat,
                        double lon,
                        float z,
                        VehicleFormation.Z_UNITS z_units,
                        float speed,
                        VehicleFormation.SPEED_UNITS speed_units,
                        java.util.Collection<TrajectoryPoint> points,
                        java.util.Collection<VehicleFormationParticipant> participants,
                        double start_time,
                        java.lang.String custom)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getLat

public double getLat()

Returns:

Latitude WGS-84 (rad) - fp64_t

setLat

public VehicleFormation setLat(double lat)

Parameters:

lat - Latitude WGS-84 (rad)

getLon

public double getLon()

Returns:

Longitude WGS-84 (rad) - fp64_t

setLon

public VehicleFormation setLon(double lon)

Parameters:

lon - Longitude WGS-84 (rad)

getZ

public double getZ()

Returns:

Z Reference (m) - fp32_t

setZ

public VehicleFormation setZ(double z)

Parameters:

z - Z Reference (m)

getZUnits

public VehicleFormation.Z_UNITS getZUnits()

Returns:

Z Units (enumerated) - uint8_t

getZUnitsStr

public java.lang.String getZUnitsStr()

getZUnitsVal

public short getZUnitsVal()

setZUnits

public VehicleFormation setZUnits(VehicleFormation.Z_UNITS z_units)

Parameters:

z_units - Z Units (enumerated)

setZUnitsStr

public VehicleFormation setZUnitsStr(java.lang.String z_units)

Parameters:

z_units - Z Units (as a String)

setZUnitsVal

public VehicleFormation setZUnitsVal(short z_units)

Parameters:

z_units - Z Units (integer value)

getSpeed

public double getSpeed()

Returns:

Speed - fp32_t

setSpeed

public VehicleFormation setSpeed(double speed)

Parameters:

speed - Speed

getSpeedUnits

public VehicleFormation.SPEED_UNITS getSpeedUnits()

Returns:

Speed Units (enumerated) - uint8_t

getSpeedUnitsStr

public java.lang.String getSpeedUnitsStr()

getSpeedUnitsVal

public short getSpeedUnitsVal()

setSpeedUnits

public VehicleFormation setSpeedUnits(VehicleFormation.SPEED_UNITS speed_units)

Parameters:

speed_units - Speed Units (enumerated)

setSpeedUnitsStr

public VehicleFormation setSpeedUnitsStr(java.lang.String speed_units)

Parameters:

speed_units - Speed Units (as a String)

setSpeedUnitsVal

public VehicleFormation setSpeedUnitsVal(short speed_units)

Parameters:

speed_units - Speed Units (integer value)

getPoints

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

Returns:

Trajectory Points - message-list

setPoints

public VehicleFormation setPoints(java.util.Collection<TrajectoryPoint> points)

Parameters:

points - Trajectory Points

getParticipants

public java.util.Vector<VehicleFormationParticipant> getParticipants()

Returns:

Formation Participants - message-list

setParticipants

public VehicleFormation setParticipants(java.util.Collection<VehicleFormationParticipant> participants)

Parameters:

participants - Formation Participants

getStartTime

public double getStartTime()

Returns:

Start Time (s) - fp64_t

setStartTime

public VehicleFormation setStartTime(double start_time)

Parameters:

start_time - Start Time (s)

getCustom

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

Returns:

Custom settings for maneuver (tuplelist) - plaintext

setCustom

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

Parameters:

custom - Custom settings for maneuver (tuplelist)

setCustom

public VehicleFormation setCustom(java.lang.String custom)