pt.lsts.neptus.mp.maneuvers

Class StationKeeping

java.lang.Object

pt.lsts.neptus.mp.Maneuver

pt.lsts.neptus.mp.maneuvers.StationKeeping

All Implemented Interfaces:

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

public class StationKeeping
extends Maneuver
implements LocatedManeuver, IMCSerialization, StatisticsProvider

Nested Class Summary

Nested classes/interfaces inherited from class pt.lsts.neptus.mp.Maneuver

Maneuver.SPEED_UNITS, Maneuver.Z_UNITS

Field Summary

Fields

Modifier and Type	Field and Description
static int	INFINITY_DURATION
static double	MINIMUM_SK_RADIUS

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

circleDiam, CT_BOOLEAN, CT_NUMBER, CT_STRING, customSettings, customSettingsTypeHint, DEFAULT_ROOT_ELEMENT, endActions, id, startActions

Constructor Summary

Constructors

Constructor and Description
StationKeeping()

Method Summary

Methods

Modifier and Type	Method and Description
protected java.util.Vector<com.l2fprod.common.propertysheet.DefaultProperty>	additionalProperties()
java.lang.Object	clone() A maneuver must have a way to clone itself.
double	getCompletionTime(LocationType initialPosition)
double	getDistanceTravelled(LocationType initialPosition)
int	getDuration()
ManeuverLocation	getEndLocation() Retrieve the position where the vehicle will end this maneuver
LocationType	getLocation()
org.dom4j.Document	getManeuverAsDocument(java.lang.String rootElementName)
ManeuverLocation	getManeuverLocation() Retrieve the position of the maneuver (position that can be dragged by the user)
double	getMaxDepth()
double	getMinDepth()
double	getRadius()
double	getSpeed()
java.lang.String	getSpeedUnits()
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.
protected double	getVelocityInMetersPerSeconds()
void	loadFromXML(java.lang.String XML)
void	paintOnMap(java.awt.Graphics2D g2d, PlanElement planElement, StateRenderer2D renderer)
void	parseIMCMessage(pt.lsts.imc.IMCMessage message)
pt.lsts.imc.IMCMessage	serializeToIMC()
void	setDuration(int duration)
void	setManeuverLocation(ManeuverLocation location) Set the maneuver's position
void	setProperties(com.l2fprod.common.propertysheet.Property[] properties)
void	setRadius(double radius)
void	setSpeed(double speed)
void	setSpeedUnits(java.lang.String speedUnits)
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, removeTransition, setCustomSettings, setCustomSettingsTypeHint, setId, setInitialManeuver, setMaxTime, setMinTime, setMissionType, 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

MINIMUM_SK_RADIUS

public static final double MINIMUM_SK_RADIUS

See Also:

Constant Field Values

Constructor Detail

StationKeeping

public StationKeeping()

Method Detail

clone

public java.lang.Object clone()

Description copied from class: Maneuver

A maneuver must have a way to clone itself.

Specified by:

clone in class Maneuver

getManeuverAsDocument

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

Specified by:

getManeuverAsDocument in class Maneuver

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.

Overrides:

getType in class Maneuver

loadFromXML

public void loadFromXML(java.lang.String XML)

Specified by:

loadFromXML 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

getLocation

public LocationType getLocation()

getDuration

public int getDuration()

setDuration

public void setDuration(int duration)

getRadius

public double getRadius()

setRadius

public void setRadius(double radius)

getSpeed

public double getSpeed()

setSpeed

public void setSpeed(double speed)

getSpeedUnits

public java.lang.String getSpeedUnits()

setSpeedUnits

public void setSpeedUnits(java.lang.String speedUnits)

getVelocityInMetersPerSeconds

protected double getVelocityInMetersPerSeconds()

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