pt.lsts.neptus.mp.maneuvers

Class CommsRelay

java.lang.Object

pt.lsts.neptus.mp.Maneuver

pt.lsts.neptus.mp.maneuvers.DefaultManeuver

pt.lsts.neptus.mp.maneuvers.CommsRelay

All Implemented Interfaces:

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

public class CommsRelay
extends DefaultManeuver
implements IMCSerialization, LocatedManeuver, ManeuverWithSpeed

Author:

zp

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_ROOT_ELEMENT

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
CommsRelay()

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
int	getDuration()
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	getMoveThreshold()
java.lang.String	getPropertiesDialogTitle()
java.lang.String[]	getPropertiesErrors(com.l2fprod.common.propertysheet.Property[] properties)
SpeedType	getSpeed()
ManeuverLocation	getStartLocation() Retrieve the position where the vehicle will start this maneuver
java.lang.String	getSystemA()
java.lang.String	getSystemB()
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.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	setDuration(int duration)
void	setManeuverLocation(ManeuverLocation location) Set the maneuver's position
void	setMoveThreshold(double move_threshold)
void	setProperties(com.l2fprod.common.propertysheet.Property[] properties)
void	setSpeed(SpeedType speed) Sets the speed
void	setSystemA(java.lang.String system)
void	setSystemB(java.lang.String system)
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, getReacheableManeuvers, getSamePositionManeuvers, getStartActions, getTransitionCondition, 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

DEFAULT_ROOT_ELEMENT

protected static final java.lang.String DEFAULT_ROOT_ELEMENT

See Also:

Constant Field Values

Constructor Detail

CommsRelay

public CommsRelay()

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. This should match the IMC message maneuver abbreviation.

Overrides:

getType in class DefaultManeuver

getManeuverAsDocument

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

Description copied from class: Maneuver

Get each maneuver specific data.

Overrides:

getManeuverAsDocument in class DefaultManeuver

Returns:

loadManeuverFromXML

public void loadManeuverFromXML(java.lang.String xml)

Description copied from class: Maneuver

Expects only maneuver specific data.

Overrides:

loadManeuverFromXML in class DefaultManeuver

getSystemA

public java.lang.String getSystemA()

setSystemA

public void setSystemA(java.lang.String system)

getSystemB

public java.lang.String getSystemB()

setSystemB

public void setSystemB(java.lang.String system)

getDuration

public int getDuration()

setDuration

public void setDuration(int duration)

getMoveThreshold

public double getMoveThreshold()

Returns:

the move_threshold

setMoveThreshold

public void setMoveThreshold(double move_threshold)

Parameters:

move_threshold - the move_threshold to set

clone

public java.lang.Object clone()

Description copied from class: Maneuver

Clone this maneuver

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

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

getWaypoints

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

Specified by:

getWaypoints in interface LocatedManeuver

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

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

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