pt.lsts.imc

Class CommsRelay

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.Maneuver

pt.lsts.imc.CommsRelay

All Implemented Interfaces:

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

public class CommsRelay
extends Maneuver

IMC Message Communications Relay (472)
In this maneuver, a vehicle drives to the center of two other
systems (a, b) in order to be used as a communications relay.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommsRelay.SPEED_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
CommsRelay()
CommsRelay(double lat, double lon, float speed, CommsRelay.SPEED_UNITS speed_units, int duration, int sys_a, int sys_b, float move_threshold)
CommsRelay(IMCDefinition defs)
CommsRelay(IMCMessage msg)

Method Summary

Modifier and Type	Method and Description
static CommsRelay	clone(IMCMessage msg)
static CommsRelay	create(java.lang.Object... values)
int	getDuration()
double	getLat()
double	getLon()
double	getMoveThreshold()
double	getSpeed()
CommsRelay.SPEED_UNITS	getSpeedUnits() Reference speed units.
int	getSysA()
int	getSysB()
CommsRelay	setDuration(int duration)
CommsRelay	setLat(double lat)
CommsRelay	setLon(double lon)
CommsRelay	setMoveThreshold(double move_threshold)
CommsRelay	setSpeed(double speed)
CommsRelay	setSpeedUnits(CommsRelay.SPEED_UNITS speed_units)
CommsRelay	setSpeedUnits(short speed_units)
CommsRelay	setSpeedUnits(java.lang.String speed_units)
CommsRelay	setSysA(int sys_a)
CommsRelay	setSysB(int sys_b)

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

CommsRelay

public CommsRelay()

CommsRelay

public CommsRelay(IMCMessage msg)

CommsRelay

public CommsRelay(IMCDefinition defs)

CommsRelay

public CommsRelay(double lat,
                  double lon,
                  float speed,
                  CommsRelay.SPEED_UNITS speed_units,
                  int duration,
                  int sys_a,
                  int sys_b,
                  float move_threshold)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getLat

public double getLat()

Returns:

Latitude WGS-84 (rad) - fp64_t

getLon

public double getLon()

Returns:

Longitude WGS-84 (rad) - fp64_t

getSpeed

public double getSpeed()

Returns:

Speed - fp32_t

getSpeedUnits

public CommsRelay.SPEED_UNITS getSpeedUnits()

Reference speed units.

Returns:

Speed Units (enumerated) - uint8_t

getDuration

public int getDuration()

Returns:

Duration (s) - uint16_t

getSysA

public int getSysA()

Returns:

System A - uint16_t

getSysB

public int getSysB()

Returns:

System B - uint16_t

getMoveThreshold

public double getMoveThreshold()

Returns:

Move threshold (m) - fp32_t

setLat

public CommsRelay setLat(double lat)

Parameters:

lat - Latitude WGS-84 (rad)

setLon

public CommsRelay setLon(double lon)

Parameters:

lon - Longitude WGS-84 (rad)

setSpeed

public CommsRelay setSpeed(double speed)

Parameters:

speed - Speed

setSpeedUnits

public CommsRelay setSpeedUnits(CommsRelay.SPEED_UNITS speed_units)

Parameters:

speed_units - Speed Units (enumerated)

setSpeedUnits

public CommsRelay setSpeedUnits(java.lang.String speed_units)

Parameters:

speed_units - Speed Units (as a String)

setSpeedUnits

public CommsRelay setSpeedUnits(short speed_units)

Parameters:

speed_units - Speed Units (integer value)

setDuration

public CommsRelay setDuration(int duration)

Parameters:

duration - Duration (s)

setSysA

public CommsRelay setSysA(int sys_a)

Parameters:

sys_a - System A

setSysB

public CommsRelay setSysB(int sys_b)

Parameters:

sys_b - System B

setMoveThreshold

public CommsRelay setMoveThreshold(double move_threshold)

Parameters:

move_threshold - Move threshold (m)