pt.lsts.imc

Class ScheduledGoto

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.Maneuver

pt.lsts.imc.ScheduledGoto

All Implemented Interfaces:

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

public class ScheduledGoto
extends Maneuver

IMC Message Scheduled Goto (487)
This maneuver is used to command the vehicle to arrive at some destination at
a specified absolute time.
The vehicle's speed will vary according to environment conditions and/or maneuver start time.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScheduledGoto.DELAYED

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
ScheduledGoto()
ScheduledGoto(double arrival_time, double lat, double lon, float z, pt.lsts.imc.def.ZUnits z_units, float travel_z, pt.lsts.imc.def.ZUnits travel_z_units, ScheduledGoto.DELAYED delayed)
ScheduledGoto(IMCDefinition defs)
ScheduledGoto(IMCMessage msg)

Method Summary

Modifier and Type	Method and Description
static ScheduledGoto	clone(IMCMessage msg)
static ScheduledGoto	create(java.lang.Object... values)
double	getArrivalTime()
ScheduledGoto.DELAYED	getDelayed()
java.lang.String	getDelayedStr()
short	getDelayedVal()
double	getLat()
double	getLon()
double	getTravelZ()
pt.lsts.imc.def.ZUnits	getTravelZUnits()
java.lang.String	getTravelZUnitsStr()
short	getTravelZUnitsVal()
double	getZ()
pt.lsts.imc.def.ZUnits	getZUnits()
java.lang.String	getZUnitsStr()
short	getZUnitsVal()
ScheduledGoto	setArrivalTime(double arrival_time)
ScheduledGoto	setDelayed(ScheduledGoto.DELAYED delayed)
ScheduledGoto	setDelayedStr(java.lang.String delayed)
ScheduledGoto	setDelayedVal(short delayed)
ScheduledGoto	setLat(double lat)
ScheduledGoto	setLon(double lon)
ScheduledGoto	setTravelZ(double travel_z)
ScheduledGoto	setTravelZUnits(pt.lsts.imc.def.ZUnits travel_z_units)
ScheduledGoto	setTravelZUnitsStr(java.lang.String travel_z_units)
ScheduledGoto	setTravelZUnitsVal(short travel_z_units)
ScheduledGoto	setZ(double z)
ScheduledGoto	setZUnits(pt.lsts.imc.def.ZUnits z_units)
ScheduledGoto	setZUnitsStr(java.lang.String z_units)
ScheduledGoto	setZUnitsVal(short z_units)

Methods inherited from class pt.lsts.imc.IMCMessage

asJSON, asJSON, asMap, asXml, asXmlStripped, cloneMessage, cloneMessage, compareTo, copyFrom, copyToClipoard, 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, makeImmutable, parseJson, parseXml, pasteFromClipoard, payloadMD5, serialize, serialize, serialize, serializePayload, setBitMask, setDst, setDstEnt, setHeader, setMessageInfo, setMessageList, setSrc, setSrcEnt, setTimestamp, setTimestampMillis, setType, setValue, setValues, toByteArray, toByteArray, 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

ScheduledGoto

public ScheduledGoto()

ScheduledGoto

public ScheduledGoto(IMCMessage msg)

ScheduledGoto

public ScheduledGoto(IMCDefinition defs)

ScheduledGoto

public ScheduledGoto(double arrival_time,
                     double lat,
                     double lon,
                     float z,
                     pt.lsts.imc.def.ZUnits z_units,
                     float travel_z,
                     pt.lsts.imc.def.ZUnits travel_z_units,
                     ScheduledGoto.DELAYED delayed)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getArrivalTime

public double getArrivalTime()

Returns:

Time of arrival (s) - fp64_t

setArrivalTime

public ScheduledGoto setArrivalTime(double arrival_time)

Parameters:

arrival_time - Time of arrival (s)

getLat

public double getLat()

Returns:

Destination Latitude WGS-84 (rad) - fp64_t

setLat

public ScheduledGoto setLat(double lat)

Parameters:

lat - Destination Latitude WGS-84 (rad)

getLon

public double getLon()

Returns:

Destination Longitude WGS-84 (rad) - fp64_t

setLon

public ScheduledGoto setLon(double lon)

Parameters:

lon - Destination Longitude WGS-84 (rad)

getZ

public double getZ()

Returns:

Destination Z Reference (m) - fp32_t

setZ

public ScheduledGoto setZ(double z)

Parameters:

z - Destination Z Reference (m)

getZUnits

public pt.lsts.imc.def.ZUnits getZUnits()

Returns:

Z Units (enumerated) - uint8_t

getZUnitsStr

public java.lang.String getZUnitsStr()

getZUnitsVal

public short getZUnitsVal()

setZUnits

public ScheduledGoto setZUnits(pt.lsts.imc.def.ZUnits z_units)

Parameters:

z_units - Z Units (enumerated)

setZUnitsStr

public ScheduledGoto setZUnitsStr(java.lang.String z_units)

Parameters:

z_units - Z Units (as a String)

setZUnitsVal

public ScheduledGoto setZUnitsVal(short z_units)

Parameters:

z_units - Z Units (integer value)

getTravelZ

public double getTravelZ()

Returns:

Travel Z Reference (m) - fp32_t

setTravelZ

public ScheduledGoto setTravelZ(double travel_z)

Parameters:

travel_z - Travel Z Reference (m)

getTravelZUnits

public pt.lsts.imc.def.ZUnits getTravelZUnits()

Returns:

Travel Z Units (enumerated) - uint8_t

getTravelZUnitsStr

public java.lang.String getTravelZUnitsStr()

getTravelZUnitsVal

public short getTravelZUnitsVal()

setTravelZUnits

public ScheduledGoto setTravelZUnits(pt.lsts.imc.def.ZUnits travel_z_units)

Parameters:

travel_z_units - Travel Z Units (enumerated)

setTravelZUnitsStr

public ScheduledGoto setTravelZUnitsStr(java.lang.String travel_z_units)

Parameters:

travel_z_units - Travel Z Units (as a String)

setTravelZUnitsVal

public ScheduledGoto setTravelZUnitsVal(short travel_z_units)

Parameters:

travel_z_units - Travel Z Units (integer value)

getDelayed

public ScheduledGoto.DELAYED getDelayed()

Returns:

Delayed Behavior (enumerated) - uint8_t

getDelayedStr

public java.lang.String getDelayedStr()

getDelayedVal

public short getDelayedVal()

setDelayed

public ScheduledGoto setDelayed(ScheduledGoto.DELAYED delayed)

Parameters:

delayed - Delayed Behavior (enumerated)

setDelayedStr

public ScheduledGoto setDelayedStr(java.lang.String delayed)

Parameters:

delayed - Delayed Behavior (as a String)

setDelayedVal

public ScheduledGoto setDelayedVal(short delayed)

Parameters:

delayed - Delayed Behavior (integer value)