UuvScriptCommands (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- avcl.AvclScriptCommands
- - avcl.UuvScriptCommands

```
public class UuvScriptCommands
extends AvclScriptCommands
```
Description : Contains static utility functions to interface with JAXB-derived classes representing AVCL AUV script commands. This class is used to generate new instances of individual script commands and alter the values of existing commands. Public methods take Object parameters so that invoking objects can utilize them without any knowledge of the JAXB-derived classes. All direct manipulation of the JAXB-developed classes should be handled by this or other classes in this package.

Since:

07 May 2004 Program : AUV Workbench Platform : Windows 2000/Windows XP

Version:

$Id: UuvScriptCommands.java 9096 2015-07-29 04:01:06Z brutzman $

Author:

Duane Davis

Constructor Summary

Constructors
Constructor and Description

UuvScriptCommands()

Constructors
Constructor and Description
`UuvScriptCommands()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`clearCompositeWaypointCmdSpeed(CompositeWaypointUUVCommandType cmd)` Clears the composite waypoint command's speed-related elements
`static void`	`clearLoiterCmdSpeed(LoiterUUVCommandType cmd)` Clears all speed elements of a loiter command
`static void`	`clearWaypointCmdSpeed(WaypointUUVCommandType cmd)` Clears the waypoint command's speed-related elements
`static CompositeWaypointUUVCommandType`	`createExpandingSquareCmd(int positionMode, double x, double y, double orientation, double trackSpacing, int trackCount, String turnDirection, int depthMode, double depth, int whichProp, double propSetting, int gpsFixes, double standoff, double timeOut, String description)` Generates a ExpandingSquare composite waypoint command
`static CompositeWaypointUUVCommandType`	`createExpandingSquareCmd(int positionMode, String x, String y, double orientation, double trackSpacing, int trackCount, String turnDirection, int depthMode, double depth, int whichProp, double propSetting, int gpsFixes, double standoff, double timeOut, String description)` Generates a ExpandingSquare composite waypoint command
`static JAXBElement<GpsFixCommandType>`	`createGpsFixCmd(boolean start, double timeOut, String description)` Generates a GpsFix command
`static HoverCommandType`	`createHoverCmd(double x, double y, int positMode, double z, int depthMode, double heading, double standoff, double timeOut, String description)` Generates a Hover command
`static HoverCommandType`	`createHoverCmd(String x, String y, int positMode, double z, int depthMode, double heading, double standoff, double timeOut, String description)` Generates a Hover command
`static JAXBElement<LoiterUUVCommandType>`	`createLoiterCmd(double x, double y, int positMode, int whichPropeller, double propeller, double transitZ, int depthMode, double loiterZ, double timeOut, String description)` Generates a Loiter command
`static LoiterUUVCommandType`	`createLoiterCmd(String x, String y, int positMode, int whichPropeller, double propeller, double transitZ, int depthMode, double loiterZ, double timeOut, String description)` Generates a Loiter command
`static JAXBElement<NonNegativeScalarElementType>`	`createMakeAltitudeCmd(double setting, String description)` Generates a MakeAltitude command
`static JAXBElement<NonNegativeScalarElementType>`	`createMakeDepthCmd(double setting, String description)` Generates a MakeDepth command
`static JAXBElement<SignedPercentElementType>`	`createMoveLateralCmd(double setting, String description)` Generates a MoveLateral command
`static JAXBElement<SignedPercentElementType>`	`createMoveRotateCmd(double setting, String description)` Generates a MoveRotate command
`static CompositeWaypointUUVCommandType`	`createParallelTrackCmd(int positionMode, double x, double y, double orientation, double trackLength, double trackSpacing, int trackCount, String firstTurn, int depthMode, double depth, int whichProp, double propSetting, int gpsFixes, double standoff, double timeOut, String description)` Generates a ParallelTrack composite waypoint command
`static CompositeWaypointUUVCommandType`	`createParallelTrackCmd(int positionMode, String x, String y, double orientation, double trackLength, double trackSpacing, int trackCount, String firstTurn, int depthMode, double depth, int whichProp, double propSetting, int gpsFixes, double standoff, double timeOut, String description)`
`static RecoverCommandType`	`createRecoverCmd(double range, double heading, double timeOut, String description)` Generates an Recover command
`static CompositeWaypointUUVCommandType`	`createSectorPatternCmd(int positionMode, double x, double y, double orientation, double radius, double sectorSize, int sectorCount, String turnDirection, int depthMode, double depth, int whichProp, double propSetting, int gpsFixes, double standoff, double timeOut, String description)` Generates a SectorPattern composite waypoint command
`static CompositeWaypointUUVCommandType`	`createSectorPatternCmd(int positionMode, String x, String y, double orientation, double radius, double sectorSize, int sectorCount, String turnDirection, int depthMode, double depth, int whichProp, double propSetting, int gpsFixes, double standoff, double timeOut, String description)` Generates a SectorPattern composite waypoint command
`static JAXBElement<SetPlanesCommandType>`	`createSetPlanesCmd(int whichPlanes, double setting, String description)` Generates a SetPlanes command
`static JAXBElement<SetPositionUUVCommandType>`	`createSetPositionCmd(double xString, double yString, int positType, double z, String description)` Generates a Position command
`static JAXBElement<SetPositionUUVCommandType>`	`createSetPositionCmd(String xString, String yString, int positType, double z, String description)` Generates a Position command
`static JAXBElement<SetSonarCommandType>`	`createSetSonarCmd(String model, int scanMode, double bearing, int bearingType, String description)` Generates a SetSonar command
`static JAXBElement<SetThrusterCommandType>`	`createSetThrusterCmd(int whichThruster, double setting, String description)` Generates a SetThruster command
`static TakeStationCommandType`	`createTakeStationCmd(int scanMode, double stationBearing, double stationRange, double tgtBearing, double tgtRange, double heading, double timeOut, String description)` Generates a TakeStation command
`static JAXBElement<BooleanElementType>`	`createThrustersCmd(boolean enabled, String description)` Generates a Thrusters command
`static WaypointUUVCommandType`	`createWaypointCmd(double latitude, double longitude, double depth, String id, String description)` Generates a Waypoint command
`static JAXBElement<WaypointUUVCommandType>`	`createWaypointCmd(double x, double y, int positMode, double z, int depthMode, double propSpeed, int propSelection, boolean gps, double standoff, double timeOut, String description)` Generates a Waypoint command
`static WaypointUUVCommandType`	`createWaypointCmd(String x, String y, int positMode, double z, int depthMode, double propSpeed, int propSelection, boolean gps, double standoff, double timeOut, String description)` Generates a Waypoint command
`static double`	`getCompositeWaypointCmdDepth(CompositeWaypointUUVCommandType cmd)` Returns the depth (or altitude) of the CompositeWaypoint command
`static int`	`getCompositeWaypointCmdDepthMode(CompositeWaypointUUVCommandType cmd)` Returns the depth control mode (depth or altitude) of the CompositeWaypoint command
`static String`	`getCompositeWaypointCmdDescription(CompositeWaypointUUVCommandType cmd)` Sets the Wait command description field
`static int`	`getCompositeWaypointCmdGpsFixes(CompositeWaypointUUVCommandType cmd)` Returns the number of gps fixes value of the CompositeWaypoint command
`static int`	`getCompositeWaypointCmdProp(CompositeWaypointUUVCommandType cmd)` Returns an integer representing the commanded propeller (all, stbd, port, center)
`static double`	`getCompositeWaypointCmdPropSetting(CompositeWaypointUUVCommandType cmd)` Returns the commanded rpm
`static double`	`getCompositeWaypointCmdSpeed(CompositeWaypointUUVCommandType cmd)` Returns the speed commanded by the composite waypoint command in meters per second or knots (if specified)
`static int`	`getCompositeWaypointCmdSpeedType(CompositeWaypointUUVCommandType cmd)` Returns the enumeration for the type of speed ordered by the composite waypoint command (knots or mps)
`static double`	`getCompositeWaypointCmdStandoff(CompositeWaypointUUVCommandType cmd)` Returns the time out value of the CompositeWaypoint command
`static double`	`getCompositeWaypointCmdTimeOut(CompositeWaypointUUVCommandType cmd)` Returns the standoff value of the CompositeWaypoint command
`static int`	`getCompositeWaypointCmdType(CompositeWaypointUUVCommandType cmd)` Returns an integer representing the type of composite waypoint command of this object
`static double`	`getExpandingSquareCmdOrientation(CompositeWaypointUUVCommandType cmd)` Returns the orientation of the ExpandingSquare command
`static int`	`getExpandingSquareCmdPositType(CompositeWaypointUUVCommandType cmd)` Returns an integer representing how the horizontal point is represented
`static int`	`getExpandingSquareCmdTrackCount(CompositeWaypointUUVCommandType cmd)` Returns the track count of the ExpandingSquare command
`static double`	`getExpandingSquareCmdTrackSpacing(CompositeWaypointUUVCommandType cmd)` Returns the track spacing of the ExpandingSquare command
`static String`	`getExpandingSquareCmdTurnDirection(CompositeWaypointUUVCommandType cmd)` Returns the direction of the turns of the ExpandingSquare command
`static String`	`getExpandingSquareCmdX(CompositeWaypointUUVCommandType cmd)` Returns the x, latitude, or northing coordinate of the ExpandingSquare command
`static String`	`getExpandingSquareCmdY(CompositeWaypointUUVCommandType cmd)` Returns the y, longitude or easting coordinate of the ExpandingSquare command
`static String`	`getGpsFixCmdDescription(GpsFixCommandType cmd)` Returns the GpsFix command description field
`static boolean`	`getGpsFixCmdStartStopStatus(GpsFixCommandType cmd)` Returns an integer enumeration representing GpsFix status indicated by the command
`static double`	`getGpsFixCmdTimeOut(GpsFixCommandType cmd)` Returns the time out value of the GpsFix command
`static double`	`getHoverCmdDepth(HoverCommandType cmd)` Returns the depth (or altitude) of the Hover command
`static int`	`getHoverCmdDepthMode(HoverCommandType cmd)` Returns the depth control mode (depth or altitude) of the Hover command
`static String`	`getHoverCmdDescription(HoverCommandType cmd)` Returns the description field of the Hover command
`static boolean`	`getHoverCmdGps(HoverCommandType cmd)` Returns true if this Hover command is directing an en-route GPS fix
`static double`	`getHoverCmdHeading(HoverCommandType cmd)` Returns the heading of the Hover command
`static int`	`getHoverCmdPositType(HoverCommandType cmd)` Returns an integer representing how the horizontal point is represented
`static double`	`getHoverCmdStandoff(HoverCommandType cmd)` Returns the standoff of the Hover command
`static double`	`getHoverCmdTimeOut(HoverCommandType cmd)` Returns the time out time of the Hover command
`static String`	`getHoverCmdX(HoverCommandType cmd)` Returns the x, latitude, or northing coordinate of the Hover command
`static String`	`getHoverCmdY(HoverCommandType cmd)` Returns the y, longitude or easting coordinate of the Hover command
`static String`	`getLoiterCmdDescription(LoiterUUVCommandType cmd)` Returns the description field of the Loiter command
`static double`	`getLoiterCmdLoiterDepth(LoiterUUVCommandType cmd)` Returns the Loiter command loiter depth or altitude value as applicable
`static int`	`getLoiterCmdPositType(LoiterUUVCommandType cmd)` Returns an integer representing how the horizontal point is represented
`static double`	`getLoiterCmdPropellerSetting(LoiterUUVCommandType cmd)` Returns the commanded rpm
`static double`	`getLoiterCmdSpeed(LoiterUUVCommandType cmd)` Returns the speed commanded by the loiter command in meters per second or knots (if specified)
`static int`	`getLoiterCmdSpeedType(LoiterUUVCommandType cmd)` Returns the enumeration for the type of speed ordered by the loiter command (knots or mps)
`static double`	`getLoiterCmdTimeOut(LoiterUUVCommandType cmd)` Returns the time out value of the Loiter command
`static double`	`getLoiterCmdTransitDepth(LoiterUUVCommandType cmd)` Returns the Loiter transit depth or altitude value as applicable
`static int`	`getLoiterCmdTransitDepthMode(LoiterUUVCommandType cmd)` Returns an integer representing the commanded z-control mode (depth or altitude)
`static int`	`getLoiterCmdWhichPropeller(LoiterUUVCommandType cmd)` Returns an integer representing the commanded propeller (all, stbd, port, center)
`static String`	`getLoiterCmdX(LoiterUUVCommandType cmd)` Returns the Loiter command x, or latitude as applicable
`static String`	`getLoiterCmdY(LoiterUUVCommandType cmd)` Returns the Loiter command y, longitude, or easting value as applicable
`static String`	`getMakeAltitudeCmdDescription(NonNegativeScalarElementType cmd)` Returns the MakeAltitude command description field
`static double`	`getMakeAltitudeCmdSetting(NonNegativeScalarElementType cmd)` Returns the MakeAltitude commanded setting
`static String`	`getMakeDepthCmdDescription(NonNegativeScalarElementType cmd)` Returns the MakeDepth command description field
`static double`	`getMakeDepthCmdSetting(NonNegativeScalarElementType cmd)` Returns the MakeDepth commanded setting
`static String`	`getMoveLateralCmdDescription(SignedPercentElementType cmd)` Returns the MoveLateral command description field
`static double`	`getMoveLateralCmdSetting(SignedPercentElementType cmd)` Returns the MoveLateral commanded setting
`static String`	`getMoveRotateCmdDescription(JAXBElement cmd)` Returns the MoveRotate command description field
`static double`	`getMoveRotateCmdSetting(JAXBElement cmd)` Returns the MoveRotate commanded setting
`static String`	`getParallelTrackCmdFirstTurn(CompositeWaypointUUVCommandType cmd)` Returns the direction of the first turn of the ParallelTrack command
`static double`	`getParallelTrackCmdOrientation(CompositeWaypointUUVCommandType cmd)` Returns the orientation of the ParallelTrack command
`static int`	`getParallelTrackCmdPositType(CompositeWaypointUUVCommandType cmd)` Returns an integer representing how the horizontal point is represented
`static int`	`getParallelTrackCmdTrackCount(CompositeWaypointUUVCommandType cmd)` Returns the track count of the ParallelTrack command
`static double`	`getParallelTrackCmdTrackLength(CompositeWaypointUUVCommandType cmd)` Returns the track length of the ParallelTrack command
`static double`	`getParallelTrackCmdTrackSpacing(CompositeWaypointUUVCommandType cmd)` Returns the track spacing of the ParallelTrack command
`static String`	`getParallelTrackCmdX(CompositeWaypointUUVCommandType cmd)` Returns the x, latitude, or northing coordinate of the ParallelTrack command
`static String`	`getParallelTrackCmdY(CompositeWaypointUUVCommandType cmd)` Returns the y, longitude or easting coordinate of the ParallelTrack command
`static String`	`getRecoverCmdDescription(RecoverCommandType cmd)` Returns the description field of the Recover command
`static double`	`getRecoverCmdHeading(RecoverCommandType cmd)` Returns the heading of the Recover command
`static double`	`getRecoverCmdRange(RecoverCommandType cmd)` Returns the range of the Recover command
`static double`	`getRecoverCmdTimeOut(RecoverCommandType cmd)` Returns the time out time of the Recover command
`static double`	`getSectorPatternCmdOrientation(CompositeWaypointUUVCommandType cmd)` Returns the orientation of the ParallelTrack command
`static int`	`getSectorPatternCmdPositType(CompositeWaypointUUVCommandType cmd)` Returns an integer representing how the horizontal point is represented
`static double`	`getSectorPatternCmdRadius(CompositeWaypointUUVCommandType cmd)` Returns the radius of the SectorCommand command
`static int`	`getSectorPatternCmdSectorCount(CompositeWaypointUUVCommandType cmd)` Returns the sector count of the SectorPattern command
`static double`	`getSectorPatternCmdSectorSize(CompositeWaypointUUVCommandType cmd)` Returns the sector size of the SectorPattern command
`static String`	`getSectorPatternCmdTurnDirection(CompositeWaypointUUVCommandType cmd)` Returns the track length of the SectorPattern command
`static String`	`getSectorPatternCmdX(CompositeWaypointUUVCommandType cmd)` Returns the x, latitude, or northing coordinate of the SectorPattern command
`static String`	`getSectorPatternCmdY(CompositeWaypointUUVCommandType cmd)` Returns the y, longitude or easting coordinate of the SectorPattern command
`static String`	`getSetPlanesCmdDescription(SetPlanesCommandType cmd)` Returns the SetPlanes command description field
`static double`	`getSetPlanesCmdSetting(SetPlanesCommandType cmd)` Returns the SetPlanes speed setting
`static int`	`getSetPlanesCmdWhichPlanes(SetPlanesCommandType cmd)` Returns an integer enumeration representing SetPlanes commanded planes
`static double`	`getSetPositionCmdDepth(SetPositionUUVCommandType cmd)` Returns the depth field of the Position command
`static String`	`getSetPositionCmdDescription(SetPositionUUVCommandType cmd)` Returns the description field of the Position command
`static int`	`getSetPositionCmdPositionType(SetPositionUUVCommandType cmd)` Returns an integer representing how the horizontal point is represented
`static String`	`getSetPositionCmdX(SetPositionUUVCommandType cmd)` Returns the X, latitude, or northing field of a Position command as a String
`static String`	`getSetPositionCmdY(SetPositionUUVCommandType cmd)` Returns the Y, longitude, or easting field of a Position command as a String
`static double`	`getSetSonarCmdBearing(SetSonarCommandType cmd)` Returns the manual bearing of the SetSonar command
`static int`	`getSetSonarCmdBearingType(SetSonarCommandType cmd)` Returns an enumerated integer representing the bearing type of the SetSonar command
`static String`	`getSetSonarCmdDescription(SetSonarCommandType cmd)` Returns the description field of the Recover command
`static String`	`getSetSonarCmdModel(SetSonarCommandType cmd)` Returns the sonar model of the SetSonar command
`static int`	`getSetSonarCmdScan(SetSonarCommandType cmd)` Returns an enumerated integer representing the scan mode of the SetSonar command
`static String`	`getSetThrusterCmdDescription(SetThrusterCommandType cmd)` Returns the SetThruster command description field
`static double`	`getSetThrusterCmdSetting(SetThrusterCommandType cmd)` Returns the SetThruster thruster setting
`static int`	`getSetThrusterCmdThruster(SetThrusterCommandType cmd)` Returns an integer enumeration representing SetThruster commanded thruster
`static String`	`getTakeStationCmdDescription(TakeStationCommandType cmd)` Returns the description field of the TakeStation command
`static double`	`getTakeStationCmdHeading(TakeStationCommandType cmd)` Returns the heading of the TakeStation command
`static int`	`getTakeStationCmdSonarScan(TakeStationCommandType cmd)` Returns an enumerated value representing the type of sonar scan (target or edge) directed
`static double`	`getTakeStationCmdStationBearing(TakeStationCommandType cmd)` Returns the commanded station bearing
`static double`	`getTakeStationCmdStationRange(TakeStationCommandType cmd)` Returns the commanded station range
`static double`	`getTakeStationCmdTgtBearing(TakeStationCommandType cmd)` Returns the command-specified target bearing
`static double`	`getTakeStationCmdTgtRange(TakeStationCommandType cmd)` Returns the command-specified target range
`static double`	`getTakeStationCmdTimeOut(TakeStationCommandType cmd)` Returns the time out time of the TakeStation command
`static String`	`getThrustersCmdDescription(BooleanElementType cmd)` Returns the Thrusters command description field
`static boolean`	`getThrustersCmdEnabled(BooleanElementType cmd)` Returns true if Thrusters command enables body thrusters
`static double`	`getWaypointCmdDepth(WaypointUUVCommandType cmd)` Returns the Waypoint depth or altitude value as applicable
`static int`	`getWaypointCmdDepthMode(WaypointUUVCommandType cmd)` Returns an integer representing the commanded z-control mode (depth or altitude)
`static String`	`getWaypointCmdDescription(WaypointUUVCommandType cmd)` Returns the description field of the Waypoint command
`static boolean`	`getWaypointCmdGps(WaypointUUVCommandType cmd)` Returns true if this Waypoint command is directing an en-route GPS fix
`static int`	`getWaypointCmdPositionType(WaypointUUVCommandType cmd)` Returns an integer representing how the horizontal point is represented
`static int`	`getWaypointCmdProp(WaypointUUVCommandType cmd)` Returns an integer representing the commanded propeller (all, stbd, port, center)
`static double`	`getWaypointCmdPropSetting(WaypointUUVCommandType cmd)` Returns the commanded rpm (iff the waypoint uses open-loop speed control)
`static double`	`getWaypointCmdSpeed(WaypointUUVCommandType cmd)` Returns the speed commanded by the waypoint command in meters per second or knots (if specified)
`static int`	`getWaypointCmdSpeedType(WaypointUUVCommandType cmd)` Returns the enumeration for the type of speed ordered by the waypoint command (knots or mps)
`static double`	`getWaypointCmdStandoff(WaypointUUVCommandType cmd)` Returns the standoff value of the Waypoint command
`static double`	`getWaypointCmdTimeOut(WaypointUUVCommandType cmd)` Returns the time out value of the Waypoint command
`static String`	`getWaypointCmdTrackMode(WaypointUUVCommandType cmd)` Returns the tracking mode of the waypoint (to point or to line)
`static String`	`getWaypointCmdX(WaypointUUVCommandType cmd)` Returns the waypoint command x, latitude, or northing value as applicable
`static String`	`getWaypointCmdY(WaypointUUVCommandType cmd)` Returns the Waypoint command y, longitude, or easting value as applicable
`static void`	`setCompositeWaypointCmdDepth(CompositeWaypointUUVCommandType cmd, double newValue, int mode)` Sets the depth or altitude field of a CompositeWaypoint command as applicable
`static void`	`setCompositeWaypointCmdDescription(CompositeWaypointUUVCommandType cmd, String newValue)` Sets the description value of a CompositeWaypoint command
`static void`	`setCompositeWaypointCmdGps(CompositeWaypointUUVCommandType cmd, int newValue)` Sets the obtain gps field of a CompositeWaypoint command
`static void`	`setCompositeWaypointCmdKnots(CompositeWaypointUUVCommandType cmd, double newSpeed)` Sets the composite waypoint command ordered speed (knots)
`static void`	`setCompositeWaypointCmdProp(CompositeWaypointUUVCommandType cmd, double newValue, int whichProp)` Set a new commanded propeller RPM for a specified propeller for a CompositeWaypoint command
`static void`	`setCompositeWaypointCmdSpeed(CompositeWaypointUUVCommandType cmd, double newSpeed)` Sets the composite waypoint command ordered speed (meters per second)
`static void`	`setCompositeWaypointCmdStandoff(CompositeWaypointUUVCommandType cmd, double newValue)` Sets the standoff field of a CompositeWaypoint command
`static void`	`setCompositeWaypointCmdTimeOut(CompositeWaypointUUVCommandType cmd, double newValue)` Sets the time out field of a CompositeWaypoint command
`static void`	`setExpandingSquareCmdOrientation(CompositeWaypointUUVCommandType cmd, double newValue)` Sets the orientation of the ExpandingSquare command
`static void`	`setExpandingSquareCmdTrackCount(CompositeWaypointUUVCommandType cmd, int newValue)` Sets the track count of the ExpandingSquare command
`static void`	`setExpandingSquareCmdTrackSpacing(CompositeWaypointUUVCommandType cmd, double newValue)` Sets the track spacing of the ExpandingSquare command
`static void`	`setExpandingSquareCmdTurnDirection(CompositeWaypointUUVCommandType cmd, String newValue)` Sets the direction of the first turn of the ExpandingSquare command
`static void`	`setExpandingSquareCmdX(CompositeWaypointUUVCommandType cmd, double newValue, int mode)` Sets the x, latitude, or northing field of a ExpandingSquare command as applicable
`static void`	`setExpandingSquareCmdX(CompositeWaypointUUVCommandType cmd, String newValue, int mode)` Sets the x, latitude, or northing field of a ExpandingSquare command as applicable
`static void`	`setExpandingSquareCmdY(CompositeWaypointUUVCommandType cmd, double newValue, int mode)` Sets the y, longitude, or easting field of a ExpandingSquare command as applicable
`static void`	`setExpandingSquareCmdY(CompositeWaypointUUVCommandType cmd, String newValue, int mode)` Sets the y, longitude, or easting field of a ExpandingSquare command as applicable
`static void`	`setGpsFixCmdDescription(GpsFixCommandType cmd, String description)` Sets the GpsFix command description field
`static void`	`setGpsFixCmdStartStopStatus(GpsFixCommandType cmd, boolean status)` Sets the status to be commanded by this GpsFix command
`static void`	`setGpsFixCmdTimeOut(GpsFixCommandType cmd, double newValue)` Sets the time out time of the GpsFix command
`static void`	`setHoverCmdDepth(HoverCommandType cmd, double newValue, int mode)` Sets the depth (or altitude) coordinate of the Hover command
`static void`	`setHoverCmdDepthMode(HoverCommandType cmd, int mode, double value)` Returns the depth control mode (depth or altitude) of the Hover command
`static void`	`setHoverCmdDescription(HoverCommandType cmd, String newValue)` Sets the description value of a Hover command
`static void`	`setHoverCmdGps(HoverCommandType cmd, boolean newValue)` Sets the obtain gps field of a Hover command
`static void`	`setHoverCmdHeading(HoverCommandType cmd, double newValue)` Sets the heading of the Hover command
`static void`	`setHoverCmdStandoff(HoverCommandType cmd, double newValue)` Sets the standoff range of the Hover command
`static void`	`setHoverCmdTimeOut(HoverCommandType cmd, double newValue)` Sets the time out time of the Hover command
`static void`	`setHoverCmdX(HoverCommandType cmd, double newValue, int mode)` Sets the x, latitude, or northing coordinate of the Hover command
`static void`	`setHoverCmdX(HoverCommandType cmd, String newValue, int mode)` Sets the x, latitude, or northing coordinate of the Hover command
`static void`	`setHoverCmdY(HoverCommandType cmd, double newValue, int mode)` Sets the y, longitude, or northing coordinate of the Hover command
`static void`	`setHoverCmdY(HoverCommandType cmd, String newValue, int mode)` Sets the y, longitude, or northing coordinate of the Hover command
`static void`	`setLoiterCmdDescription(LoiterUUVCommandType cmd, String newValue)` Sets the description value of a Loiter command
`static void`	`setLoiterCmdKnots(LoiterUUVCommandType cmd, double newSpeed)` Sets the loiter command ordered speed (knots)
`static void`	`setLoiterCmdLoiterDepth(LoiterUUVCommandType cmd, double newValue)` Sets the depth or altitude field of a Loiter command as applicable
`static void`	`setLoiterCmdSpeed(LoiterUUVCommandType cmd, double newSpeed)` Sets the loiter command ordered speed (meters per second)
`static void`	`setLoiterCmdTimeOut(LoiterUUVCommandType cmd, double newValue)` Sets the time out field of a Loiter command
`static void`	`setLoiterCmdTransitDepth(LoiterUUVCommandType cmd, double newValue, int mode)` Sets the depth or altitude field of a Loiter command as applicable
`static void`	`setLoiterCmdTransitPower(LoiterUUVCommandType cmd, double newValue, int whichProp)` Set a new commanded propeller RPM for a specified propeller
`static void`	`setLoiterCmdX(LoiterUUVCommandType cmd, double newValue, int mode)` Sets the x, latitude, or northing field of a Loiter command as applicable
`static void`	`setLoiterCmdX(LoiterUUVCommandType cmd, String newValue, int mode)` Sets the x, latitude, or northing field of a Loiter command as applicable
`static void`	`setLoiterCmdY(LoiterUUVCommandType cmd, double newValue, int mode)` Sets the y, longitude, or easting field of a Loiter command as applicable
`static void`	`setLoiterCmdY(LoiterUUVCommandType cmd, String newValue, int mode)` Sets the y, longitude, or easting field of a Loiter command as applicable
`static void`	`setMakeAltitudeCmdDescription(NonNegativeScalarElementType cmd, String description)` Sets the MakeAltitude command description field
`static void`	`setMakeAltitudeCmdSetting(NonNegativeScalarElementType cmd, double setting)` Sets the MakeAltitude commanded setting
`static void`	`setMakeDepthCmdDescription(NonNegativeScalarElementType cmd, String description)` Sets the MakeDepth command description field
`static void`	`setMakeDepthCmdSetting(NonNegativeScalarElementType cmd, double setting)` Sets the MakeDepth commanded setting
`static void`	`setMoveLateralCmdDescription(SignedPercentElementType cmd, String description)` Sets the MoveLateral command description field
`static void`	`setMoveLateralCmdSetting(SignedPercentElementType cmd, double setting)` Sets the MoveLateral commanded setting
`static void`	`setMoveRotateCmdDescription(JAXBElement cmd, String description)` Sets the MoveRotate command description field
`static void`	`setMoveRotateCmdSetting(JAXBElement cmd, double setting)` Sets the MoveRotate commanded setting
`static void`	`setParallelTrackCmdFirstTurn(CompositeWaypointUUVCommandType cmd, String newValue)` Sets the direction of the first turn of the ParallelTrack command
`static void`	`setParallelTrackCmdOrientation(CompositeWaypointUUVCommandType cmd, double newValue)` Sets the orientation of the ParallelTrack command
`static void`	`setParallelTrackCmdTrackCount(CompositeWaypointUUVCommandType cmd, int newValue)` Sets the track count of the ParallelTrack command
`static void`	`setParallelTrackCmdTrackLength(CompositeWaypointUUVCommandType cmd, double newValue)` Sets the track length of the ParallelTrack command
`static void`	`setParallelTrackCmdTrackSpacing(CompositeWaypointUUVCommandType cmd, double newValue)` Sets the track spacing of the ParallelTrack command
`static void`	`setParallelTrackCmdX(CompositeWaypointUUVCommandType cmd, double newValue, int mode)` Sets the x, latitude, or northing field of a Waypoint command as applicable
`static void`	`setParallelTrackCmdX(CompositeWaypointUUVCommandType cmd, String newValue, int mode)` Sets the x, latitude, or northing field of a Waypoint command as applicable
`static void`	`setParallelTrackCmdY(CompositeWaypointUUVCommandType cmd, double newValue, int mode)` Sets the y, longitude, or easting field of a ParallelTrack command as applicable
`static void`	`setParallelTrackCmdY(CompositeWaypointUUVCommandType cmd, String newValue, int mode)` Sets the y, longitude, or easting field of a ParallelTrack command as applicable
`static void`	`setRecoverCmdDescription(RecoverCommandType cmd, String newValue)` Sets the description value of an Recover command
`static void`	`setRecoverCmdHeading(RecoverCommandType cmd, double newValue)` Sets the bearing value of the Recover command
`static void`	`setRecoverCmdRange(RecoverCommandType cmd, double newValue)` Sets the range value of the Recover command
`static void`	`setRecoverCmdTimeOut(RecoverCommandType cmd, double newValue)` Sets the time out time of the Recover command
`static void`	`setSectorPatternCmdOrientation(CompositeWaypointUUVCommandType cmd, double newValue)` Sets the orientation of the SectorPattern command
`static void`	`setSectorPatternCmdRadius(CompositeWaypointUUVCommandType cmd, double newValue)` Sets the track length of the SectorPattern command
`static void`	`setSectorPatternCmdSectorCount(CompositeWaypointUUVCommandType cmd, int newValue)` Sets the track count of the SectorPattern command
`static void`	`setSectorPatternCmdSectorSize(CompositeWaypointUUVCommandType cmd, double newValue)` Sets the track spacing of the SectorPattern command
`static void`	`setSectorPatternCmdTurnDirection(CompositeWaypointUUVCommandType cmd, String newValue)` Sets the track direction of the SectorPattern command
`static void`	`setSectorPatternCmdX(CompositeWaypointUUVCommandType cmd, double newValue, int mode)` Sets the x, latitude, or northing field of a SectorPattern starting position command as applicable
`static void`	`setSectorPatternCmdX(CompositeWaypointUUVCommandType cmd, String newValue, int mode)` Sets the x, latitude, or northing field of a SectorPattern starting position command as applicable
`static void`	`setSectorPatternCmdY(CompositeWaypointUUVCommandType cmd, double newValue, int mode)` Sets the y, longitude, or easting field of a SectorPattern command origin as applicable
`static void`	`setSectorPatternCmdY(CompositeWaypointUUVCommandType cmd, String newValue, int mode)` Sets the y, longitude, or easting field of a SectorPattern command origin as applicable
`static void`	`setSetPlanesCmdDescription(SetPlanesCommandType cmd, String description)` Sets the SetPlanes command description field
`static void`	`setSetPlanesCmdSetting(SetPlanesCommandType cmd, int which, double newValue)` Sets the planes to be commanded by this SetPlanes command
`static void`	`setSetPositionCmdDepth(SetPositionUUVCommandType cmd, double newValue)` Sets the depth value of a Position command
`static void`	`setSetPositionCmdDescription(SetPositionUUVCommandType cmd, String newValue)` Sets the description value of a Position command
`static void`	`setSetPositionCmdX(SetPositionUUVCommandType cmd, double newValue)` Sets the X, latitude, or northing field of a Position command
`static void`	`setSetPositionCmdX(SetPositionUUVCommandType cmd, String newValue)` Sets the X, latitude, or northing field of a Position command
`static void`	`setSetPositionCmdY(SetPositionUUVCommandType cmd, double newValue)` Sets the Y, longitude, or easting field of a Position command
`static void`	`setSetPositionCmdY(SetPositionUUVCommandType cmd, String newValue)` Sets the Y, longitude, or easting field of a Position command
`static void`	`setSetSonarCmdBearing(SetSonarCommandType cmd, double newValue)` Sets the SetSonar commanded bearing field
`static void`	`setSetSonarCmdBearingType(SetSonarCommandType cmd, int newType)` Sets the SetSonar command bearing type field
`static void`	`setSetSonarCmdDescription(SetSonarCommandType cmd, String newValue)` Sets the description value of a SetSonar command
`static void`	`setSetSonarCmdModel(SetSonarCommandType cmd, String sonarModel)` Sets the SetSonar command sonar model field
`static void`	`setSetSonarCmdScan(SetSonarCommandType cmd, int newScan)` Sets the SetSonar command scan-type field
`static void`	`setSetThrusterCmdDescription(SetThrusterCommandType cmd, String description)` Sets the SetThruster command description field
`static void`	`setSetThrusterCmdSetting(SetThrusterCommandType cmd, int which, double newValue)` Sets the thruster to be commanded by this SetThruster command
`static void`	`setTakeStationCmdDescription(TakeStationCommandType cmd, String newValue)` Sets the description value of a TakeStation command
`static void`	`setTakeStationCmdHeading(TakeStationCommandType cmd, double newValue)` Sets the heading of the TakeStation command
`static void`	`setTakeStationCmdSonarScan(TakeStationCommandType cmd, int mode)` Sets the sonar scan mode (target or edge) of the TakeStation command
`static void`	`setTakeStationCmdStation(TakeStationCommandType cmd, double bearing, double range)` Sets the commanded station of the TakeStation command
`static void`	`setTakeStationCmdTgtLocation(TakeStationCommandType cmd, double bearing, double range)` Sets the target location of the TakeStation command
`static void`	`setTakeStationCmdTimeOut(TakeStationCommandType cmd, double newValue)` Sets the time out time of the TakeStation command
`static void`	`setThrustersCmdDescription(BooleanElementType cmd, String description)` Sets the Thrusters command description
`static void`	`setThrustersCmdEnabled(BooleanElementType cmd, boolean enabled)` Sets the Thrusters command enabled field
`static void`	`setWaypointCmdDepth(WaypointUUVCommandType cmd, double newValue, int mode)` Sets the depth or altitude field of a Waypoint command as applicable
`static void`	`setWaypointCmdDescription(WaypointUUVCommandType cmd, String newValue)` Sets the description value of a Waypoint command
`static void`	`setWaypointCmdGps(WaypointUUVCommandType cmd, boolean newValue)` Sets the obtain gps field of a Waypoint command
`static void`	`setWaypointCmdId(WaypointUUVCommandType cmd, String newValue)` Sets the id value of a Waypoint command
`static void`	`setWaypointCmdKnots(WaypointUUVCommandType cmd, double newSpeed)` Sets the waypoint command ordered speed (knots)
`static void`	`setWaypointCmdProp(WaypointUUVCommandType cmd, double newValue, int whichProp)` Set a new commanded propeller RPM for a specified propeller
`static void`	`setWaypointCmdSpeed(WaypointUUVCommandType cmd, double newSpeed)` Sets the waypoint command ordered speed (meters per second)
`static void`	`setWaypointCmdStandoff(WaypointUUVCommandType cmd, double newValue)` Sets the standoff field of a Waypoint command
`static void`	`setWaypointCmdTimeOut(WaypointUUVCommandType cmd, double newValue)` Sets the time out field of a Waypoint command
`static void`	`setWaypointCmdTrackMode(WaypointUUVCommandType cmd, String newValue)` Returns the tracking mode of the waypoint (to point or to line)
`static void`	`setWaypointCmdX(WaypointUUVCommandType cmd, double newValue, int mode)` Sets the x, latitude, or northing field of a Waypoint command as applicable
`static void`	`setWaypointCmdX(WaypointUUVCommandType cmd, String newValue, int mode)` Sets the x, latitude, or northing field of a Waypoint command as applicable
`static void`	`setWaypointCmdY(WaypointUUVCommandType cmd, double newValue, int mode)` Sets the y, longitude, or easting field of a Waypoint command as applicable
`static void`	`setWaypointCmdY(WaypointUUVCommandType cmd, String newValue, int mode)` Sets the y, longitude, or easting field of a Waypoint command as applicable

Methods inherited from class avcl.AvclScriptCommands
createFollowBeaconCmd, createHelpCmd, createMakeHeadingCmd, createMakeKnotsCmd, createMakeSpeedCmd, createMetaCommand, createMissionScriptCmd, createMissionScriptInlineCmd, createQuitCmd, createRealtimeCmd, createSendMessageCmd, createSetPowerCmd, createSetPowerCmd, createSetRudderCmd, createSetStandoffCmd, createSetTimeCmd, createSetTimeStepCmd, createTraceCmd, createWaitCommand, createWaitUntilTimeCmd, getFollowBeaconCmdBeacon, getFollowBeaconCmdDescription, getFollowBeaconCmdTimeOut, getHelpCmdDescription, getMakeHeadingCmdDescription, getMakeHeadingCmdSetting, getMakeKnotsCmdDescription, getMakeKnotsCmdSetting, getMakeKnotsCmdSpeedOverGround, getMakeSpeedCmdDescription, getMakeSpeedCmdSetting, getMakeSpeedCmdSpeedOverGround, getMetaCommandContent, getMetaCommandDescription, getMetaCommandName, getMissionScriptCmdDescription, getMissionScriptCmdPath, getMissionScriptInlineCmdDescription, getMissionScriptInlineCmdPath, getQuitCmdDescription, getRealtimeCmdDescription, getRealtimeCmdSetting, getSendMessageCmdContent, getSendMessageCmdDescription, getSetPowerCmdDescription, getSetPowerCmdPropeller, getSetPowerCmdSetting, getSetRudderCmdDescription, getSetRudderCmdSetting, getSetStandoffCmdDescription, getSetStandoffCmdSetting, getSetTimeCmdDescription, getSetTimeCmdSetting, getSetTimeStepCmdDescription, getSetTimeStepCmdSetting, getTraceCmdDescription, getTraceCmdSetting, getWaitCmdDescription, getWaitCommandSetting, getWaitUntilTimeCmdDescription, getWaitUntilTimeCmdSetting, noValueFilter, noValueFilter, setFollowBeaconCmdBeacon, setFollowBeaconCmdDescription, setFollowBeaconCmdTimeOut, setHelpCmdDescription, setMakeHeadingCmdDescription, setMakeHeadingCmdSetting, setMakeKnotsCmdDescription, setMakeKnotsCmdSetting, setMakeKnotsCmdSpeedOverGround, setMakeSpeedCmdDescription, setMakeSpeedCmdSetting, setMakeSpeedCmdSpeedOverGround, setMetaCommandContent, setMetaCommandDescription, setMetaCommandName, setMissionScriptCmdDescription, setMissionScriptCmdPath, setMissionScriptInlineCmdDescription, setMissionScriptInlineCmdPath, setMoveRotateCmdDescription, setMoveRotateCmdSetting, setQuitCmdDescription, setRealtimeCmdDescription, setRealtimeCmdSetting, setSendMessageCmdContent, setSendMessageCmdDescription, setSetPowerCmdDescription, setSetPowerCmdSetting, setSetRudderCmdDescription, setSetRudderCmdSetting, setSetStandoffCmdDescription, setSetStandoffCmdSetting, setSetTimeCmdDescription, setSetTimeCmdSetting, setSetTimeStepCmdDescription, setSetTimeStepCmdSetting, setTraceCmdDescription, setTraceCmdSetting, setWaitCmdDescription, setWaitCmdSetting, setWaitUntilTimeCmdDescription, setWaitUntilTimeCmdSetting, valueOrEmptyString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- UuvScriptCommands
```
public UuvScriptCommands()
```

Method Detail

getCompositeWaypointCmdType
```
public static int getCompositeWaypointCmdType(CompositeWaypointUUVCommandType cmd)
```
Returns an integer representing the type of composite waypoint command of this object

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.PARALLELTRACK, AvclMission.EXPANDINGSQUARE, AvclMission.SECTORPATTERN or AvclMission.WAYPOINTLIST

getCompositeWaypointCmdDepth
```
public static double getCompositeWaypointCmdDepth(CompositeWaypointUUVCommandType cmd)
```
Returns the depth (or altitude) of the CompositeWaypoint command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getCompositeWaypointCmdDepthMode
```
public static int getCompositeWaypointCmdDepthMode(CompositeWaypointUUVCommandType cmd)
```
Returns the depth control mode (depth or altitude) of the CompositeWaypoint command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.DEPTHCONTROL or AvclMission.ALTITUDECONTROL

getCompositeWaypointCmdProp
```
public static int getCompositeWaypointCmdProp(CompositeWaypointUUVCommandType cmd)
```
Returns an integer representing the commanded propeller (all, stbd, port, center)

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.ALLPROPELLERS, AvclMission.STBDPROPELLER, AvclMission.PORTPROPELLER or AvclMission.CENTERPROPELLER

getCompositeWaypointCmdPropSetting
```
public static double getCompositeWaypointCmdPropSetting(CompositeWaypointUUVCommandType cmd)
```
Returns the commanded rpm

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getCompositeWaypointCmdSpeedType
```
public static int getCompositeWaypointCmdSpeedType(CompositeWaypointUUVCommandType cmd)
```
Returns the enumeration for the type of speed ordered by the composite waypoint command (knots or mps)

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.KNOTS, AvclMission.METERSPERSECOND or AvclMission.NOVALUE

getCompositeWaypointCmdSpeed
```
public static double getCompositeWaypointCmdSpeed(CompositeWaypointUUVCommandType cmd)
```
Returns the speed commanded by the composite waypoint command in meters per second or knots (if specified)

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getCompositeWaypointCmdDescription
```
public static String getCompositeWaypointCmdDescription(CompositeWaypointUUVCommandType cmd)
```
Sets the Wait command description field

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

getCompositeWaypointCmdGpsFixes
```
public static int getCompositeWaypointCmdGpsFixes(CompositeWaypointUUVCommandType cmd)
```
Returns the number of gps fixes value of the CompositeWaypoint command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getCompositeWaypointCmdStandoff
```
public static double getCompositeWaypointCmdStandoff(CompositeWaypointUUVCommandType cmd)
```
Returns the time out value of the CompositeWaypoint command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getCompositeWaypointCmdTimeOut
```
public static double getCompositeWaypointCmdTimeOut(CompositeWaypointUUVCommandType cmd)
```
Returns the standoff value of the CompositeWaypoint command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

setCompositeWaypointCmdDescription

public static void setCompositeWaypointCmdDescription(CompositeWaypointUUVCommandType cmd,
                                                      String newValue)

Sets the description value of a CompositeWaypoint command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setCompositeWaypointCmdDepth
```
public static void setCompositeWaypointCmdDepth(CompositeWaypointUUVCommandType cmd,
                                                double newValue,
                                                int mode)
```
Sets the depth or altitude field of a CompositeWaypoint command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.DEPTHCONTROL, AvclMission.ALTITUDECONTROL or AvclMission.DEFAULTZCONTROL

clearCompositeWaypointCmdSpeed
```
public static void clearCompositeWaypointCmdSpeed(CompositeWaypointUUVCommandType cmd)
```
Clears the composite waypoint command's speed-related elements

Parameters:

cmd - AvclScriptCommands command of interest

setCompositeWaypointCmdProp
```
public static void setCompositeWaypointCmdProp(CompositeWaypointUUVCommandType cmd,
                                               double newValue,
                                               int whichProp)
```
Set a new commanded propeller RPM for a specified propeller for a CompositeWaypoint command

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

whichProp - AvclMission.ALLPROPELLERS, AvclMission.STBDPROPELLER, AvclMission.PORTPROPELLER or AvclMission.CENTERPROPELLER

setCompositeWaypointCmdSpeed
```
public static void setCompositeWaypointCmdSpeed(CompositeWaypointUUVCommandType cmd,
                                                double newSpeed)
```
Sets the composite waypoint command ordered speed (meters per second)

Parameters:

cmd - AvclScriptCommands command of interest

newSpeed -

setCompositeWaypointCmdKnots

public static void setCompositeWaypointCmdKnots(CompositeWaypointUUVCommandType cmd,
                                                double newSpeed)

Sets the composite waypoint command ordered speed (knots)

Parameters:: cmd - AvclScriptCommands command of interest; newSpeed -

setCompositeWaypointCmdGps

public static void setCompositeWaypointCmdGps(CompositeWaypointUUVCommandType cmd,
                                              int newValue)

Sets the obtain gps field of a CompositeWaypoint command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setCompositeWaypointCmdStandoff

public static void setCompositeWaypointCmdStandoff(CompositeWaypointUUVCommandType cmd,
                                                   double newValue)

Sets the standoff field of a CompositeWaypoint command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setCompositeWaypointCmdTimeOut

public static void setCompositeWaypointCmdTimeOut(CompositeWaypointUUVCommandType cmd,
                                                  double newValue)

Sets the time out field of a CompositeWaypoint command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

createExpandingSquareCmd

public static CompositeWaypointUUVCommandType createExpandingSquareCmd(int positionMode,
                                                                       double x,
                                                                       double y,
                                                                       double orientation,
                                                                       double trackSpacing,
                                                                       int trackCount,
                                                                       String turnDirection,
                                                                       int depthMode,
                                                                       double depth,
                                                                       int whichProp,
                                                                       double propSetting,
                                                                       int gpsFixes,
                                                                       double standoff,
                                                                       double timeOut,
                                                                       String description)

Generates a ExpandingSquare composite waypoint command

Parameters:: positionMode -; description - defines intent for this AVCL command; x -; trackCount -; trackSpacing -; y -; timeOut -; orientation -; whichProp -; depth -; turnDirection - AvclMission.PORT, AvclMission.STARBOARD, AvclMission.LEFT or AvclMission.RIGHT; depthMode -; gpsFixes -; standoff -; propSetting -
Returns:: CompositeWaypointUUVCommandType

createExpandingSquareCmd

public static CompositeWaypointUUVCommandType createExpandingSquareCmd(int positionMode,
                                                                       String x,
                                                                       String y,
                                                                       double orientation,
                                                                       double trackSpacing,
                                                                       int trackCount,
                                                                       String turnDirection,
                                                                       int depthMode,
                                                                       double depth,
                                                                       int whichProp,
                                                                       double propSetting,
                                                                       int gpsFixes,
                                                                       double standoff,
                                                                       double timeOut,
                                                                       String description)

Generates a ExpandingSquare composite waypoint command

Parameters:: positionMode -; x -; y -; turnDirection - AvclMission.PORT, AvclMission.STARBOARD, AvclMission.LEFT or AvclMission.RIGHT; orientation -; trackCount -; timeOut -; whichProp -; depth -; propSetting -; trackSpacing -; gpsFixes -; depthMode -; description - defines intent for this AVCL command; standoff -
Returns:: CompositeWaypointUUVCommandType

getExpandingSquareCmdPositType
```
public static int getExpandingSquareCmdPositType(CompositeWaypointUUVCommandType cmd)
```
Returns an integer representing how the horizontal point is represented

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

getExpandingSquareCmdX
```
public static String getExpandingSquareCmdX(CompositeWaypointUUVCommandType cmd)
```
Returns the x, latitude, or northing coordinate of the ExpandingSquare command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getExpandingSquareCmdY
```
public static String getExpandingSquareCmdY(CompositeWaypointUUVCommandType cmd)
```
Returns the y, longitude or easting coordinate of the ExpandingSquare command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getExpandingSquareCmdTrackSpacing
```
public static double getExpandingSquareCmdTrackSpacing(CompositeWaypointUUVCommandType cmd)
```
Returns the track spacing of the ExpandingSquare command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getExpandingSquareCmdTrackCount
```
public static int getExpandingSquareCmdTrackCount(CompositeWaypointUUVCommandType cmd)
```
Returns the track count of the ExpandingSquare command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getExpandingSquareCmdOrientation
```
public static double getExpandingSquareCmdOrientation(CompositeWaypointUUVCommandType cmd)
```
Returns the orientation of the ExpandingSquare command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getExpandingSquareCmdTurnDirection
```
public static String getExpandingSquareCmdTurnDirection(CompositeWaypointUUVCommandType cmd)
```
Returns the direction of the turns of the ExpandingSquare command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.PORT, AvclMission.STARBOARD, AvclMission.LEFT or AvclMission.RIGHT

setExpandingSquareCmdX
```
public static void setExpandingSquareCmdX(CompositeWaypointUUVCommandType cmd,
                                          double newValue,
                                          int mode)
```
Sets the x, latitude, or northing field of a ExpandingSquare command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setExpandingSquareCmdX
```
public static void setExpandingSquareCmdX(CompositeWaypointUUVCommandType cmd,
                                          String newValue,
                                          int mode)
```
Sets the x, latitude, or northing field of a ExpandingSquare command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

newValue -

setExpandingSquareCmdY
```
public static void setExpandingSquareCmdY(CompositeWaypointUUVCommandType cmd,
                                          double newValue,
                                          int mode)
```
Sets the y, longitude, or easting field of a ExpandingSquare command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setExpandingSquareCmdY
```
public static void setExpandingSquareCmdY(CompositeWaypointUUVCommandType cmd,
                                          String newValue,
                                          int mode)
```
Sets the y, longitude, or easting field of a ExpandingSquare command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setExpandingSquareCmdTrackSpacing

public static void setExpandingSquareCmdTrackSpacing(CompositeWaypointUUVCommandType cmd,
                                                     double newValue)

Sets the track spacing of the ExpandingSquare command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setExpandingSquareCmdTrackCount

public static void setExpandingSquareCmdTrackCount(CompositeWaypointUUVCommandType cmd,
                                                   int newValue)

Sets the track count of the ExpandingSquare command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setExpandingSquareCmdOrientation

public static void setExpandingSquareCmdOrientation(CompositeWaypointUUVCommandType cmd,
                                                    double newValue)

Sets the orientation of the ExpandingSquare command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setExpandingSquareCmdTurnDirection
```
public static void setExpandingSquareCmdTurnDirection(CompositeWaypointUUVCommandType cmd,
                                                      String newValue)
```
Sets the direction of the first turn of the ExpandingSquare command

Parameters:

cmd - AvclScriptCommands command of interest

newValue - AvclMission.PORT, AvclMission.STARBOARD, AvclMission.LEFT or AvclMission.RIGHT

createGpsFixCmd

public static JAXBElement<GpsFixCommandType> createGpsFixCmd(boolean start,
                                                             double timeOut,
                                                             String description)

Generates a GpsFix command

Parameters:: start -; timeOut -; description - defines intent for this AVCL command
Returns:: JAXBElement

getGpsFixCmdStartStopStatus
```
public static boolean getGpsFixCmdStartStopStatus(GpsFixCommandType cmd)
```
Returns an integer enumeration representing GpsFix status indicated by the command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

whether starting (true) or stopping (false)

getGpsFixCmdTimeOut
```
public static double getGpsFixCmdTimeOut(GpsFixCommandType cmd)
```
Returns the time out value of the GpsFix command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getGpsFixCmdDescription
```
public static String getGpsFixCmdDescription(GpsFixCommandType cmd)
```
Returns the GpsFix command description field

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setGpsFixCmdStartStopStatus
```
public static void setGpsFixCmdStartStopStatus(GpsFixCommandType cmd,
                                               boolean status)
```
Sets the status to be commanded by this GpsFix command

Parameters:

cmd - AvclScriptCommands command of interest

status -

setGpsFixCmdTimeOut
```
public static void setGpsFixCmdTimeOut(GpsFixCommandType cmd,
                                       double newValue)
```
Sets the time out time of the GpsFix command

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

setGpsFixCmdDescription

public static void setGpsFixCmdDescription(GpsFixCommandType cmd,
                                           String description)

Sets the GpsFix command description field

Parameters:: cmd - AvclScriptCommands command of interest; description - defines intent for this AVCL command

createHoverCmd

public static HoverCommandType createHoverCmd(double x,
                                              double y,
                                              int positMode,
                                              double z,
                                              int depthMode,
                                              double heading,
                                              double standoff,
                                              double timeOut,
                                              String description)

Generates a Hover command

Parameters:: x -; heading -; y -; z -; depthMode -; positMode -; timeOut -; standoff -; description - defines intent for this AVCL command
Returns:: HoverCommandType

createHoverCmd

public static HoverCommandType createHoverCmd(String x,
                                              String y,
                                              int positMode,
                                              double z,
                                              int depthMode,
                                              double heading,
                                              double standoff,
                                              double timeOut,
                                              String description)

Generates a Hover command

Parameters:: x -; y -; positMode -; z -; description - defines intent for this AVCL command; standoff -; heading -; depthMode -; timeOut -
Returns:: HoverCommandType

getHoverCmdX
```
public static String getHoverCmdX(HoverCommandType cmd)
```
Returns the x, latitude, or northing coordinate of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getHoverCmdY
```
public static String getHoverCmdY(HoverCommandType cmd)
```
Returns the y, longitude or easting coordinate of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getHoverCmdPositType
```
public static int getHoverCmdPositType(HoverCommandType cmd)
```
Returns an integer representing how the horizontal point is represented

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

getHoverCmdDepth
```
public static double getHoverCmdDepth(HoverCommandType cmd)
```
Returns the depth (or altitude) of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getHoverCmdDepthMode
```
public static int getHoverCmdDepthMode(HoverCommandType cmd)
```
Returns the depth control mode (depth or altitude) of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.DEPTHCONTROL or AvclMission.ALTITUDECONTROL

getHoverCmdHeading
```
public static double getHoverCmdHeading(HoverCommandType cmd)
```
Returns the heading of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getHoverCmdStandoff
```
public static double getHoverCmdStandoff(HoverCommandType cmd)
```
Returns the standoff of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getHoverCmdGps
```
public static boolean getHoverCmdGps(HoverCommandType cmd)
```
Returns true if this Hover command is directing an en-route GPS fix

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

whether task of getting a GPS fix is enabled or not

getHoverCmdTimeOut
```
public static double getHoverCmdTimeOut(HoverCommandType cmd)
```
Returns the time out time of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getHoverCmdDescription
```
public static String getHoverCmdDescription(HoverCommandType cmd)
```
Returns the description field of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setHoverCmdDepthMode
```
public static void setHoverCmdDepthMode(HoverCommandType cmd,
                                        int mode,
                                        double value)
```
Returns the depth control mode (depth or altitude) of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

value -

mode - AvclMission.DEPTHCONTROL, AvclMission.ALTITUDECONTROL or AvclMission.DEFAULTZCONTROL

setHoverCmdX
```
public static void setHoverCmdX(HoverCommandType cmd,
                                double newValue,
                                int mode)
```
Sets the x, latitude, or northing coordinate of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

newValue -

setHoverCmdX
```
public static void setHoverCmdX(HoverCommandType cmd,
                                String newValue,
                                int mode)
```
Sets the x, latitude, or northing coordinate of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setHoverCmdY
```
public static void setHoverCmdY(HoverCommandType cmd,
                                double newValue,
                                int mode)
```
Sets the y, longitude, or northing coordinate of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setHoverCmdY
```
public static void setHoverCmdY(HoverCommandType cmd,
                                String newValue,
                                int mode)
```
Sets the y, longitude, or northing coordinate of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setHoverCmdDepth
```
public static void setHoverCmdDepth(HoverCommandType cmd,
                                    double newValue,
                                    int mode)
```
Sets the depth (or altitude) coordinate of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.DEPTHCONTROL, AvclMission.ALTITUDECONTROL or AvclMission.DEFAULTZCONTROL

setHoverCmdHeading

public static void setHoverCmdHeading(HoverCommandType cmd,
                                      double newValue)

Sets the heading of the Hover command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setHoverCmdGps
```
public static void setHoverCmdGps(HoverCommandType cmd,
                                  boolean newValue)
```
Sets the obtain gps field of a Hover command

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

setHoverCmdStandoff
```
public static void setHoverCmdStandoff(HoverCommandType cmd,
                                       double newValue)
```
Sets the standoff range of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

setHoverCmdTimeOut
```
public static void setHoverCmdTimeOut(HoverCommandType cmd,
                                      double newValue)
```
Sets the time out time of the Hover command

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

setHoverCmdDescription

public static void setHoverCmdDescription(HoverCommandType cmd,
                                          String newValue)

Sets the description value of a Hover command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

createLoiterCmd

public static JAXBElement<LoiterUUVCommandType> createLoiterCmd(double x,
                                                                double y,
                                                                int positMode,
                                                                int whichPropeller,
                                                                double propeller,
                                                                double transitZ,
                                                                int depthMode,
                                                                double loiterZ,
                                                                double timeOut,
                                                                String description)

Generates a Loiter command

Parameters:: x -; y -; positMode -; transitZ -; description - defines intent for this AVCL command; whichPropeller -; propeller -; depthMode -; loiterZ -; timeOut -
Returns:: JAXBElement

createLoiterCmd

public static LoiterUUVCommandType createLoiterCmd(String x,
                                                   String y,
                                                   int positMode,
                                                   int whichPropeller,
                                                   double propeller,
                                                   double transitZ,
                                                   int depthMode,
                                                   double loiterZ,
                                                   double timeOut,
                                                   String description)

Generates a Loiter command

Parameters:: x -; y -; positMode -; whichPropeller -; description - defines intent for this AVCL command; timeOut -; transitZ -; propeller -; depthMode -; loiterZ -
Returns:: LoiterUUVCommandType

getLoiterCmdX
```
public static String getLoiterCmdX(LoiterUUVCommandType cmd)
```
Returns the Loiter command x, or latitude as applicable

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getLoiterCmdY
```
public static String getLoiterCmdY(LoiterUUVCommandType cmd)
```
Returns the Loiter command y, longitude, or easting value as applicable

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getLoiterCmdPositType
```
public static int getLoiterCmdPositType(LoiterUUVCommandType cmd)
```
Returns an integer representing how the horizontal point is represented

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

getLoiterCmdWhichPropeller
```
public static int getLoiterCmdWhichPropeller(LoiterUUVCommandType cmd)
```
Returns an integer representing the commanded propeller (all, stbd, port, center)

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.ALLPROPELLERS, AvclMission.STBDPROPELLER, AvclMission.PORTPROPELLER or AvclMission.CENTERPROPELLER

getLoiterCmdPropellerSetting
```
public static double getLoiterCmdPropellerSetting(LoiterUUVCommandType cmd)
```
Returns the commanded rpm

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getLoiterCmdSpeedType
```
public static int getLoiterCmdSpeedType(LoiterUUVCommandType cmd)
```
Returns the enumeration for the type of speed ordered by the loiter command (knots or mps)

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.KNOTS, AvclMission.METERSPERSECOND or AvclMission.NOVALUE

getLoiterCmdSpeed
```
public static double getLoiterCmdSpeed(LoiterUUVCommandType cmd)
```
Returns the speed commanded by the loiter command in meters per second or knots (if specified)

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getLoiterCmdTransitDepth
```
public static double getLoiterCmdTransitDepth(LoiterUUVCommandType cmd)
```
Returns the Loiter transit depth or altitude value as applicable

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getLoiterCmdLoiterDepth
```
public static double getLoiterCmdLoiterDepth(LoiterUUVCommandType cmd)
```
Returns the Loiter command loiter depth or altitude value as applicable

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getLoiterCmdTransitDepthMode
```
public static int getLoiterCmdTransitDepthMode(LoiterUUVCommandType cmd)
```
Returns an integer representing the commanded z-control mode (depth or altitude)

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.DEPTHCONTROL or AvclMission.ALTITUDECONTROL

getLoiterCmdTimeOut
```
public static double getLoiterCmdTimeOut(LoiterUUVCommandType cmd)
```
Returns the time out value of the Loiter command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getLoiterCmdDescription
```
public static String getLoiterCmdDescription(LoiterUUVCommandType cmd)
```
Returns the description field of the Loiter command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setLoiterCmdX
```
public static void setLoiterCmdX(LoiterUUVCommandType cmd,
                                 double newValue,
                                 int mode)
```
Sets the x, latitude, or northing field of a Loiter command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setLoiterCmdX
```
public static void setLoiterCmdX(LoiterUUVCommandType cmd,
                                 String newValue,
                                 int mode)
```
Sets the x, latitude, or northing field of a Loiter command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setLoiterCmdY
```
public static void setLoiterCmdY(LoiterUUVCommandType cmd,
                                 double newValue,
                                 int mode)
```
Sets the y, longitude, or easting field of a Loiter command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setLoiterCmdY
```
public static void setLoiterCmdY(LoiterUUVCommandType cmd,
                                 String newValue,
                                 int mode)
```
Sets the y, longitude, or easting field of a Loiter command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

clearLoiterCmdSpeed
```
public static void clearLoiterCmdSpeed(LoiterUUVCommandType cmd)
```
Clears all speed elements of a loiter command

Parameters:

cmd - AvclScriptCommands command of interest

setLoiterCmdTransitPower
```
public static void setLoiterCmdTransitPower(LoiterUUVCommandType cmd,
                                            double newValue,
                                            int whichProp)
```
Set a new commanded propeller RPM for a specified propeller

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

whichProp - AvclMission.ALLPROPELLERS, AvclMission.STBDPROPELLER, AvclMission.PORTPROPELLER or AvclMission.CENTERPROPELLER

setLoiterCmdSpeed
```
public static void setLoiterCmdSpeed(LoiterUUVCommandType cmd,
                                     double newSpeed)
```
Sets the loiter command ordered speed (meters per second)

Parameters:

cmd - AvclScriptCommands command of interest

newSpeed -

setLoiterCmdKnots
```
public static void setLoiterCmdKnots(LoiterUUVCommandType cmd,
                                     double newSpeed)
```
Sets the loiter command ordered speed (knots)

Parameters:

cmd - AvclScriptCommands command of interest

newSpeed -

setLoiterCmdTransitDepth
```
public static void setLoiterCmdTransitDepth(LoiterUUVCommandType cmd,
                                            double newValue,
                                            int mode)
```
Sets the depth or altitude field of a Loiter command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.DEPTHCONTROL, AvclMission.ALTITUDECONTROL or AvclMission.DEFAULTZCONTROL

setLoiterCmdLoiterDepth
```
public static void setLoiterCmdLoiterDepth(LoiterUUVCommandType cmd,
                                           double newValue)
```
Sets the depth or altitude field of a Loiter command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

setLoiterCmdTimeOut

public static void setLoiterCmdTimeOut(LoiterUUVCommandType cmd,
                                       double newValue)

Sets the time out field of a Loiter command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setLoiterCmdDescription

public static void setLoiterCmdDescription(LoiterUUVCommandType cmd,
                                           String newValue)

Sets the description value of a Loiter command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

createMakeAltitudeCmd

public static JAXBElement<NonNegativeScalarElementType> createMakeAltitudeCmd(double setting,
                                                                              String description)

Generates a MakeAltitude command

Parameters:: setting -; description - defines intent for this AVCL command
Returns:: JAXBElement

getMakeAltitudeCmdSetting
```
public static double getMakeAltitudeCmdSetting(NonNegativeScalarElementType cmd)
```
Returns the MakeAltitude commanded setting

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getMakeAltitudeCmdDescription
```
public static String getMakeAltitudeCmdDescription(NonNegativeScalarElementType cmd)
```
Returns the MakeAltitude command description field

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setMakeAltitudeCmdSetting

public static void setMakeAltitudeCmdSetting(NonNegativeScalarElementType cmd,
                                             double setting)

Sets the MakeAltitude commanded setting

Parameters:: cmd - AvclScriptCommands command of interest; setting -

setMakeAltitudeCmdDescription

public static void setMakeAltitudeCmdDescription(NonNegativeScalarElementType cmd,
                                                 String description)

Sets the MakeAltitude command description field

Parameters:: cmd - AvclScriptCommands command of interest; description - defines intent for this AVCL command

createMakeDepthCmd

public static JAXBElement<NonNegativeScalarElementType> createMakeDepthCmd(double setting,
                                                                           String description)

Generates a MakeDepth command

Parameters:: setting -; description - defines intent for this AVCL command
Returns:: JAXBElement

getMakeDepthCmdSetting
```
public static double getMakeDepthCmdSetting(NonNegativeScalarElementType cmd)
```
Returns the MakeDepth commanded setting

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getMakeDepthCmdDescription
```
public static String getMakeDepthCmdDescription(NonNegativeScalarElementType cmd)
```
Returns the MakeDepth command description field

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setMakeDepthCmdSetting

public static void setMakeDepthCmdSetting(NonNegativeScalarElementType cmd,
                                          double setting)

Sets the MakeDepth commanded setting

Parameters:: cmd - AvclScriptCommands command of interest; setting -

setMakeDepthCmdDescription

public static void setMakeDepthCmdDescription(NonNegativeScalarElementType cmd,
                                              String description)

Sets the MakeDepth command description field

Parameters:: cmd - AvclScriptCommands command of interest; description - defines intent for this AVCL command

createMoveLateralCmd

public static JAXBElement<SignedPercentElementType> createMoveLateralCmd(double setting,
                                                                         String description)

Generates a MoveLateral command

Parameters:: setting -; description - defines intent for this AVCL command
Returns:: JAXBElement

getMoveLateralCmdSetting
```
public static double getMoveLateralCmdSetting(SignedPercentElementType cmd)
```
Returns the MoveLateral commanded setting

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getMoveLateralCmdDescription
```
public static String getMoveLateralCmdDescription(SignedPercentElementType cmd)
```
Returns the MoveLateral command description field

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setMoveLateralCmdSetting

public static void setMoveLateralCmdSetting(SignedPercentElementType cmd,
                                            double setting)

Sets the MoveLateral commanded setting

Parameters:: cmd - AvclScriptCommands command of interest; setting -

setMoveLateralCmdDescription

public static void setMoveLateralCmdDescription(SignedPercentElementType cmd,
                                                String description)

Sets the MoveLateral command description field

Parameters:: cmd - AvclScriptCommands command of interest; description - defines intent for this AVCL command

createMoveRotateCmd

public static JAXBElement<SignedPercentElementType> createMoveRotateCmd(double setting,
                                                                        String description)

Generates a MoveRotate command

Parameters:: setting -; description - defines intent for this AVCL command
Returns:: ScalarElementType

getMoveRotateCmdSetting
```
public static double getMoveRotateCmdSetting(JAXBElement cmd)
```
Returns the MoveRotate commanded setting

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getMoveRotateCmdDescription
```
public static String getMoveRotateCmdDescription(JAXBElement cmd)
```
Returns the MoveRotate command description field

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setMoveRotateCmdSetting

public static void setMoveRotateCmdSetting(JAXBElement cmd,
                                           double setting)

Sets the MoveRotate commanded setting

Parameters:: cmd - AvclScriptCommands command of interest; setting -

setMoveRotateCmdDescription

public static void setMoveRotateCmdDescription(JAXBElement cmd,
                                               String description)

Sets the MoveRotate command description field

Parameters:: cmd - AvclScriptCommands command of interest; description - defines intent for this AVCL command

createParallelTrackCmd

public static CompositeWaypointUUVCommandType createParallelTrackCmd(int positionMode,
                                                                     double x,
                                                                     double y,
                                                                     double orientation,
                                                                     double trackLength,
                                                                     double trackSpacing,
                                                                     int trackCount,
                                                                     String firstTurn,
                                                                     int depthMode,
                                                                     double depth,
                                                                     int whichProp,
                                                                     double propSetting,
                                                                     int gpsFixes,
                                                                     double standoff,
                                                                     double timeOut,
                                                                     String description)

Generates a ParallelTrack composite waypoint command

Parameters:: positionMode -; x -; timeOut -; orientation -; y -; trackLength -; trackSpacing -; whichProp -; firstTurn -; trackCount -; depth -; depthMode -; propSetting -; description - defines intent for this AVCL command; gpsFixes -; standoff -
Returns:: CompositeWaypointUUVCommandType

createParallelTrackCmd

public static CompositeWaypointUUVCommandType createParallelTrackCmd(int positionMode,
                                                                     String x,
                                                                     String y,
                                                                     double orientation,
                                                                     double trackLength,
                                                                     double trackSpacing,
                                                                     int trackCount,
                                                                     String firstTurn,
                                                                     int depthMode,
                                                                     double depth,
                                                                     int whichProp,
                                                                     double propSetting,
                                                                     int gpsFixes,
                                                                     double standoff,
                                                                     double timeOut,
                                                                     String description)

Parameters:: positionMode -; x -; y -; orientation -; trackLength -; trackSpacing -; trackCount -; firstTurn -; depthMode -; depth -; whichProp -; propSetting -; gpsFixes -; standoff -; timeOut -; description - defines intent for this AVCL command
Returns:: CompositeWaypointUUVCommandType

getParallelTrackCmdPositType
```
public static int getParallelTrackCmdPositType(CompositeWaypointUUVCommandType cmd)
```
Returns an integer representing how the horizontal point is represented

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

getParallelTrackCmdX
```
public static String getParallelTrackCmdX(CompositeWaypointUUVCommandType cmd)
```
Returns the x, latitude, or northing coordinate of the ParallelTrack command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getParallelTrackCmdY
```
public static String getParallelTrackCmdY(CompositeWaypointUUVCommandType cmd)
```
Returns the y, longitude or easting coordinate of the ParallelTrack command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getParallelTrackCmdTrackLength
```
public static double getParallelTrackCmdTrackLength(CompositeWaypointUUVCommandType cmd)
```
Returns the track length of the ParallelTrack command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getParallelTrackCmdTrackSpacing
```
public static double getParallelTrackCmdTrackSpacing(CompositeWaypointUUVCommandType cmd)
```
Returns the track spacing of the ParallelTrack command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getParallelTrackCmdTrackCount
```
public static int getParallelTrackCmdTrackCount(CompositeWaypointUUVCommandType cmd)
```
Returns the track count of the ParallelTrack command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getParallelTrackCmdOrientation
```
public static double getParallelTrackCmdOrientation(CompositeWaypointUUVCommandType cmd)
```
Returns the orientation of the ParallelTrack command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getParallelTrackCmdFirstTurn
```
public static String getParallelTrackCmdFirstTurn(CompositeWaypointUUVCommandType cmd)
```
Returns the direction of the first turn of the ParallelTrack command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

setParallelTrackCmdX
```
public static void setParallelTrackCmdX(CompositeWaypointUUVCommandType cmd,
                                        double newValue,
                                        int mode)
```
Sets the x, latitude, or northing field of a Waypoint command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setParallelTrackCmdX
```
public static void setParallelTrackCmdX(CompositeWaypointUUVCommandType cmd,
                                        String newValue,
                                        int mode)
```
Sets the x, latitude, or northing field of a Waypoint command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setParallelTrackCmdY
```
public static void setParallelTrackCmdY(CompositeWaypointUUVCommandType cmd,
                                        double newValue,
                                        int mode)
```
Sets the y, longitude, or easting field of a ParallelTrack command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setParallelTrackCmdY
```
public static void setParallelTrackCmdY(CompositeWaypointUUVCommandType cmd,
                                        String newValue,
                                        int mode)
```
Sets the y, longitude, or easting field of a ParallelTrack command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

newValue -

setParallelTrackCmdTrackLength

public static void setParallelTrackCmdTrackLength(CompositeWaypointUUVCommandType cmd,
                                                  double newValue)

Sets the track length of the ParallelTrack command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setParallelTrackCmdTrackSpacing

public static void setParallelTrackCmdTrackSpacing(CompositeWaypointUUVCommandType cmd,
                                                   double newValue)

Sets the track spacing of the ParallelTrack command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setParallelTrackCmdTrackCount

public static void setParallelTrackCmdTrackCount(CompositeWaypointUUVCommandType cmd,
                                                 int newValue)

Sets the track count of the ParallelTrack command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setParallelTrackCmdOrientation

public static void setParallelTrackCmdOrientation(CompositeWaypointUUVCommandType cmd,
                                                  double newValue)

Sets the orientation of the ParallelTrack command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setParallelTrackCmdFirstTurn

public static void setParallelTrackCmdFirstTurn(CompositeWaypointUUVCommandType cmd,
                                                String newValue)

Sets the direction of the first turn of the ParallelTrack command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

createSetPositionCmd

public static JAXBElement<SetPositionUUVCommandType> createSetPositionCmd(double xString,
                                                                          double yString,
                                                                          int positType,
                                                                          double z,
                                                                          String description)

Generates a Position command

Parameters:: xString - or latitude position depending on position type; yString - or longitude position depending on position type; positType - enumeration for type of horizontal position representation; z -; description - defines intent for this AVCL command
Returns:: the position command

createSetPositionCmd

public static JAXBElement<SetPositionUUVCommandType> createSetPositionCmd(String xString,
                                                                          String yString,
                                                                          int positType,
                                                                          double z,
                                                                          String description)

Generates a Position command

Parameters:: xString - or latitude position depending on position type; yString - or longitude position depending on position type; positType - enumeration for type of horizontal position representation; z -; description - defines intent for this AVCL command
Returns:: the position command

getSetPositionCmdPositionType
```
public static int getSetPositionCmdPositionType(SetPositionUUVCommandType cmd)
```
Returns an integer representing how the horizontal point is represented

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

getSetPositionCmdX
```
public static String getSetPositionCmdX(SetPositionUUVCommandType cmd)
```
Returns the X, latitude, or northing field of a Position command as a String

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getSetPositionCmdY
```
public static String getSetPositionCmdY(SetPositionUUVCommandType cmd)
```
Returns the Y, longitude, or easting field of a Position command as a String

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getSetPositionCmdDepth
```
public static double getSetPositionCmdDepth(SetPositionUUVCommandType cmd)
```
Returns the depth field of the Position command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getSetPositionCmdDescription
```
public static String getSetPositionCmdDescription(SetPositionUUVCommandType cmd)
```
Returns the description field of the Position command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setSetPositionCmdX
```
public static void setSetPositionCmdX(SetPositionUUVCommandType cmd,
                                      double newValue)
```
Sets the X, latitude, or northing field of a Position command

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

setSetPositionCmdX

public static void setSetPositionCmdX(SetPositionUUVCommandType cmd,
                                      String newValue)

Sets the X, latitude, or northing field of a Position command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setSetPositionCmdY
```
public static void setSetPositionCmdY(SetPositionUUVCommandType cmd,
                                      double newValue)
```
Sets the Y, longitude, or easting field of a Position command

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

setSetPositionCmdY

public static void setSetPositionCmdY(SetPositionUUVCommandType cmd,
                                      String newValue)

Sets the Y, longitude, or easting field of a Position command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setSetPositionCmdDepth

public static void setSetPositionCmdDepth(SetPositionUUVCommandType cmd,
                                          double newValue)

Sets the depth value of a Position command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setSetPositionCmdDescription

public static void setSetPositionCmdDescription(SetPositionUUVCommandType cmd,
                                                String newValue)

Sets the description value of a Position command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

createRecoverCmd

public static RecoverCommandType createRecoverCmd(double range,
                                                  double heading,
                                                  double timeOut,
                                                  String description)

Generates an Recover command

Parameters:: range -; description - defines intent for this AVCL command; heading -; timeOut -
Returns:: RecoverCommandType

getRecoverCmdRange
```
public static double getRecoverCmdRange(RecoverCommandType cmd)
```
Returns the range of the Recover command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getRecoverCmdHeading
```
public static double getRecoverCmdHeading(RecoverCommandType cmd)
```
Returns the heading of the Recover command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getRecoverCmdTimeOut
```
public static double getRecoverCmdTimeOut(RecoverCommandType cmd)
```
Returns the time out time of the Recover command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getRecoverCmdDescription
```
public static String getRecoverCmdDescription(RecoverCommandType cmd)
```
Returns the description field of the Recover command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setRecoverCmdHeading

public static void setRecoverCmdHeading(RecoverCommandType cmd,
                                        double newValue)

Sets the bearing value of the Recover command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setRecoverCmdRange

public static void setRecoverCmdRange(RecoverCommandType cmd,
                                      double newValue)

Sets the range value of the Recover command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setRecoverCmdTimeOut

public static void setRecoverCmdTimeOut(RecoverCommandType cmd,
                                        double newValue)

Sets the time out time of the Recover command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setRecoverCmdDescription

public static void setRecoverCmdDescription(RecoverCommandType cmd,
                                            String newValue)

Sets the description value of an Recover command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

createSectorPatternCmd

public static CompositeWaypointUUVCommandType createSectorPatternCmd(int positionMode,
                                                                     double x,
                                                                     double y,
                                                                     double orientation,
                                                                     double radius,
                                                                     double sectorSize,
                                                                     int sectorCount,
                                                                     String turnDirection,
                                                                     int depthMode,
                                                                     double depth,
                                                                     int whichProp,
                                                                     double propSetting,
                                                                     int gpsFixes,
                                                                     double standoff,
                                                                     double timeOut,
                                                                     String description)

Generates a SectorPattern composite waypoint command

Parameters:: positionMode -; x -; orientation -; y -; radius -; turnDirection - AvclMission.PORT, AvclMission.STARBOARD, AvclMission.LEFT or AvclMission.RIGHT; sectorCount -; sectorSize -; standoff -; description - defines intent for this AVCL command; depthMode -; depth -; propSetting -; whichProp -; timeOut -; gpsFixes -
Returns:: CompositeWaypointUUVCommandType

createSectorPatternCmd

public static CompositeWaypointUUVCommandType createSectorPatternCmd(int positionMode,
                                                                     String x,
                                                                     String y,
                                                                     double orientation,
                                                                     double radius,
                                                                     double sectorSize,
                                                                     int sectorCount,
                                                                     String turnDirection,
                                                                     int depthMode,
                                                                     double depth,
                                                                     int whichProp,
                                                                     double propSetting,
                                                                     int gpsFixes,
                                                                     double standoff,
                                                                     double timeOut,
                                                                     String description)

Generates a SectorPattern composite waypoint command

Parameters:: positionMode -; orientation -; x -; y -; propSetting -; radius -; description - defines intent for this AVCL command; depth -; sectorSize -; sectorCount -; depthMode -; turnDirection - AvclMission.PORT, AvclMission.STARBOARD, AvclMission.LEFT or AvclMission.RIGHT; gpsFixes -; whichProp -; standoff -; timeOut -
Returns:: CompositeWaypointUUVCommandType

getSectorPatternCmdPositType
```
public static int getSectorPatternCmdPositType(CompositeWaypointUUVCommandType cmd)
```
Returns an integer representing how the horizontal point is represented

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

getSectorPatternCmdX
```
public static String getSectorPatternCmdX(CompositeWaypointUUVCommandType cmd)
```
Returns the x, latitude, or northing coordinate of the SectorPattern command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getSectorPatternCmdY
```
public static String getSectorPatternCmdY(CompositeWaypointUUVCommandType cmd)
```
Returns the y, longitude or easting coordinate of the SectorPattern command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getSectorPatternCmdRadius
```
public static double getSectorPatternCmdRadius(CompositeWaypointUUVCommandType cmd)
```
Returns the radius of the SectorCommand command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getSectorPatternCmdSectorSize
```
public static double getSectorPatternCmdSectorSize(CompositeWaypointUUVCommandType cmd)
```
Returns the sector size of the SectorPattern command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getSectorPatternCmdSectorCount
```
public static int getSectorPatternCmdSectorCount(CompositeWaypointUUVCommandType cmd)
```
Returns the sector count of the SectorPattern command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getSectorPatternCmdOrientation
```
public static double getSectorPatternCmdOrientation(CompositeWaypointUUVCommandType cmd)
```
Returns the orientation of the ParallelTrack command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getSectorPatternCmdTurnDirection
```
public static String getSectorPatternCmdTurnDirection(CompositeWaypointUUVCommandType cmd)
```
Returns the track length of the SectorPattern command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.PORT, AvclMission.STARBOARD, AvclMission.LEFT or AvclMission.RIGHT

setSectorPatternCmdX
```
public static void setSectorPatternCmdX(CompositeWaypointUUVCommandType cmd,
                                        double newValue,
                                        int mode)
```
Sets the x, latitude, or northing field of a SectorPattern starting position command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setSectorPatternCmdX
```
public static void setSectorPatternCmdX(CompositeWaypointUUVCommandType cmd,
                                        String newValue,
                                        int mode)
```
Sets the x, latitude, or northing field of a SectorPattern starting position command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setSectorPatternCmdY
```
public static void setSectorPatternCmdY(CompositeWaypointUUVCommandType cmd,
                                        double newValue,
                                        int mode)
```
Sets the y, longitude, or easting field of a SectorPattern command origin as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setSectorPatternCmdY
```
public static void setSectorPatternCmdY(CompositeWaypointUUVCommandType cmd,
                                        String newValue,
                                        int mode)
```
Sets the y, longitude, or easting field of a SectorPattern command origin as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setSectorPatternCmdRadius

public static void setSectorPatternCmdRadius(CompositeWaypointUUVCommandType cmd,
                                             double newValue)

Sets the track length of the SectorPattern command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setSectorPatternCmdSectorSize

public static void setSectorPatternCmdSectorSize(CompositeWaypointUUVCommandType cmd,
                                                 double newValue)

Sets the track spacing of the SectorPattern command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setSectorPatternCmdSectorCount

public static void setSectorPatternCmdSectorCount(CompositeWaypointUUVCommandType cmd,
                                                  int newValue)

Sets the track count of the SectorPattern command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setSectorPatternCmdOrientation

public static void setSectorPatternCmdOrientation(CompositeWaypointUUVCommandType cmd,
                                                  double newValue)

Sets the orientation of the SectorPattern command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setSectorPatternCmdTurnDirection
```
public static void setSectorPatternCmdTurnDirection(CompositeWaypointUUVCommandType cmd,
                                                    String newValue)
```
Sets the track direction of the SectorPattern command

Parameters:

cmd - AvclScriptCommands command of interest

newValue - AvclMission.PORT, AvclMission.STARBOARD, AvclMission.LEFT or AvclMission.RIGHT

createSetPlanesCmd

public static JAXBElement<SetPlanesCommandType> createSetPlanesCmd(int whichPlanes,
                                                                   double setting,
                                                                   String description)

Generates a SetPlanes command

Parameters:: whichPlanes -; setting -; description - defines intent for this AVCL command
Returns:: SetPlanesCommandType

getSetPlanesCmdWhichPlanes
```
public static int getSetPlanesCmdWhichPlanes(SetPlanesCommandType cmd)
```
Returns an integer enumeration representing SetPlanes commanded planes

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.ALLPLANES, AvclMission.BOWPLANES or AvclMission.STERNPLANES

getSetPlanesCmdSetting
```
public static double getSetPlanesCmdSetting(SetPlanesCommandType cmd)
```
Returns the SetPlanes speed setting

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getSetPlanesCmdDescription
```
public static String getSetPlanesCmdDescription(SetPlanesCommandType cmd)
```
Returns the SetPlanes command description field

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setSetPlanesCmdSetting

public static void setSetPlanesCmdSetting(SetPlanesCommandType cmd,
                                          int which,
                                          double newValue)

Sets the planes to be commanded by this SetPlanes command

Parameters:: cmd - AvclScriptCommands command of interest; which -; newValue -

setSetPlanesCmdDescription

public static void setSetPlanesCmdDescription(SetPlanesCommandType cmd,
                                              String description)

Sets the SetPlanes command description field

Parameters:: cmd - AvclScriptCommands command of interest; description - defines intent for this AVCL command

createSetSonarCmd

public static JAXBElement<SetSonarCommandType> createSetSonarCmd(String model,
                                                                 int scanMode,
                                                                 double bearing,
                                                                 int bearingType,
                                                                 String description)

Generates a SetSonar command

Parameters:: model -; description - defines intent for this AVCL command; bearing -; scanMode -; bearingType -
Returns:: SetSonarCommandType

getSetSonarCmdModel
```
public static String getSetSonarCmdModel(SetSonarCommandType cmd)
```
Returns the sonar model of the SetSonar command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getSetSonarCmdScan
```
public static int getSetSonarCmdScan(SetSonarCommandType cmd)
```
Returns an enumerated integer representing the scan mode of the SetSonar command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.MANUALSCAN, AvclMission.FORWARDSCAN or AvclMission.TRACKSCAN

getSetSonarCmdBearing
```
public static double getSetSonarCmdBearing(SetSonarCommandType cmd)
```
Returns the manual bearing of the SetSonar command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getSetSonarCmdBearingType
```
public static int getSetSonarCmdBearingType(SetSonarCommandType cmd)
```
Returns an enumerated integer representing the bearing type of the SetSonar command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.TRUEBEARING, AvclMission.MAGNETICBEARING or AvclMission.RELATIVEBEARING

getSetSonarCmdDescription
```
public static String getSetSonarCmdDescription(SetSonarCommandType cmd)
```
Returns the description field of the Recover command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setSetSonarCmdModel

public static void setSetSonarCmdModel(SetSonarCommandType cmd,
                                       String sonarModel)

Sets the SetSonar command sonar model field

Parameters:: cmd - AvclScriptCommands command of interest; sonarModel -

setSetSonarCmdScan

public static void setSetSonarCmdScan(SetSonarCommandType cmd,
                                      int newScan)

Sets the SetSonar command scan-type field

Parameters:: cmd - AvclScriptCommands command of interest; newScan -

setSetSonarCmdBearing

public static void setSetSonarCmdBearing(SetSonarCommandType cmd,
                                         double newValue)

Sets the SetSonar commanded bearing field

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setSetSonarCmdBearingType
```
public static void setSetSonarCmdBearingType(SetSonarCommandType cmd,
                                             int newType)
```
Sets the SetSonar command bearing type field

Parameters:

cmd - AvclScriptCommands command of interest

newType - AvclMission.TRUEBEARING, AvclMission.MAGNETICBEARING or AvclMission.RELATIVEBEARING

setSetSonarCmdDescription

public static void setSetSonarCmdDescription(SetSonarCommandType cmd,
                                             String newValue)

Sets the description value of a SetSonar command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

createSetThrusterCmd

public static JAXBElement<SetThrusterCommandType> createSetThrusterCmd(int whichThruster,
                                                                       double setting,
                                                                       String description)

Generates a SetThruster command

Parameters:: whichThruster -; setting - is new double-precision value to set; description - defines intent for this AVCL command
Returns:: SetThrusterCommandType

getSetThrusterCmdThruster
```
public static int getSetThrusterCmdThruster(SetThrusterCommandType cmd)
```
Returns an integer enumeration representing SetThruster commanded thruster

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.LATERALTHRUSTERS, AvclMission.BOWLATERALTHRUSTER, AvclMission.STERNLATERALTHRUSTER, AvclMission.VERTICALTHRUSTERS, AvclMission.BOWVERTICALTHRUSTER, AvclMission.STERNVERTICALTHRUSTER

getSetThrusterCmdSetting
```
public static double getSetThrusterCmdSetting(SetThrusterCommandType cmd)
```
Returns the SetThruster thruster setting

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getSetThrusterCmdDescription
```
public static String getSetThrusterCmdDescription(SetThrusterCommandType cmd)
```
Returns the SetThruster command description field

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setSetThrusterCmdSetting

public static void setSetThrusterCmdSetting(SetThrusterCommandType cmd,
                                            int which,
                                            double newValue)

Sets the thruster to be commanded by this SetThruster command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -; which -

setSetThrusterCmdDescription

public static void setSetThrusterCmdDescription(SetThrusterCommandType cmd,
                                                String description)

Sets the SetThruster command description field

Parameters:: cmd - AvclScriptCommands command of interest; description - defines intent for this AVCL command

createTakeStationCmd

public static TakeStationCommandType createTakeStationCmd(int scanMode,
                                                          double stationBearing,
                                                          double stationRange,
                                                          double tgtBearing,
                                                          double tgtRange,
                                                          double heading,
                                                          double timeOut,
                                                          String description)

Generates a TakeStation command

Parameters:: scanMode -; stationBearing -; stationRange -; tgtRange -; tgtBearing -; timeOut -; heading -; description - defines intent for this AVCL command
Returns:: TakeStationCommandType

getTakeStationCmdSonarScan
```
public static int getTakeStationCmdSonarScan(TakeStationCommandType cmd)
```
Returns an enumerated value representing the type of sonar scan (target or edge) directed

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.TARGETSCAN or AvclMission.EDGESCAN

getTakeStationCmdTgtRange
```
public static double getTakeStationCmdTgtRange(TakeStationCommandType cmd)
```
Returns the command-specified target range

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getTakeStationCmdTgtBearing
```
public static double getTakeStationCmdTgtBearing(TakeStationCommandType cmd)
```
Returns the command-specified target bearing

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getTakeStationCmdStationRange
```
public static double getTakeStationCmdStationRange(TakeStationCommandType cmd)
```
Returns the commanded station range

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getTakeStationCmdStationBearing
```
public static double getTakeStationCmdStationBearing(TakeStationCommandType cmd)
```
Returns the commanded station bearing

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getTakeStationCmdHeading
```
public static double getTakeStationCmdHeading(TakeStationCommandType cmd)
```
Returns the heading of the TakeStation command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getTakeStationCmdTimeOut
```
public static double getTakeStationCmdTimeOut(TakeStationCommandType cmd)
```
Returns the time out time of the TakeStation command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getTakeStationCmdDescription
```
public static String getTakeStationCmdDescription(TakeStationCommandType cmd)
```
Returns the description field of the TakeStation command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setTakeStationCmdSonarScan
```
public static void setTakeStationCmdSonarScan(TakeStationCommandType cmd,
                                              int mode)
```
Sets the sonar scan mode (target or edge) of the TakeStation command

Parameters:

cmd - AvclScriptCommands command of interest

mode - AvclMission.TARGETSCAN or AvclMission.TARGETSCAN

setTakeStationCmdTgtLocation

public static void setTakeStationCmdTgtLocation(TakeStationCommandType cmd,
                                                double bearing,
                                                double range)

Sets the target location of the TakeStation command

Parameters:: cmd - AvclScriptCommands command of interest; bearing -; range -

setTakeStationCmdStation

public static void setTakeStationCmdStation(TakeStationCommandType cmd,
                                            double bearing,
                                            double range)

Sets the commanded station of the TakeStation command

Parameters:: cmd - AvclScriptCommands command of interest; bearing -; range -

setTakeStationCmdHeading

public static void setTakeStationCmdHeading(TakeStationCommandType cmd,
                                            double newValue)

Sets the heading of the TakeStation command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setTakeStationCmdTimeOut

public static void setTakeStationCmdTimeOut(TakeStationCommandType cmd,
                                            double newValue)

Sets the time out time of the TakeStation command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setTakeStationCmdDescription

public static void setTakeStationCmdDescription(TakeStationCommandType cmd,
                                                String newValue)

Sets the description value of a TakeStation command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

createThrustersCmd

public static JAXBElement<BooleanElementType> createThrustersCmd(boolean enabled,
                                                                 String description)

Generates a Thrusters command

Parameters:: enabled - flag to denote enabled; description -
Returns:: a JAXBElement<?> of type BooleanElementType

getThrustersCmdEnabled
```
public static boolean getThrustersCmdEnabled(BooleanElementType cmd)
```
Returns true if Thrusters command enables body thrusters

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

whether enabled or not

getThrustersCmdDescription
```
public static String getThrustersCmdDescription(BooleanElementType cmd)
```
Returns the Thrusters command description field

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setThrustersCmdEnabled

public static void setThrustersCmdEnabled(BooleanElementType cmd,
                                          boolean enabled)

Sets the Thrusters command enabled field

Parameters:: cmd - AvclScriptCommands command of interest; enabled -

setThrustersCmdDescription

public static void setThrustersCmdDescription(BooleanElementType cmd,
                                              String description)

Sets the Thrusters command description

Parameters:: cmd - AvclScriptCommands command of interest; description - defines intent for this AVCL command

createWaypointCmd

public static WaypointUUVCommandType createWaypointCmd(double latitude,
                                                       double longitude,
                                                       double depth,
                                                       String id,
                                                       String description)

Generates a Waypoint command

Parameters:: latitude -; longitude -; depth -; id -; description - defines intent for this AVCL command
Returns:: WaypointUUVCommandType

createWaypointCmd

public static JAXBElement<WaypointUUVCommandType> createWaypointCmd(double x,
                                                                    double y,
                                                                    int positMode,
                                                                    double z,
                                                                    int depthMode,
                                                                    double propSpeed,
                                                                    int propSelection,
                                                                    boolean gps,
                                                                    double standoff,
                                                                    double timeOut,
                                                                    String description)

Generates a Waypoint command

Parameters:: x -; y -; positMode -; timeOut -; z -; propSpeed -; depthMode -; propSelection -; gps -; standoff -; description - defines intent for this AVCL command
Returns:: JAXBElement

createWaypointCmd

public static WaypointUUVCommandType createWaypointCmd(String x,
                                                       String y,
                                                       int positMode,
                                                       double z,
                                                       int depthMode,
                                                       double propSpeed,
                                                       int propSelection,
                                                       boolean gps,
                                                       double standoff,
                                                       double timeOut,
                                                       String description)

Generates a Waypoint command

Parameters:: x -; z -; y -; depthMode -; positMode -; propSpeed -; propSelection -; timeOut -; gps -; standoff -; description - defines intent for this AVCL command
Returns:: WaypointUUVCommandType

getWaypointCmdX
```
public static String getWaypointCmdX(WaypointUUVCommandType cmd)
```
Returns the waypoint command x, latitude, or northing value as applicable

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getWaypointCmdY
```
public static String getWaypointCmdY(WaypointUUVCommandType cmd)
```
Returns the Waypoint command y, longitude, or easting value as applicable

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

value

getWaypointCmdPositionType
```
public static int getWaypointCmdPositionType(WaypointUUVCommandType cmd)
```
Returns an integer representing how the horizontal point is represented

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

getWaypointCmdDepth
```
public static double getWaypointCmdDepth(WaypointUUVCommandType cmd)
```
Returns the Waypoint depth or altitude value as applicable

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getWaypointCmdDepthMode
```
public static int getWaypointCmdDepthMode(WaypointUUVCommandType cmd)
```
Returns an integer representing the commanded z-control mode (depth or altitude)

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.DEPTHCONTROL or AvclMission.ALTITUDECONTROL

getWaypointCmdTrackMode
```
public static String getWaypointCmdTrackMode(WaypointUUVCommandType cmd)
```
Returns the tracking mode of the waypoint (to point or to line)

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.DIRECTTO or AvclMission.TRACKTO

getWaypointCmdProp
```
public static int getWaypointCmdProp(WaypointUUVCommandType cmd)
```
Returns an integer representing the commanded propeller (all, stbd, port, center)

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.ALLPROPELLERS, AvclMission.STBDPROPELLER, AvclMission.PORTPROPELLER or AvclMission.CENTERPROPELLER

getWaypointCmdPropSetting
```
public static double getWaypointCmdPropSetting(WaypointUUVCommandType cmd)
```
Returns the commanded rpm (iff the waypoint uses open-loop speed control)

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getWaypointCmdSpeedType
```
public static int getWaypointCmdSpeedType(WaypointUUVCommandType cmd)
```
Returns the enumeration for the type of speed ordered by the waypoint command (knots or mps)

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

AvclMission.KNOTS or AvclMission.METERSPERSECOND

getWaypointCmdSpeed
```
public static double getWaypointCmdSpeed(WaypointUUVCommandType cmd)
```
Returns the speed commanded by the waypoint command in meters per second or knots (if specified)

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getWaypointCmdGps
```
public static boolean getWaypointCmdGps(WaypointUUVCommandType cmd)
```
Returns true if this Waypoint command is directing an en-route GPS fix

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

whether task of getting a GPS fix is enabled or not

getWaypointCmdStandoff
```
public static double getWaypointCmdStandoff(WaypointUUVCommandType cmd)
```
Returns the standoff value of the Waypoint command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getWaypointCmdTimeOut
```
public static double getWaypointCmdTimeOut(WaypointUUVCommandType cmd)
```
Returns the time out value of the Waypoint command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

double-precision value

getWaypointCmdDescription
```
public static String getWaypointCmdDescription(WaypointUUVCommandType cmd)
```
Returns the description field of the Waypoint command

Parameters:

cmd - AvclScriptCommands command of interest

Returns:

description

setWaypointCmdX
```
public static void setWaypointCmdX(WaypointUUVCommandType cmd,
                                   double newValue,
                                   int mode)
```
Sets the x, latitude, or northing field of a Waypoint command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setWaypointCmdX
```
public static void setWaypointCmdX(WaypointUUVCommandType cmd,
                                   String newValue,
                                   int mode)
```
Sets the x, latitude, or northing field of a Waypoint command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setWaypointCmdY
```
public static void setWaypointCmdY(WaypointUUVCommandType cmd,
                                   double newValue,
                                   int mode)
```
Sets the y, longitude, or easting field of a Waypoint command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setWaypointCmdY
```
public static void setWaypointCmdY(WaypointUUVCommandType cmd,
                                   String newValue,
                                   int mode)
```
Sets the y, longitude, or easting field of a Waypoint command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.XYPOSITION, AvclMission.RELATIVEXYPOSITION or AvclMission.LATLONGPOSITION

setWaypointCmdDepth
```
public static void setWaypointCmdDepth(WaypointUUVCommandType cmd,
                                       double newValue,
                                       int mode)
```
Sets the depth or altitude field of a Waypoint command as applicable

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

mode - AvclMission.DEPTHCONTROL, AvclMission.ALTITUDECONTROL or AvclMission.DEFAULTZCONTROL

clearWaypointCmdSpeed
```
public static void clearWaypointCmdSpeed(WaypointUUVCommandType cmd)
```
Clears the waypoint command's speed-related elements

Parameters:

cmd - AvclScriptCommands command of interest

setWaypointCmdProp
```
public static void setWaypointCmdProp(WaypointUUVCommandType cmd,
                                      double newValue,
                                      int whichProp)
```
Set a new commanded propeller RPM for a specified propeller

Parameters:

cmd - AvclScriptCommands command of interest

newValue -

whichProp - AvclMission.ALLPROPELLERS, AvclMission.STBDPROPELLER, AvclMission.PORTPROPELLER or AvclMission.CENTERPROPELLER

setWaypointCmdSpeed
```
public static void setWaypointCmdSpeed(WaypointUUVCommandType cmd,
                                       double newSpeed)
```
Sets the waypoint command ordered speed (meters per second)

Parameters:

cmd - AvclScriptCommands command of interest

newSpeed -

setWaypointCmdKnots

public static void setWaypointCmdKnots(WaypointUUVCommandType cmd,
                                       double newSpeed)

Sets the waypoint command ordered speed (knots)

Parameters:: cmd - AvclScriptCommands command of interest; newSpeed -

setWaypointCmdTrackMode
```
public static void setWaypointCmdTrackMode(WaypointUUVCommandType cmd,
                                           String newValue)
```
Returns the tracking mode of the waypoint (to point or to line)

Parameters:

cmd - AvclScriptCommands command of interest

newValue - AvclMission.DIRECTTO or AvclMission.TRACKTO

setWaypointCmdGps

public static void setWaypointCmdGps(WaypointUUVCommandType cmd,
                                     boolean newValue)

Sets the obtain gps field of a Waypoint command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setWaypointCmdStandoff

public static void setWaypointCmdStandoff(WaypointUUVCommandType cmd,
                                          double newValue)

Sets the standoff field of a Waypoint command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setWaypointCmdTimeOut

public static void setWaypointCmdTimeOut(WaypointUUVCommandType cmd,
                                         double newValue)

Sets the time out field of a Waypoint command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setWaypointCmdDescription

public static void setWaypointCmdDescription(WaypointUUVCommandType cmd,
                                             String newValue)

Sets the description value of a Waypoint command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

setWaypointCmdId

public static void setWaypointCmdId(WaypointUUVCommandType cmd,
                                    String newValue)

Sets the id value of a Waypoint command

Parameters:: cmd - AvclScriptCommands command of interest; newValue -

Class UuvScriptCommands

Constructor Summary

Method Summary

Methods inherited from class avcl.AvclScriptCommands

Methods inherited from class java.lang.Object

Constructor Detail

UuvScriptCommands

Method Detail

getCompositeWaypointCmdType

getCompositeWaypointCmdDepth

getCompositeWaypointCmdDepthMode

getCompositeWaypointCmdProp

getCompositeWaypointCmdPropSetting

getCompositeWaypointCmdSpeedType

getCompositeWaypointCmdSpeed

getCompositeWaypointCmdDescription

getCompositeWaypointCmdGpsFixes

getCompositeWaypointCmdStandoff

getCompositeWaypointCmdTimeOut

setCompositeWaypointCmdDescription

setCompositeWaypointCmdDepth

clearCompositeWaypointCmdSpeed

setCompositeWaypointCmdProp

setCompositeWaypointCmdSpeed

setCompositeWaypointCmdKnots

setCompositeWaypointCmdGps

setCompositeWaypointCmdStandoff

setCompositeWaypointCmdTimeOut

createExpandingSquareCmd

createExpandingSquareCmd

getExpandingSquareCmdPositType

getExpandingSquareCmdX

getExpandingSquareCmdY

getExpandingSquareCmdTrackSpacing

getExpandingSquareCmdTrackCount

getExpandingSquareCmdOrientation

getExpandingSquareCmdTurnDirection

setExpandingSquareCmdX

setExpandingSquareCmdX

setExpandingSquareCmdY

setExpandingSquareCmdY

setExpandingSquareCmdTrackSpacing

setExpandingSquareCmdTrackCount

setExpandingSquareCmdOrientation

setExpandingSquareCmdTurnDirection

createGpsFixCmd

getGpsFixCmdStartStopStatus

getGpsFixCmdTimeOut

getGpsFixCmdDescription

setGpsFixCmdStartStopStatus

setGpsFixCmdTimeOut

setGpsFixCmdDescription

createHoverCmd

createHoverCmd

getHoverCmdX

getHoverCmdY

getHoverCmdPositType

getHoverCmdDepth

getHoverCmdDepthMode

getHoverCmdHeading

getHoverCmdStandoff

getHoverCmdGps

getHoverCmdTimeOut

getHoverCmdDescription

setHoverCmdDepthMode

setHoverCmdX

setHoverCmdX

setHoverCmdY

setHoverCmdY

setHoverCmdDepth

setHoverCmdHeading

setHoverCmdGps

setHoverCmdStandoff

setHoverCmdTimeOut

setHoverCmdDescription

createLoiterCmd

createLoiterCmd

getLoiterCmdX

getLoiterCmdY

getLoiterCmdPositType