pt.lsts.imc

Class CoverArea

java.lang.Object

pt.lsts.imc.IMCMessage

pt.lsts.imc.Maneuver

pt.lsts.imc.CoverArea

All Implemented Interfaces:

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

public class CoverArea
extends Maneuver

IMC Message Cover Area (473)
Given a polygonal area, generates trajectories to cover the
area.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CoverArea	clone(IMCMessage msg)
static CoverArea	create(java.lang.Object... values)
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getCustom()
double	getLat()
double	getLon()
java.util.Vector<PolygonVertex>	getPolygon()
double	getSpeed()
CoverArea.SPEED_UNITS	getSpeedUnits()
java.lang.String	getSpeedUnitsStr()
short	getSpeedUnitsVal()
double	getZ()
CoverArea.Z_UNITS	getZUnits()
java.lang.String	getZUnitsStr()
short	getZUnitsVal()
CoverArea	setCustom(java.util.LinkedHashMap<java.lang.String,?> custom)
CoverArea	setCustom(java.lang.String custom)
CoverArea	setLat(double lat)
CoverArea	setLon(double lon)
CoverArea	setPolygon(java.util.Collection<PolygonVertex> polygon)
CoverArea	setSpeed(double speed)
CoverArea	setSpeedUnits(CoverArea.SPEED_UNITS speed_units)
CoverArea	setSpeedUnitsStr(java.lang.String speed_units)
CoverArea	setSpeedUnitsVal(short speed_units)
CoverArea	setZ(double z)
CoverArea	setZUnits(CoverArea.Z_UNITS z_units)
CoverArea	setZUnitsStr(java.lang.String z_units)
CoverArea	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

CoverArea

public CoverArea()

CoverArea

public CoverArea(IMCMessage msg)

CoverArea

public CoverArea(IMCDefinition defs)

CoverArea

public CoverArea(double lat,
                 double lon,
                 float z,
                 CoverArea.Z_UNITS z_units,
                 float speed,
                 CoverArea.SPEED_UNITS speed_units,
                 java.util.Collection<PolygonVertex> polygon,
                 java.lang.String custom)

Method Detail

create

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

clone

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

Throws:

java.lang.Exception

getLat

public double getLat()

Returns:

Latitude WGS-84 (rad) - fp64_t

setLat

public CoverArea setLat(double lat)

Parameters:

lat - Latitude WGS-84 (rad)

getLon

public double getLon()

Returns:

Longitude WGS-84 (rad) - fp64_t

setLon

public CoverArea setLon(double lon)

Parameters:

lon - Longitude WGS-84 (rad)

getZ

public double getZ()

Returns:

Z Reference (m) - fp32_t

setZ

public CoverArea setZ(double z)

Parameters:

z - Z Reference (m)

getZUnits

public CoverArea.Z_UNITS getZUnits()

Returns:

Z Units (enumerated) - uint8_t

getZUnitsStr

public java.lang.String getZUnitsStr()

getZUnitsVal

public short getZUnitsVal()

setZUnits

public CoverArea setZUnits(CoverArea.Z_UNITS z_units)

Parameters:

z_units - Z Units (enumerated)

setZUnitsStr

public CoverArea setZUnitsStr(java.lang.String z_units)

Parameters:

z_units - Z Units (as a String)

setZUnitsVal

public CoverArea setZUnitsVal(short z_units)

Parameters:

z_units - Z Units (integer value)

getSpeed

public double getSpeed()

Returns:

Speed - fp32_t

setSpeed

public CoverArea setSpeed(double speed)

Parameters:

speed - Speed

getSpeedUnits

public CoverArea.SPEED_UNITS getSpeedUnits()

Returns:

Speed Units (enumerated) - uint8_t

getSpeedUnitsStr

public java.lang.String getSpeedUnitsStr()

getSpeedUnitsVal

public short getSpeedUnitsVal()

setSpeedUnits

public CoverArea setSpeedUnits(CoverArea.SPEED_UNITS speed_units)

Parameters:

speed_units - Speed Units (enumerated)

setSpeedUnitsStr

public CoverArea setSpeedUnitsStr(java.lang.String speed_units)

Parameters:

speed_units - Speed Units (as a String)

setSpeedUnitsVal

public CoverArea setSpeedUnitsVal(short speed_units)

Parameters:

speed_units - Speed Units (integer value)

getPolygon

public java.util.Vector<PolygonVertex> getPolygon()

Returns:

Polygon - message-list

setPolygon

public CoverArea setPolygon(java.util.Collection<PolygonVertex> polygon)

Parameters:

polygon - Polygon

getCustom

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

Returns:

CustomParameters (tuplelist) - plaintext

setCustom

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

Parameters:

custom - CustomParameters (tuplelist)

setCustom

public CoverArea setCustom(java.lang.String custom)