pt.lsts.neptus.mp.maneuvers

Class FollowPoint

java.lang.Object

pt.lsts.neptus.mp.Maneuver

pt.lsts.neptus.mp.maneuvers.FollowPoint

All Implemented Interfaces:

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

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

Author:

zp

Field Summary

Fields

Modifier and Type	Field and Description
protected TupleList	customData
protected static java.lang.String	DEFAULT_ROOT_ELEMENT
protected java.lang.String	idToFollow
protected ManeuverLocation	location
protected SpeedType	speed

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

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

Constructor Summary

Constructors

Constructor and Description
FollowPoint()

Method Summary

Modifier and Type	Method and Description
protected java.util.Vector<com.l2fprod.common.propertysheet.DefaultProperty>	additionalProperties()
double	getCompletionTime(LocationType initialPosition)
double	getDistanceTravelled(LocationType initialPosition)
ManeuverLocation	getEndLocation() Retrieve the position where the vehicle will end this maneuver
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()
SpeedType	getSpeed()
ManeuverLocation	getStartLocation() Retrieve the position where the vehicle will start this maneuver
java.util.Collection<ManeuverLocation>	getWaypoints()
void	loadManeuverFromXML(java.lang.String xml) Expects only maneuver specific data.
static void	main(java.lang.String[] args)
void	parseIMCMessage(pt.lsts.imc.IMCMessage message)
pt.lsts.imc.IMCMessage	serializeToIMC()
void	setManeuverLocation(ManeuverLocation location) Set the maneuver's position
void	setProperties(com.l2fprod.common.propertysheet.Property[] properties)
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, clone, cloneActions, compareTo, createFromXML, endManeuver, getCustomSettings, getCustomSettingsTypeHint, getEndActions, getIcon, getId, getManeuverXml, getMaxTime, getMinTime, getMissionType, getProperties, getPropertiesDialogTitle, getPropertiesErrors, getReacheableManeuvers, getSamePositionManeuvers, getStartActions, getTooltipText, getTransitionCondition, getType, getXPosition, getYPosition, hasEnded, interpolate, isInitialManeuver, loadFromXMLExtraParameters, loadFromXMLExtraParameters, loadManeuverXml, loadXMLWithSettings, loadXMLWithSettings, loadXMLWithSettings, paintOnMap, 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

location

protected ManeuverLocation location

DEFAULT_ROOT_ELEMENT

protected static final java.lang.String DEFAULT_ROOT_ELEMENT

See Also:

Constant Field Values

customData

protected TupleList customData

speed

protected SpeedType speed

idToFollow

protected java.lang.String idToFollow

Constructor Detail

FollowPoint

public FollowPoint()

Method Detail

loadManeuverFromXML

public void loadManeuverFromXML(java.lang.String xml)

Description copied from class: Maneuver

Expects only maneuver specific data.

Specified by:

loadManeuverFromXML 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:

serializeToIMC

public pt.lsts.imc.IMCMessage serializeToIMC()

Specified by:

serializeToIMC in interface IMCSerialization

parseIMCMessage

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

Specified by:

parseIMCMessage in interface IMCSerialization

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

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

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

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

getWaypoints

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

Specified by:

getWaypoints in interface LocatedManeuver

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

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

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

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

main

public static void main(java.lang.String[] args)