pt.lsts.neptus.mp.maneuvers

Class HeadingSpeedDepth

java.lang.Object

pt.lsts.neptus.mp.Maneuver

pt.lsts.neptus.mp.maneuvers.DefaultManeuver

pt.lsts.neptus.mp.maneuvers.HeadingSpeedDepth

All Implemented Interfaces:

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

Direct Known Subclasses:

HeadingVelocityDepth

public class HeadingSpeedDepth
extends DefaultManeuver
implements IMCSerialization

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
java.lang.String	id

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

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

Constructor Summary

Constructors

Constructor and Description
HeadingSpeedDepth()

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	getDepth()
int	getDuration()
double	getHeading()
java.lang.String	getId()
org.dom4j.Document	getManeuverAsDocument(java.lang.String rootElementName)
java.lang.String	getPropertiesDialogTitle()
java.lang.String[]	getPropertiesErrors(com.l2fprod.common.propertysheet.Property[] properties)
double	getSpeed()
double	getSpeedTolerance()
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.lang.String	getUnits()
boolean	isUseDepth()
boolean	isUseHeading()
boolean	isUseSpeed()
void	loadFromXML(java.lang.String xml)
SystemPositionAndAttitude	ManeuverFunction(SystemPositionAndAttitude lastVehicleState)
void	parseIMCMessage(pt.lsts.imc.IMCMessage message)
pt.lsts.imc.IMCMessage	serializeToIMC()
void	setDepth(double depth)
void	setDuration(int duration)
void	setHeading(double heading)
void	setId(java.lang.String id)
void	setProperties(com.l2fprod.common.propertysheet.Property[] properties)
void	setSpeed(double speed)
void	setSpeedTolerance(double speedTolerance)
void	setUnits(java.lang.String units)
void	setUseDepth(boolean useDepth)
void	setUseHeading(boolean useHeading)
void	setUseSpeed(boolean useSpeed)

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, getManeuverXml, getMaxTime, getMinTime, getMissionType, getProperties, getReacheableManeuvers, getSamePositionManeuvers, getStartActions, getTransitionCondition, getXPosition, getYPosition, hasEnded, interpolate, isInitialManeuver, loadFromXMLExtraParameters, loadFromXMLExtraParameters, loadManeuverXml, paintOnMap, removeTransition, setCustomSettings, setCustomSettingsTypeHint, 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

id

public java.lang.String id

Constructor Detail

HeadingSpeedDepth

public HeadingSpeedDepth()

Method Detail

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 DefaultManeuver

getManeuverAsDocument

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

Overrides:

getManeuverAsDocument in class DefaultManeuver

loadFromXML

public void loadFromXML(java.lang.String xml)

Overrides:

loadFromXML in class DefaultManeuver

ManeuverFunction

public SystemPositionAndAttitude ManeuverFunction(SystemPositionAndAttitude lastVehicleState)

getId

public java.lang.String getId()

Overrides:

getId in class Maneuver

setId

public void setId(java.lang.String id)

Overrides:

setId in class Maneuver

isUseHeading

public boolean isUseHeading()

Returns:

the useHeading

setUseHeading

public void setUseHeading(boolean useHeading)

Parameters:

useHeading - the useHeading to set

isUseSpeed

public boolean isUseSpeed()

Returns:

the useSpeed

setUseSpeed

public void setUseSpeed(boolean useSpeed)

Parameters:

useSpeed - the useSpeed to set

isUseDepth

public boolean isUseDepth()

Returns:

the useDepth

setUseDepth

public void setUseDepth(boolean useDepth)

Parameters:

useDepth - the useDepth to set

getDepth

public double getDepth()

setDepth

public void setDepth(double depth)

getUnits

public java.lang.String getUnits()

setUnits

public void setUnits(java.lang.String units)

getSpeed

public double getSpeed()

setSpeed

public void setSpeed(double speed)

getSpeedTolerance

public double getSpeedTolerance()

setSpeedTolerance

public void setSpeedTolerance(double speedTolerance)

getHeading

public double getHeading()

setHeading

public void setHeading(double heading)

getDuration

public int getDuration()

Returns:

the duration

setDuration

public void setDuration(int duration)

Parameters:

duration - the duration to set

clone

public java.lang.Object clone()

Description copied from class: Maneuver

A maneuver must have a way to clone itself.

Overrides:

clone in class DefaultManeuver

additionalProperties

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

Overrides:

additionalProperties in class Maneuver

getPropertiesDialogTitle

public java.lang.String getPropertiesDialogTitle()

Specified by:

getPropertiesDialogTitle in interface PropertiesProvider

Overrides:

getPropertiesDialogTitle in class Maneuver

setProperties

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

Specified by:

setProperties in interface PropertiesProvider

Overrides:

setProperties in class Maneuver

getPropertiesErrors

public java.lang.String[] getPropertiesErrors(com.l2fprod.common.propertysheet.Property[] properties)

Specified by:

getPropertiesErrors in interface PropertiesProvider

Overrides:

getPropertiesErrors in class Maneuver

getTooltipText

public java.lang.String getTooltipText()

Overrides:

getTooltipText 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