pt.lsts.neptus.mp.maneuvers

Class Loiter

java.lang.Object

pt.lsts.neptus.mp.Maneuver

pt.lsts.neptus.mp.maneuvers.Loiter

All Implemented Interfaces:

java.lang.Comparable<Maneuver>, PropertiesProvider, IMCSerialization, LocatedManeuver, ManeuverWithSpeed, StatisticsProvider, XmlOutputMethods

public class Loiter
extends Maneuver
implements LocatedManeuver, ManeuverWithSpeed, StatisticsProvider, IMCSerialization

Field Summary

Fields

Modifier and Type	Field and Description
static int	INFINITY_DURATION
protected static java.util.LinkedHashMap<java.lang.Long,java.lang.String>	loiterDirectionConstantsMap
protected static java.util.LinkedHashMap<java.lang.Long,java.lang.String>	wpLoiterTypeConstantsMap

Fields inherited from class pt.lsts.neptus.mp.Maneuver

circleDiam, COLOR_HELP, CT_BOOLEAN, CT_NUMBER, CT_STRING, customSettings, customSettingsTypeHint, DEFAULT_ROOT_ELEMENT, endActions, id, startActions, T, vehicles, X, Y, Z

Constructor Summary

Constructors

Constructor and Description
Loiter()

Method Summary

Modifier and Type	Method and Description
protected java.util.Vector<com.l2fprod.common.propertysheet.DefaultProperty>	additionalProperties()
java.lang.Object	clone() Clone this maneuver
double	getBearing()
double	getCompletionTime(LocationType initialPosition)
java.lang.String	getDirection()
double	getDistanceTravelled(LocationType initialPosition)
ManeuverLocation	getEndLocation() Retrieve the position where the vehicle will end this maneuver
double	getLength()
LocationType	getLocation()
int	getLoiterDuration()
java.lang.String	getLoiterType()
org.dom4j.Document	getManeuverAsDocument(java.lang.String rootElementName) Get each maneuver specific data.
ManeuverLocation	getManeuverLocation() Retrieve the position of the maneuver (position that can be dragged by the user)
double	getMaxDepth()
double	getMinDepth()
double	getRadius()
double	getRadiusTolerance()
SpeedType	getSpeed()
ManeuverLocation	getStartLocation() Retrieve the position where the vehicle will start this maneuver
java.lang.String	getTooltipText()
java.lang.String	getType() The extending classes should provide a type name that will be shown to the user related to that maneuver.
java.util.Collection<ManeuverLocation>	getWaypoints()
void	loadManeuverFromXML(java.lang.String XML) Expects only maneuver specific data.
void	paintOnMap(java.awt.Graphics2D g2d, PlanElement planElement, StateRenderer2D renderer)
void	parseIMCMessage(pt.lsts.imc.IMCMessage message)
pt.lsts.imc.IMCMessage	serializeToIMC()
void	setBearing(double bearing)
void	setDirection(java.lang.String direction)
void	setLength(double length)
void	setLoiterDuration(int loiterDuration)
void	setLoiterType(java.lang.String loiterType)
void	setManeuverLocation(ManeuverLocation location) Set the maneuver's position
void	setProperties(com.l2fprod.common.propertysheet.Property[] properties)
void	setRadius(double radius)
void	setRadiusTolerance(double radiusTolerance)
void	setSpeed(SpeedType speed) Sets the speed
void	translate(double offsetNorth, double offsetEast, double offsetDown) Translate the position of this maneuver

Methods inherited from class pt.lsts.neptus.mp.Maneuver

addTransition, asDocument, asDocument, asElement, asElement, asXML, asXML, clone, cloneActions, compareTo, createFromXML, endManeuver, getCustomSettings, getCustomSettingsTypeHint, getEndActions, getIcon, getId, getManeuverXml, getMaxTime, getMinTime, getMissionType, getProperties, getPropertiesDialogTitle, getPropertiesErrors, getReacheableManeuvers, getSamePositionManeuvers, getStartActions, getTransitionCondition, getXPosition, getYPosition, hasEnded, interpolate, isInitialManeuver, loadFromXMLExtraParameters, loadFromXMLExtraParameters, loadManeuverXml, loadXMLWithSettings, loadXMLWithSettings, loadXMLWithSettings, removeTransition, setCustomSettings, setCustomSettingsTypeHint, setId, setInitialManeuver, setMaxTime, setMinTime, setMissionType, setVehicle, setVehicles, setXPosition, setYPosition, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INFINITY_DURATION

public static final int INFINITY_DURATION

See Also:

Constant Field Values

wpLoiterTypeConstantsMap

protected static final java.util.LinkedHashMap<java.lang.Long,java.lang.String> wpLoiterTypeConstantsMap

loiterDirectionConstantsMap

protected static final java.util.LinkedHashMap<java.lang.Long,java.lang.String> loiterDirectionConstantsMap

Constructor Detail

Loiter

public Loiter()

Method Detail

clone

public java.lang.Object clone()

Description copied from class: Maneuver

Clone this maneuver

Overrides:

clone in class Maneuver

getManeuverAsDocument

public org.dom4j.Document getManeuverAsDocument(java.lang.String rootElementName)

Description copied from class: Maneuver

Get each maneuver specific data.

Specified by:

getManeuverAsDocument in class Maneuver

Returns:

getType

public java.lang.String getType()

Description copied from class: Maneuver

The extending classes should provide a type name that will be shown to the user related to that maneuver. This should match the IMC message maneuver abbreviation.

Overrides:

getType in class Maneuver

loadManeuverFromXML

public void loadManeuverFromXML(java.lang.String XML)

Description copied from class: Maneuver

Expects only maneuver specific data.

Specified by:

loadManeuverFromXML in class Maneuver

getManeuverLocation

public ManeuverLocation getManeuverLocation()

Description copied from interface: LocatedManeuver

Retrieve the position of the maneuver (position that can be dragged by the user)

Specified by:

getManeuverLocation in interface LocatedManeuver

Returns:

a LocationType with maneuver's position

getStartLocation

public ManeuverLocation getStartLocation()

Description copied from interface: LocatedManeuver

Retrieve the position where the vehicle will start this maneuver

Specified by:

getStartLocation in interface LocatedManeuver

Returns:

a LocationTypw with the position where vehicle will start the maneuver

getEndLocation

public ManeuverLocation getEndLocation()

Description copied from interface: LocatedManeuver

Retrieve the position where the vehicle will end this maneuver

Specified by:

getEndLocation in interface LocatedManeuver

Returns:

a LocationTypw with the last vehicle's position

setManeuverLocation

public void setManeuverLocation(ManeuverLocation location)

Description copied from interface: LocatedManeuver

Set the maneuver's position

Specified by:

setManeuverLocation in interface LocatedManeuver

Parameters:

location - The new location for this maneuver

translate

public void translate(double offsetNorth,
                      double offsetEast,
                      double offsetDown)

Description copied from interface: LocatedManeuver

Translate the position of this maneuver

Specified by:

translate in interface LocatedManeuver

Parameters:

offsetNorth - north offset amount, in meters

offsetEast - east offset amount, in meters

offsetDown - down offset amount, in meters

additionalProperties

protected java.util.Vector<com.l2fprod.common.propertysheet.DefaultProperty> additionalProperties()

Overrides:

additionalProperties in class Maneuver

setProperties

public void setProperties(com.l2fprod.common.propertysheet.Property[] properties)

Specified by:

setProperties in interface PropertiesProvider

Overrides:

setProperties in class Maneuver

getTooltipText

public java.lang.String getTooltipText()

Overrides:

getTooltipText in class Maneuver

getBearing

public double getBearing()

setBearing

public void setBearing(double bearing)

getDirection

public java.lang.String getDirection()

setDirection

public void setDirection(java.lang.String direction)

getLength

public double getLength()

setLength

public void setLength(double length)

getLocation

public LocationType getLocation()

getLoiterDuration

public int getLoiterDuration()

setLoiterDuration

public void setLoiterDuration(int loiterDuration)

getRadius

public double getRadius()

setRadius

public void setRadius(double radius)

getRadiusTolerance

public double getRadiusTolerance()

setRadiusTolerance

public void setRadiusTolerance(double radiusTolerance)

setLoiterType

public void setLoiterType(java.lang.String loiterType)

getLoiterType

public java.lang.String getLoiterType()

paintOnMap

public void paintOnMap(java.awt.Graphics2D g2d,
                       PlanElement planElement,
                       StateRenderer2D renderer)

Overrides:

paintOnMap in class Maneuver

parseIMCMessage

public void parseIMCMessage(pt.lsts.imc.IMCMessage message)

Specified by:

parseIMCMessage in interface IMCSerialization

serializeToIMC

public pt.lsts.imc.IMCMessage serializeToIMC()

Specified by:

serializeToIMC in interface IMCSerialization

getCompletionTime

public double getCompletionTime(LocationType initialPosition)

Specified by:

getCompletionTime in interface StatisticsProvider

getDistanceTravelled

public double getDistanceTravelled(LocationType initialPosition)

Specified by:

getDistanceTravelled in interface StatisticsProvider

getMaxDepth

public double getMaxDepth()

Specified by:

getMaxDepth in interface StatisticsProvider

getMinDepth

public double getMinDepth()

Specified by:

getMinDepth in interface StatisticsProvider

getWaypoints

public java.util.Collection<ManeuverLocation> getWaypoints()

Specified by:

getWaypoints in interface LocatedManeuver

getSpeed

public SpeedType getSpeed()

Specified by:

getSpeed in interface ManeuverWithSpeed

Returns:

The speed

setSpeed

public void setSpeed(SpeedType speed)

Description copied from interface: ManeuverWithSpeed

Sets the speed

Specified by:

setSpeed in interface ManeuverWithSpeed