pt.lsts.imc

Class FollowSystem

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.FollowSystem

All Implemented Interfaces:

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

public class FollowSystem
extends IMCMessage

IMC Message Follow System (471)
System-following maneuver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FollowSystem.SPEED_UNITS
static class	FollowSystem.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
FollowSystem()
FollowSystem(IMCDefinition defs)
FollowSystem(IMCMessage msg)
FollowSystem(int system, int duration, float speed, FollowSystem.SPEED_UNITS speed_units, float x, float y, float z, FollowSystem.Z_UNITS z_units)

Method Summary

Modifier and Type	Method and Description
static FollowSystem	clone(IMCMessage msg)
static FollowSystem	create(java.lang.Object... values)
int	getDuration()
double	getSpeed()
FollowSystem.SPEED_UNITS	getSpeedUnits()
java.lang.String	getSpeedUnitsStr()
short	getSpeedUnitsVal()
int	getSystem()
double	getX()
double	getY()
double	getZ()
FollowSystem.Z_UNITS	getZUnits()
java.lang.String	getZUnitsStr()
short	getZUnitsVal()
FollowSystem	setDuration(int duration)
FollowSystem	setSpeed(double speed)
FollowSystem	setSpeedUnits(FollowSystem.SPEED_UNITS speed_units)
FollowSystem	setSpeedUnitsStr(java.lang.String speed_units)
FollowSystem	setSpeedUnitsVal(short speed_units)
FollowSystem	setSystem(int system)
FollowSystem	setX(double x)
FollowSystem	setY(double y)
FollowSystem	setZ(double z)
FollowSystem	setZUnits(FollowSystem.Z_UNITS z_units)
FollowSystem	setZUnitsStr(java.lang.String z_units)
FollowSystem	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

FollowSystem

public FollowSystem()

FollowSystem

public FollowSystem(IMCMessage msg)

FollowSystem

public FollowSystem(IMCDefinition defs)

FollowSystem

public FollowSystem(int system,
                    int duration,
                    float speed,
                    FollowSystem.SPEED_UNITS speed_units,
                    float x,
                    float y,
                    float z,
                    FollowSystem.Z_UNITS z_units)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getSystem

public int getSystem()

Returns:

System To Follow - uint16_t

setSystem

public FollowSystem setSystem(int system)

Parameters:

system - System To Follow

getDuration

public int getDuration()

Returns:

Duration (s) - uint16_t

setDuration

public FollowSystem setDuration(int duration)

Parameters:

duration - Duration (s)

getSpeed

public double getSpeed()

Returns:

Speed - fp32_t

setSpeed

public FollowSystem setSpeed(double speed)

Parameters:

speed - Speed

getSpeedUnits

public FollowSystem.SPEED_UNITS getSpeedUnits()

Returns:

Speed Units (enumerated) - uint8_t

getSpeedUnitsStr

public java.lang.String getSpeedUnitsStr()

getSpeedUnitsVal

public short getSpeedUnitsVal()

setSpeedUnits

public FollowSystem setSpeedUnits(FollowSystem.SPEED_UNITS speed_units)

Parameters:

speed_units - Speed Units (enumerated)

setSpeedUnitsStr

public FollowSystem setSpeedUnitsStr(java.lang.String speed_units)

Parameters:

speed_units - Speed Units (as a String)

setSpeedUnitsVal

public FollowSystem setSpeedUnitsVal(short speed_units)

Parameters:

speed_units - Speed Units (integer value)

getX

public double getX()

Returns:

Offset -- X - fp32_t

setX

public FollowSystem setX(double x)

Parameters:

x - Offset -- X

getY

public double getY()

Returns:

Offset -- Y - fp32_t

setY

public FollowSystem setY(double y)

Parameters:

y - Offset -- Y

getZ

public double getZ()

Returns:

Coordinate -- Z - fp32_t

setZ

public FollowSystem setZ(double z)

Parameters:

z - Coordinate -- Z

getZUnits

public FollowSystem.Z_UNITS getZUnits()

Returns:

Z Units (enumerated) - uint8_t

getZUnitsStr

public java.lang.String getZUnitsStr()

getZUnitsVal

public short getZUnitsVal()

setZUnits

public FollowSystem setZUnits(FollowSystem.Z_UNITS z_units)

Parameters:

z_units - Z Units (enumerated)

setZUnitsStr

public FollowSystem setZUnitsStr(java.lang.String z_units)

Parameters:

z_units - Z Units (as a String)

setZUnitsVal

public FollowSystem setZUnitsVal(short z_units)

Parameters:

z_units - Z Units (integer value)