pt.lsts.imc

Class VehicleFormationParticipant

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.VehicleFormationParticipant

All Implemented Interfaces:

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

public class VehicleFormationParticipant
extends IMCMessage

IMC Message Vehicle Formation Participant (467)
Definition of a vehicle participant in a VehicleFormation maneuver.

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
VehicleFormationParticipant()
VehicleFormationParticipant(IMCDefinition defs)
VehicleFormationParticipant(IMCMessage msg)
VehicleFormationParticipant(int vid, float off_x, float off_y, float off_z)

Method Summary

Modifier and Type	Method and Description
static VehicleFormationParticipant	clone(IMCMessage msg)
static VehicleFormationParticipant	create(java.lang.Object... values)
double	getOffX()
double	getOffY()
double	getOffZ()
int	getVid()
VehicleFormationParticipant	setOffX(double off_x)
VehicleFormationParticipant	setOffY(double off_y)
VehicleFormationParticipant	setOffZ(double off_z)
VehicleFormationParticipant	setVid(int vid)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asXml, cloneMessage, cloneMessage, compareTo, copyFrom, decodeTupleList, dump, encodeTupleList, get, getAbbrev, getAsNumber, getAsString, getBitmask, getDate, getDouble, getDst, getDstEnt, getFieldNames, getFloat, getHeader, getHeaderValue, getInteger, getLong, getLongFieldName, getLongName, getMessage, getMessage, 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, parseXml, payloadMD5, serialize, serialize, setBitMask, setDst, setDstEnt, setHeader, 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

VehicleFormationParticipant

public VehicleFormationParticipant()

VehicleFormationParticipant

public VehicleFormationParticipant(IMCMessage msg)

VehicleFormationParticipant

public VehicleFormationParticipant(IMCDefinition defs)

VehicleFormationParticipant

public VehicleFormationParticipant(int vid,
                                   float off_x,
                                   float off_y,
                                   float off_z)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getVid

public int getVid()

Returns:

ID (IMC address) - uint16_t

getOffX

public double getOffX()

Returns:

Formation offset -- Along-track (m) - fp32_t

getOffY

public double getOffY()

Returns:

Formation offset -- Cross-track (m) - fp32_t

getOffZ

public double getOffZ()

Returns:

Formation offset -- Depth/Altitude (m) - fp32_t

setVid

public VehicleFormationParticipant setVid(int vid)

Parameters:

vid - ID (IMC address)

setOffX

public VehicleFormationParticipant setOffX(double off_x)

Parameters:

off_x - Formation offset -- Along-track (m)

setOffY

public VehicleFormationParticipant setOffY(double off_y)

Parameters:

off_y - Formation offset -- Cross-track (m)

setOffZ

public VehicleFormationParticipant setOffZ(double off_z)

Parameters:

off_z - Formation offset -- Depth/Altitude (m)