pt.lsts.neptus.mp.maneuvers

Class CompassCalibration

java.lang.Object

pt.lsts.neptus.mp.Maneuver

pt.lsts.neptus.mp.maneuvers.CompassCalibration

All Implemented Interfaces:

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

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

Author:

pdias

Field Summary

Fields

Modifier and Type	Field and Description
double	amplitude
protected static java.lang.String	DEFAULT_ROOT_ELEMENT
pt.lsts.imc.CompassCalibration.DIRECTION	direction
int	duration
ManeuverLocation	location
double	pitchDegs
float	radius
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
CompassCalibration()

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	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.lang.String	getTooltipText()
java.util.Collection<ManeuverLocation>	getWaypoints()
void	loadManeuverFromXML(java.lang.String xml) Expects only maneuver specific data.
static void	main(java.lang.String[] args)
void	paintOnMap(java.awt.Graphics2D g2d, PlanElement planElement, StateRenderer2D renderer)
void	parseIMCMessage(pt.lsts.imc.IMCMessage message)
pt.lsts.imc.IMCMessage	serializeToIMC()
void	setManeuverLocation(ManeuverLocation loc) 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
java.lang.String	validatePitchDegs(double value)

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, getType, 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

DEFAULT_ROOT_ELEMENT

protected static final java.lang.String DEFAULT_ROOT_ELEMENT

See Also:

Constant Field Values

location

public ManeuverLocation location

speed

public SpeedType speed

pitchDegs

public double pitchDegs

amplitude

public double amplitude

duration

public int duration

radius

public float radius

direction

public pt.lsts.imc.CompassCalibration.DIRECTION direction

Constructor Detail

CompassCalibration

public CompassCalibration()

Method Detail

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:

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

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

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

validatePitchDegs

public java.lang.String validatePitchDegs(double 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

Clone this maneuver

Overrides:

clone in class Maneuver

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

getWaypoints

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

Specified by:

getWaypoints in interface LocatedManeuver

main

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

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