pt.lsts.neptus.mp.maneuvers

Class Elevator

java.lang.Object

pt.lsts.neptus.mp.Maneuver

pt.lsts.neptus.mp.maneuvers.Elevator

All Implemented Interfaces:

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

public class Elevator
extends Maneuver
implements LocatedManeuver, IMCSerialization, StatisticsProvider

Author:

pdias

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
protected static java.lang.String	DEFAULT_ROOT_ELEMENT
ManeuverLocation	location
float	radius
double	speed
java.lang.String	speedUnits
boolean	startFromCurrentPosition
float	startZ
ManeuverLocation.Z_UNITS	startZUnits

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

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

Constructor Summary

Constructors

Constructor and Description
Elevator()

Method Summary

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)
ManeuverLocation	getEndLocation() Retrieve the position where the vehicle will end this maneuver
float	getEndZ()
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()
float	getRadius()
double	getSpeed()
java.lang.String	getSpeedUnits()
ManeuverLocation	getStartLocation() Retrieve the position where the vehicle will start this maneuver
float	getStartZ()
ManeuverLocation.Z_UNITS	getStartZUnits()
java.lang.String	getTooltipText()
boolean	isStartFromCurrentPosition()
void	loadFromXML(java.lang.String xml)
SystemPositionAndAttitude	ManeuverFunction(SystemPositionAndAttitude lastVehicleState) The mission preview will call this function every second to refresh the vehicle state.
void	paintOnMap(java.awt.Graphics2D g2d, PlanElement planElement, StateRenderer2D renderer)
void	parseIMCMessage(pt.lsts.imc.IMCMessage message)
pt.lsts.imc.IMCMessage	serializeToIMC()
void	setEndZ(float endZ)
void	setManeuverLocation(ManeuverLocation loc) Set the maneuver's position
void	setProperties(com.l2fprod.common.propertysheet.Property[] properties)
void	setRadius(float radius)
void	setSpeed(double speed)
void	setSpeedUnits(java.lang.String units)
void	setStartFromCurrentPosition(boolean startFromCurrentPosition)
void	setStartZ(float startZ)
void	setStartZUnits(ManeuverLocation.Z_UNITS startZUnits)
void	translate(double offsetNorth, double offsetEast, double offsetDown) Translate the position of this maneuver
java.lang.String	validatePitchAngleDegrees(float value)

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

addTransition, asDocument, asDocument, asElement, asElement, asXML, asXML, calcFinalState, clone, cloneActions, compareTo, createFromXML, endManeuver, getCustomSettings, getCustomSettingsTypeHint, getEndActions, getIcon, getId, getManeuverXml, getMaxTime, getMinTime, getMissionType, getProperties, getPropertiesDialogTitle, getPropertiesErrors, getReacheableManeuvers, getSamePositionManeuvers, getStartActions, getTransitionCondition, getType, 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

DEFAULT_ROOT_ELEMENT

protected static final java.lang.String DEFAULT_ROOT_ELEMENT

See Also:

Constant Field Values

location

public ManeuverLocation location

speed

public double speed

speedUnits

public java.lang.String speedUnits

startFromCurrentPosition

public boolean startFromCurrentPosition

startZ

public float startZ

startZUnits

public ManeuverLocation.Z_UNITS startZUnits

radius

public float radius

Constructor Detail

Elevator

public Elevator()

Method Detail

getManeuverAsDocument

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

Specified by:

getManeuverAsDocument in class Maneuver

loadFromXML

public void loadFromXML(java.lang.String xml)

Specified by:

loadFromXML in class Maneuver

ManeuverFunction

public SystemPositionAndAttitude ManeuverFunction(SystemPositionAndAttitude lastVehicleState)

Description copied from class: Maneuver

The mission preview will call this function every second to refresh the vehicle state.
Implement this function to show how this maneuver is performed by the vehicle.

Specified by:

ManeuverFunction in class Maneuver

isStartFromCurrentPosition

public boolean isStartFromCurrentPosition()

Returns:

the startFromCurrentPosition

setStartFromCurrentPosition

public void setStartFromCurrentPosition(boolean startFromCurrentPosition)

Parameters:

startFromCurrentPosition - the startFromCurrentPosition to set

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

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

setManeuverLocation

public void setManeuverLocation(ManeuverLocation loc)

Description copied from interface: LocatedManeuver

Set the maneuver's position

Specified by:

setManeuverLocation in interface LocatedManeuver

Parameters:

loc - The new location for this maneuver

getEndZ

public float getEndZ()

Returns:

the endZ

setEndZ

public void setEndZ(float endZ)

Parameters:

endZ - the endZ to set

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

getTooltipText

public java.lang.String getTooltipText()

Overrides:

getTooltipText in class Maneuver

validatePitchAngleDegrees

public java.lang.String validatePitchAngleDegrees(float value)

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

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

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

getRadius

public float getRadius()

Returns:

the radius

setRadius

public void setRadius(float radius)

Parameters:

radius - the radius to set

getSpeed

public double getSpeed()

Returns:

the speed

setSpeed

public void setSpeed(double speed)

Parameters:

speed - the speed to set

getSpeedUnits

public java.lang.String getSpeedUnits()

Returns:

the units

setSpeedUnits

public void setSpeedUnits(java.lang.String units)

Parameters:

units - the units to set

getStartZ

public final float getStartZ()

Returns:

the startZ

setStartZ

public final void setStartZ(float startZ)

Parameters:

startZ - the startZ to set

getStartZUnits

public ManeuverLocation.Z_UNITS getStartZUnits()

Returns:

the startZUnits

setStartZUnits

public void setStartZUnits(ManeuverLocation.Z_UNITS startZUnits)

Parameters:

startZUnits - the startZUnits to set

paintOnMap

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

Overrides:

paintOnMap in class Maneuver

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