AvclScriptCommands (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- avcl.AvclScriptCommands

Direct Known Subclasses:

MunitionMissionCommands, UavScriptCommands, UgvScriptCommands, UsvScriptCommands, UuvScriptCommands
```
public class AvclScriptCommands
extends Object
```
Base class for all AVCL Script Commands Autonomous Underwater Vehicle Workbench Naval Postgraduate School, Monterey, CA www.nps.edu By: Mike Bailey Date: Jun 21, 2005 Time: 9:59:26 AM

Version:

$Id: AvclScriptCommands.java 8779 2012-12-26 14:34:34Z brutzman $

Constructor Summary

Constructors
Constructor and Description

AvclScriptCommands()

Constructors
Constructor and Description
`AvclScriptCommands()`

Method Summary

Methods
Modifier and Type	Method and Description
`static JAXBElement<?>`	`createFollowBeaconCmd(String beacon, double timeOut, String description)` Generates a FollowBeacon command
`static JAXBElement<?>`	`createHelpCmd(String description)` Generates a Help command
`static JAXBElement<?>`	`createMakeHeadingCmd(double setting, String description)` Generates a MakeHeading command
`static JAXBElement<?>`	`createMakeKnotsCmd(double setting, boolean speedOverGround, String description)` Generates a MakeKnots command
`static JAXBElement<?>`	`createMakeSpeedCmd(double setting, boolean speedOverGround, String description)` Generates a MakeSpeed command
`static JAXBElement<?>`	`createMetaCommand(String name, String content, String description)` Generates a MetaCommand command
`static JAXBElement<?>`	`createMissionScriptCmd(String path, String description)` Generates a MissionScript command
`static JAXBElement<?>`	`createMissionScriptInlineCmd(String path, String description)` Generates a MissionScriptInline command
`static JAXBElement<?>`	`createMoveRotateCmd(double setting, String description)` Generates a MakeRotate command
`static JAXBElement<?>`	`createQuitCmd(String description)` Generates a Quit command
`static JAXBElement<?>`	`createRealtimeCmd(boolean enabled, String description)` Generates a Realtime command
`static JAXBElement<?>`	`createSendMessageCmd(String description)` Generates a SendMessage command
`static JAXBElement<?>`	`createSetPowerCmd(double setting, String description)` Generates a SetPower command with selection ALLPROPELLERS
`static JAXBElement<?>`	`createSetPowerCmd(int whichProp, double setting, String description)` Generates a SetPower command
`static JAXBElement<?>`	`createSetRudderCmd(double setting, String description)` Generates a SetRudder command
`static JAXBElement<?>`	`createSetStandoffCmd(double setting, String description)` Generates a SetStandoff command
`static JAXBElement<?>`	`createSetTimeCmd(double setting, String description)` Generates a SetTime command
`static JAXBElement<PositiveScalarElementType>`	`createSetTimeStepCmd(double setting, String description)` Generates a SetTimeStep command
`static JAXBElement<?>`	`createTraceCmd(boolean enabled, String description)` Generates a Trace command
`static JAXBElement<?>`	`createWaitCommand(double setting, String description)` Generates a Wait command
`static JAXBElement<?>`	`createWaitUntilTimeCmd(double setting, String description)` Generates a WaitUntilTime command
`static String`	`getFollowBeaconCmdBeacon(Object cmd)` Returns the beacon type field of the FollowBeacon command
`static String`	`getFollowBeaconCmdDescription(Object cmd)` Returns the description field of the FollowBeacon command
`static double`	`getFollowBeaconCmdTimeOut(Object cmd)` Returns the time out time of the FollowBeacon command
`static String`	`getHelpCmdDescription(Object cmd)` Returns the Help command description field
`static String`	`getMakeHeadingCmdDescription(Object cmd)` Returns the MakeHeading command description field
`static double`	`getMakeHeadingCmdSetting(Object cmd)` Returns the MakeHeading commanded setting
`static String`	`getMakeKnotsCmdDescription(Object cmd)` Returns the MakeKnots command description field
`static double`	`getMakeKnotsCmdSetting(Object cmd)` Returns the MakeKnots commanded setting
`static boolean`	`getMakeKnotsCmdSpeedOverGround(Object cmd)` Returns the value of the MakeKnots command speed over grouond attribute
`static String`	`getMakeSpeedCmdDescription(Object cmd)` Returns the MakeSpeed command description field
`static double`	`getMakeSpeedCmdSetting(Object cmd)` Returns the MakeSpeed commanded setting
`static boolean`	`getMakeSpeedCmdSpeedOverGround(Object cmd)` Returns the value of the MakeSpeed command speed over ground attribute
`static String`	`getMetaCommandContent(Object cmd)` Returns the MetaCommand meta data
`static String`	`getMetaCommandDescription(Object cmd)` Returns the MetaCommand description field
`static String`	`getMetaCommandName(Object cmd)` Returns the MetaCommand meta name
`static String`	`getMissionScriptCmdDescription(Object cmd)` Returns the MissionScript command description field
`static String`	`getMissionScriptCmdPath(Object cmd)` Returns the MissionScript setting
`static String`	`getMissionScriptInlineCmdDescription(Object cmd)` Returns the MissionScriptInline command description field
`static String`	`getMissionScriptInlineCmdPath(Object cmd)` Returns the MissionScriptInline setting
`static String`	`getQuitCmdDescription(Object cmd)` Returns the Quit command description field
`static String`	`getRealtimeCmdDescription(Object cmd)` Returns the Realtime command description field
`static boolean`	`getRealtimeCmdSetting(Object cmd)` Returns the Realtime setting
`static AvclMessage`	`getSendMessageCmdContent(Object cmd)` Returns the AVCL message portion of the send message command
`static String`	`getSendMessageCmdDescription(Object cmd)` Returns the value of the description attribute of the send message command
`static String`	`getSetPowerCmdDescription(Object cmd)` Returns the SetPower command description field
`static int`	`getSetPowerCmdPropeller(Object cmd)` Returns an integer enumeration representing SetPower commanded propeller
`static double`	`getSetPowerCmdSetting(Object cmd)` Returns the SetPower speed setting
`static String`	`getSetRudderCmdDescription(Object cmd)` Returns the SetRudder command description field
`static double`	`getSetRudderCmdSetting(Object cmd)` Returns the SetRudder commanded setting
`static String`	`getSetStandoffCmdDescription(Object cmd)` Returns the Standoff command description field
`static double`	`getSetStandoffCmdSetting(Object cmd)` Returns the Standoff commanded setting
`static String`	`getSetTimeCmdDescription(Object cmd)` Returns the SetTime command description field
`static double`	`getSetTimeCmdSetting(Object cmd)` Returns the SetTime commanded setting
`static String`	`getSetTimeStepCmdDescription(Object cmd)` Returns the SetTimeStep command description field
`static double`	`getSetTimeStepCmdSetting(Object cmd)` Returns the SetTimeStep commanded setting
`static String`	`getTraceCmdDescription(Object cmd)` Returns the Trace command description field
`static boolean`	`getTraceCmdSetting(Object cmd)` Returns the Trace setting
`static String`	`getWaitCmdDescription(Object cmd)` Returns the Wait command description field
`static double`	`getWaitCommandSetting(Object cmd)` Returns the Wait commanded setting
`static String`	`getWaitUntilTimeCmdDescription(Object cmd)` Returns the WaitUntilTime command description field
`static double`	`getWaitUntilTimeCmdSetting(Object cmd)` Returns the WaitUntilTime value
`static String`	`noValueFilter(double d)` A method to eliminate the display of the "NOVALUE" parameter in dialogs
`static String`	`noValueFilter(int i)` A method to eliminate the display of the "NOVALUE" parameter in dialogs
`static void`	`setFollowBeaconCmdBeacon(Object cmd, String newValue)` Sets the beacon type value of a FollowBeacon command
`static void`	`setFollowBeaconCmdDescription(Object cmd, String newValue)` Sets the description value of a FollowBeacon command
`static void`	`setFollowBeaconCmdTimeOut(Object cmd, double newValue)` Sets the time out time of the FollowBeacon command
`static void`	`setHelpCmdDescription(Object cmd, String description)` Sets the Help command description field
`static void`	`setMakeHeadingCmdDescription(Object cmd, String description)` Sets the MakeHeading command description field
`static void`	`setMakeHeadingCmdSetting(Object cmd, double setting)` Sets the MakeHeading commanded setting
`static void`	`setMakeKnotsCmdDescription(Object cmd, String description)` Sets the MakeKnots command description field
`static void`	`setMakeKnotsCmdSetting(Object cmd, double setting)` Sets the MakeKnots commanded setting
`static void`	`setMakeKnotsCmdSpeedOverGround(Object cmd, boolean setting)` Sets the speed over ground attribute of the MakeSpeed command
`static void`	`setMakeSpeedCmdDescription(Object cmd, String description)` Sets the MakeSpeed command description field
`static void`	`setMakeSpeedCmdSetting(Object cmd, double setting)` Sets the MakeSpeed commanded setting
`static void`	`setMakeSpeedCmdSpeedOverGround(Object cmd, boolean setting)` Sets the speed over ground attribute of the MakeSpeed command
`static void`	`setMetaCommandContent(Object cmd, String content)` Sets the MetaCommand meta data content
`static void`	`setMetaCommandDescription(Object cmd, String description)` Sets the MetaCommand description field
`static void`	`setMetaCommandName(Object cmd, String name)` Sets the MetaCommand meta data name
`static void`	`setMissionScriptCmdDescription(Object cmd, String description)` Sets the MissionScript command description field
`static void`	`setMissionScriptCmdPath(Object cmd, String path)` Sets the MissionScript commanded setting
`static void`	`setMissionScriptInlineCmdDescription(Object cmd, String description)` Sets the MissionScriptInline command description field
`static void`	`setMissionScriptInlineCmdPath(Object cmd, String path)` Sets the MissionScriptInline commanded setting
`static void`	`setMoveRotateCmdDescription(Object cmd, String description)` Sets the MoveRotate command description field
`static void`	`setMoveRotateCmdSetting(Object cmd, double setting)` Sets the MoveRotate commanded setting - TODO test
`static void`	`setQuitCmdDescription(Object cmd, String description)` Sets the Quit command description field
`static void`	`setRealtimeCmdDescription(Object cmd, String description)` Sets the Realtime command description field
`static void`	`setRealtimeCmdSetting(Object cmd, boolean setting)` Sets the Realtime commanded setting
`static void`	`setSendMessageCmdContent(Object cmd, AvclMessage msg)` Sets the message data of the send message command
`static void`	`setSendMessageCmdDescription(Object cmd, String description)` Sets the description attribute of a send message command
`static void`	`setSetPowerCmdDescription(Object cmd, String description)` Sets the SetPower command description field
`static void`	`setSetPowerCmdSetting(Object cmd, int which, double newValue)` Sets the propeller to be commanded by this SetPower command
`static void`	`setSetRudderCmdDescription(Object cmd, String description)` Sets the SetRudder command description field
`static void`	`setSetRudderCmdSetting(Object cmd, double setting)` Sets the SetRudder commanded setting
`static void`	`setSetStandoffCmdDescription(Object cmd, String description)` Sets the Standoff command description field
`static void`	`setSetStandoffCmdSetting(Object cmd, double setting)` Sets the Standoff commanded setting
`static void`	`setSetTimeCmdDescription(Object cmd, String description)` Sets the SetTime command description field
`static void`	`setSetTimeCmdSetting(Object cmd, double setting)` Sets the SetTime commanded setting
`static void`	`setSetTimeStepCmdDescription(Object cmd, String description)` Sets the SetTimeStep command description field
`static void`	`setSetTimeStepCmdSetting(Object cmd, double setting)` Sets the SetTimeStep commanded setting
`static void`	`setTraceCmdDescription(Object cmd, String description)` Sets the Trace command description field
`static void`	`setTraceCmdSetting(Object cmd, boolean setting)` Sets the Trace commanded setting
`static void`	`setWaitCmdDescription(Object cmd, String description)` Sets the Wait command description field
`static void`	`setWaitCmdSetting(Object cmd, double setting)` Sets the Wait commanded setting
`static void`	`setWaitUntilTimeCmdDescription(Object cmd, String description)` Sets the WaitUntilTime command description field
`static void`	`setWaitUntilTimeCmdSetting(Object cmd, double setting)` Sets the WaitUntilTime commanded setting
`protected static String`	`valueOrEmptyString(String value)` String utility to return empty string "" instead of null

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

- Constructor Detail
  - AvclScriptCommands
```
public AvclScriptCommands()
```
- Method Detail
  - valueOrEmptyString
```
protected static String valueOrEmptyString(String value)
```
    String utility to return empty string "" instead of null
  - noValueFilter
```
public static String noValueFilter(double d)
```
    A method to eliminate the display of the "NOVALUE" parameter in dialogs
    
    Parameters:
    d -
    
    Returns:
    empty string or String.valueOf() equivalent
  - noValueFilter
```
public static String noValueFilter(int i)
```
    A method to eliminate the display of the "NOVALUE" parameter in dialogs
    
    Parameters:
    i -
    
    Returns:
    empty string or String.valueOf() equivalent
  - createQuitCmd
```
public static JAXBElement<?> createQuitCmd(String description)
```
    Generates a Quit command
    
    Parameters:
    description - of the quit command
    
    Returns:
    a JAXBElement of the quit command
  - getQuitCmdDescription
```
public static String getQuitCmdDescription(Object cmd)
```
    Returns the Quit command description field
    
    Parameters:
    cmd - the quit command
    
    Returns:
    a description of the quit command
  - setQuitCmdDescription
```
public static void setQuitCmdDescription(Object cmd,
                         String description)
```
    Sets the Quit command description field
    
    Parameters:
    cmd - the quit command to set
    description - of the quit command
  - createSendMessageCmd
```
public static JAXBElement<?> createSendMessageCmd(String description)
```
    Generates a SendMessage command
    
    Parameters:
    description - of the send message command
    
    Returns:
    a JAXBElement of the send command type
  - getSendMessageCmdContent
```
public static AvclMessage getSendMessageCmdContent(Object cmd)
```
    Returns the AVCL message portion of the send message command
    
    Parameters:
    cmd - object to retrieve content from
    
    Returns:
    an AvclMessage from the message command
  - getSendMessageCmdDescription
```
public static String getSendMessageCmdDescription(Object cmd)
```
    Returns the value of the description attribute of the send message command
    
    Parameters:
    cmd - object to retrieve content from
    
    Returns:
    the value of the description attribute of the send message command
  - setSendMessageCmdContent
```
public static void setSendMessageCmdContent(Object cmd,
                            AvclMessage msg)
```
    Sets the message data of the send message command
    
    Parameters:
    cmd - the object to set with an AvclMessage
    msg - data of the send message command
  - setSendMessageCmdDescription
```
public static void setSendMessageCmdDescription(Object cmd,
                                String description)
```
    Sets the description attribute of a send message command
    
    Parameters:
    cmd - the object to set the description for
    description - attribute of a send message command
  - createMetaCommand
```
public static JAXBElement<?> createMetaCommand(String name,
                               String content,
                               String description)
```
    Generates a MetaCommand command
    
    Parameters:
    name - of the meta command
    content - for the meta command
    description - of the meta command
    
    Returns:
    a JAXBElement containing the MetaCommandType
  - getMetaCommandName
```
public static String getMetaCommandName(Object cmd)
```
    Returns the MetaCommand meta name
    
    Parameters:
    cmd - the meta command object
    
    Returns:
    the MetaCommand meta name
  - getMetaCommandContent
```
public static String getMetaCommandContent(Object cmd)
```
    Returns the MetaCommand meta data
    
    Parameters:
    cmd - the meta command object
    
    Returns:
    the MetaCommand meta data
  - getMetaCommandDescription
```
public static String getMetaCommandDescription(Object cmd)
```
    Returns the MetaCommand description field
    
    Parameters:
    cmd - the meta command object
    
    Returns:
    the MetaCommand description field
  - setMetaCommandName
```
public static void setMetaCommandName(Object cmd,
                      String name)
```
    Sets the MetaCommand meta data name
    
    Parameters:
    cmd - the meta command object
    name - to set for the meta command object
  - setMetaCommandContent
```
public static void setMetaCommandContent(Object cmd,
                         String content)
```
    Sets the MetaCommand meta data content
    
    Parameters:
    cmd - the meta command object
    content - the data for the meta command object
  - setMetaCommandDescription
```
public static void setMetaCommandDescription(Object cmd,
                             String description)
```
    Sets the MetaCommand description field
    
    Parameters:
    cmd - the meta command object
    description - for the meta command object
  - createWaitCommand
```
public static JAXBElement<?> createWaitCommand(double setting,
                               String description)
```
    Generates a Wait command
    
    Parameters:
    setting - the value of the wait setting
    description - of the wait setting
    
    Returns:
    a JAXBElement containing the wait command type
  - getWaitCommandSetting
```
public static double getWaitCommandSetting(Object cmd)
```
    Returns the Wait commanded setting
    
    Parameters:
    cmd - the wait command object
    
    Returns:
    the Wait commanded setting
  - getWaitCmdDescription
```
public static String getWaitCmdDescription(Object cmd)
```
    Returns the Wait command description field
    
    Parameters:
    cmd - the wait command object
    
    Returns:
    the wait command description
  - setWaitCmdSetting
```
public static void setWaitCmdSetting(Object cmd,
                     double setting)
```
    Sets the Wait commanded setting
    
    Parameters:
    cmd - the wait command object
    setting - for the wait command
  - setWaitCmdDescription
```
public static void setWaitCmdDescription(Object cmd,
                         String description)
```
    Sets the Wait command description field
    
    Parameters:
    cmd - the wait command object
    description - of the wait command
  - createWaitUntilTimeCmd
```
public static JAXBElement<?> createWaitUntilTimeCmd(double setting,
                                    String description)
```
    Generates a WaitUntilTime command
    
    Parameters:
    setting - for the WaitUntilTime command
    description - of the WaitUntilTime command
    
    Returns:
    a JAXBELement containing a WaitUntilTime command
  - getWaitUntilTimeCmdSetting
```
public static double getWaitUntilTimeCmdSetting(Object cmd)
```
    Returns the WaitUntilTime value
    
    Parameters:
    cmd - the WaitUntilTime command
    
    Returns:
    a WaitUntilTime command value
  - getWaitUntilTimeCmdDescription
```
public static String getWaitUntilTimeCmdDescription(Object cmd)
```
    Returns the WaitUntilTime command description field
    
    Parameters:
    cmd - the WaitUntilTime command
    
    Returns:
    a WaitUntilTime command description field
  - setWaitUntilTimeCmdSetting
```
public static void setWaitUntilTimeCmdSetting(Object cmd,
                              double setting)
```
    Sets the WaitUntilTime commanded setting
    
    Parameters:
    cmd - the WaitUntilTime command
    setting - for the WaitUntilTime command
  - setWaitUntilTimeCmdDescription
```
public static void setWaitUntilTimeCmdDescription(Object cmd,
                                  String description)
```
    Sets the WaitUntilTime command description field
    
    Parameters:
    cmd - the WaitUntilTime command
    description - for the WaitUntilTime command
  - createHelpCmd
```
public static JAXBElement<?> createHelpCmd(String description)
```
    Generates a Help command
    
    Parameters:
    description - for the Help command
    
    Returns:
    a JAXBElement containing a Help command
  - getHelpCmdDescription
```
public static String getHelpCmdDescription(Object cmd)
```
    Returns the Help command description field
    
    Parameters:
    cmd - the Help command
    
    Returns:
    a description for the Help command
  - setHelpCmdDescription
```
public static void setHelpCmdDescription(Object cmd,
                         String description)
```
    Sets the Help command description field
    
    Parameters:
    cmd - the Help command
    description - for the Help command
  - createMakeSpeedCmd
```
public static JAXBElement<?> createMakeSpeedCmd(double setting,
                                boolean speedOverGround,
                                String description)
```
    Generates a MakeSpeed command
    
    Parameters:
    setting - for the MakeSpeed command
    speedOverGround - for MakeSpeed command
    description - of the MakeSpeed command
    
    Returns:
    a JAXBElement containing a MakeSpeed command
  - getMakeSpeedCmdSetting
```
public static double getMakeSpeedCmdSetting(Object cmd)
```
    Returns the MakeSpeed commanded setting
    
    Parameters:
    cmd - the MakeSpeed command
    
    Returns:
    the MakeSpeed command value
  - getMakeSpeedCmdSpeedOverGround
```
public static boolean getMakeSpeedCmdSpeedOverGround(Object cmd)
```
    Returns the value of the MakeSpeed command speed over ground attribute
    
    Parameters:
    cmd - MakeSpeed command
    
    Returns:
    the value of the MakeSpeed command speed over ground attribute
  - getMakeSpeedCmdDescription
```
public static String getMakeSpeedCmdDescription(Object cmd)
```
    Returns the MakeSpeed command description field
    
    Parameters:
    cmd - MakeSpeed command
    
    Returns:
    the MakeSpeed command description field
  - setMakeSpeedCmdSetting
```
public static void setMakeSpeedCmdSetting(Object cmd,
                          double setting)
```
    Sets the MakeSpeed commanded setting
    
    Parameters:
    cmd - the MakeSpeed command
    setting - the MakeSpeed command setting
  - setMakeSpeedCmdSpeedOverGround
```
public static void setMakeSpeedCmdSpeedOverGround(Object cmd,
                                  boolean setting)
```
    Sets the speed over ground attribute of the MakeSpeed command
    
    Parameters:
    cmd - the MakeSpeed command
    setting - the MakeSpeed command for speed over the ground
  - setMakeSpeedCmdDescription
```
public static void setMakeSpeedCmdDescription(Object cmd,
                              String description)
```
    Sets the MakeSpeed command description field
    
    Parameters:
    cmd - the MakeSpeed command
    description - of the MakeSpeed command
  - createMakeKnotsCmd
```
public static JAXBElement<?> createMakeKnotsCmd(double setting,
                                boolean speedOverGround,
                                String description)
```
    Generates a MakeKnots command
    
    Parameters:
    setting - for the MakeKnots command
    speedOverGround - if desired, set to true
    description - for the MakeKnots command
    
    Returns:
    a JAXBElement containing a MakeKnots command
  - getMakeKnotsCmdSetting
```
public static double getMakeKnotsCmdSetting(Object cmd)
```
    Returns the MakeKnots commanded setting
    
    Parameters:
    cmd - the MakeKnots command
    
    Returns:
    a MakeKnots command setting
  - getMakeKnotsCmdSpeedOverGround
```
public static boolean getMakeKnotsCmdSpeedOverGround(Object cmd)
```
    Returns the value of the MakeKnots command speed over grouond attribute
    
    Parameters:
    cmd - the MakeKnots command
    
    Returns:
    value of the MakeKnots command speed over grouond attribute
  - getMakeKnotsCmdDescription
```
public static String getMakeKnotsCmdDescription(Object cmd)
```
    Returns the MakeKnots command description field
    
    Parameters:
    cmd - the MakeKnots command
    
    Returns:
    the MakeKnots command description field
  - setMakeKnotsCmdSetting
```
public static void setMakeKnotsCmdSetting(Object cmd,
                          double setting)
```
    Sets the MakeKnots commanded setting
    
    Parameters:
    cmd - the the MakeKnots command
    setting - for the MakeKnots command
  - setMakeKnotsCmdSpeedOverGround
```
public static void setMakeKnotsCmdSpeedOverGround(Object cmd,
                                  boolean setting)
```
    Sets the speed over ground attribute of the MakeSpeed command
    
    Parameters:
    cmd - the MakeKnots command
    setting - true if speed over the ground is desired
  - setMakeKnotsCmdDescription
```
public static void setMakeKnotsCmdDescription(Object cmd,
                              String description)
```
    Sets the MakeKnots command description field
    
    Parameters:
    cmd - the MakeKnots command
    description - of the MakeKnots command
  - createFollowBeaconCmd
```
public static JAXBElement<?> createFollowBeaconCmd(String beacon,
                                   double timeOut,
                                   String description)
```
    Generates a FollowBeacon command
    
    Parameters:
    beacon - of the FollowBeacon command
    timeOut - of the FollowBeacon command
    description - of the FollowBeacon command
    
    Returns:
    a JAXBElement containing a FollowBeacon command
  - getFollowBeaconCmdBeacon
```
public static String getFollowBeaconCmdBeacon(Object cmd)
```
    Returns the beacon type field of the FollowBeacon command
    
    Parameters:
    cmd - the FollowBeacon command
    
    Returns:
    a beacon type field
  - getFollowBeaconCmdTimeOut
```
public static double getFollowBeaconCmdTimeOut(Object cmd)
```
    Returns the time out time of the FollowBeacon command
    
    Parameters:
    cmd - the FollowBeacon command
    
    Returns:
    the time out of the FollowBeacon command
  - getFollowBeaconCmdDescription
```
public static String getFollowBeaconCmdDescription(Object cmd)
```
    Returns the description field of the FollowBeacon command
    
    Parameters:
    cmd - the FollowBeacon command
    
    Returns:
    the description field of the FollowBeacon command
  - setFollowBeaconCmdBeacon
```
public static void setFollowBeaconCmdBeacon(Object cmd,
                            String newValue)
```
    Sets the beacon type value of a FollowBeacon command
    
    Parameters:
    cmd - the FollowBeacon command
    newValue - the beacon type value of the FollowBeacon command
  - setFollowBeaconCmdTimeOut
```
public static void setFollowBeaconCmdTimeOut(Object cmd,
                             double newValue)
```
    Sets the time out time of the FollowBeacon command
    
    Parameters:
    cmd - the FollowBeacon command
    newValue - the timeout of the FollowBeacon command
  - setFollowBeaconCmdDescription
```
public static void setFollowBeaconCmdDescription(Object cmd,
                                 String newValue)
```
    Sets the description value of a FollowBeacon command
    
    Parameters:
    cmd - the FollowBeacon command
    newValue - the description of the FollowBeacon command
  - createMakeHeadingCmd
```
public static JAXBElement<?> createMakeHeadingCmd(double setting,
                                  String description)
```
    Generates a MakeHeading command
    
    Parameters:
    setting - of the MakeHeading command
    description - of the MakeHeading command
    
    Returns:
    a JAXBElement containing a MakeHeading command
  - getMakeHeadingCmdSetting
```
public static double getMakeHeadingCmdSetting(Object cmd)
```
    Returns the MakeHeading commanded setting
    
    Parameters:
    cmd - the MakeHeading command
    
    Returns:
    a MakeHeading command setting
  - getMakeHeadingCmdDescription
```
public static String getMakeHeadingCmdDescription(Object cmd)
```
    Returns the MakeHeading command description field
    
    Parameters:
    cmd - the MakeHeading command
    
    Returns:
    a MakeHeading command description field
  - setMakeHeadingCmdSetting
```
public static void setMakeHeadingCmdSetting(Object cmd,
                            double setting)
```
    Sets the MakeHeading commanded setting
    
    Parameters:
    cmd - the MakeHeading command
    setting - the MakeHeading command setting
  - setMakeHeadingCmdDescription
```
public static void setMakeHeadingCmdDescription(Object cmd,
                                String description)
```
    Sets the MakeHeading command description field
    
    Parameters:
    cmd - the MakeHeading command
    description - of the MakeHeading command
  - createMissionScriptCmd
```
public static JAXBElement<?> createMissionScriptCmd(String path,
                                    String description)
```
    Generates a MissionScript command
    
    Parameters:
    path - for the MissionScript command
    description - of the MissionScript command
    
    Returns:
    a JAXBElement containing a MissionScript command
  - getMissionScriptCmdPath
```
public static String getMissionScriptCmdPath(Object cmd)
```
    Returns the MissionScript setting
    
    Parameters:
    cmd - the MissionScript command
    
    Returns:
    a path to a MissionScript command
  - getMissionScriptCmdDescription
```
public static String getMissionScriptCmdDescription(Object cmd)
```
    Returns the MissionScript command description field
    
    Parameters:
    cmd - the MissionScript command
    
    Returns:
    a MissionScript command description field
  - setMissionScriptCmdPath
```
public static void setMissionScriptCmdPath(Object cmd,
                           String path)
```
    Sets the MissionScript commanded setting
    
    Parameters:
    cmd - the MissionScript command
    path - of the MissionScript command
  - setMissionScriptCmdDescription
```
public static void setMissionScriptCmdDescription(Object cmd,
                                  String description)
```
    Sets the MissionScript command description field
    
    Parameters:
    cmd - the MissionScript command
    description - of the MissionScript command
  - createMissionScriptInlineCmd
```
public static JAXBElement<?> createMissionScriptInlineCmd(String path,
                                          String description)
```
    Generates a MissionScriptInline command
    
    Parameters:
    path - of the MissionScriptInline command
    description - of the MissionScriptInline command
    
    Returns:
    a JAXBElement containing a MissionScriptInline command
  - getMissionScriptInlineCmdPath
```
public static String getMissionScriptInlineCmdPath(Object cmd)
```
    Returns the MissionScriptInline setting
    
    Parameters:
    cmd - the MissionScriptInline command
    
    Returns:
    a MissionScriptInline command setting
  - getMissionScriptInlineCmdDescription
```
public static String getMissionScriptInlineCmdDescription(Object cmd)
```
    Returns the MissionScriptInline command description field
    
    Parameters:
    cmd - the MissionScriptInline command
    
    Returns:
    a MissionScriptInline command description
  - setMissionScriptInlineCmdPath
```
public static void setMissionScriptInlineCmdPath(Object cmd,
                                 String path)
```
    Sets the MissionScriptInline commanded setting
    
    Parameters:
    cmd - the MissionScriptInline command
    path - of the MissionScriptInline command
  - setMissionScriptInlineCmdDescription
```
public static void setMissionScriptInlineCmdDescription(Object cmd,
                                        String description)
```
    Sets the MissionScriptInline command description field
    
    Parameters:
    cmd - the MissionScriptInline command
    description - of the MissionScriptInline command
  - createRealtimeCmd
```
public static JAXBElement<?> createRealtimeCmd(boolean enabled,
                               String description)
```
    Generates a Realtime command
    
    Parameters:
    enabled - the Realtime command
    description - of the Realtime command
    
    Returns:
    a JAXBElement containing a Realtime command
  - getRealtimeCmdSetting
```
public static boolean getRealtimeCmdSetting(Object cmd)
```
    Returns the Realtime setting
    
    Parameters:
    cmd - the Realtime command
    
    Returns:
    a Realtime command setting
  - getRealtimeCmdDescription
```
public static String getRealtimeCmdDescription(Object cmd)
```
    Returns the Realtime command description field
    
    Parameters:
    cmd - the Realtime command
    
    Returns:
    a Realtime command description field
  - setRealtimeCmdSetting
```
public static void setRealtimeCmdSetting(Object cmd,
                         boolean setting)
```
    Sets the Realtime commanded setting
    
    Parameters:
    cmd - the Realtime command
    setting - for the Realtime command
  - setRealtimeCmdDescription
```
public static void setRealtimeCmdDescription(Object cmd,
                             String description)
```
    Sets the Realtime command description field
    
    Parameters:
    cmd - the Realtime command
    description - of the Realtime command
  - createSetStandoffCmd
```
public static JAXBElement<?> createSetStandoffCmd(double setting,
                                  String description)
```
    Generates a SetStandoff command
    
    Parameters:
    setting - for the SetStandoff command
    description - of the SetStandoff command
    
    Returns:
    a JAXBElement containing a SetStandoff command
  - getSetStandoffCmdSetting
```
public static double getSetStandoffCmdSetting(Object cmd)
```
    Returns the Standoff commanded setting
    
    Parameters:
    cmd - the Standoff command
    
    Returns:
    a Standoff command setting
  - getSetStandoffCmdDescription
```
public static String getSetStandoffCmdDescription(Object cmd)
```
    Returns the Standoff command description field
    
    Parameters:
    cmd - the Standoff command
    
    Returns:
    a Standoff command description
  - setSetStandoffCmdSetting
```
public static void setSetStandoffCmdSetting(Object cmd,
                            double setting)
```
    Sets the Standoff commanded setting
    
    Parameters:
    cmd - the Standoff command
    setting - for the Standoff command
  - setSetStandoffCmdDescription
```
public static void setSetStandoffCmdDescription(Object cmd,
                                String description)
```
    Sets the Standoff command description field
    
    Parameters:
    cmd - the Standoff command
    description - of the Standoff command
  - createSetTimeCmd
```
public static JAXBElement<?> createSetTimeCmd(double setting,
                              String description)
```
    Generates a SetTime command
    
    Parameters:
    setting - for the SetTime command
    description - of the SetTime command
    
    Returns:
    a JAXBElement containing a SetTime command
  - getSetTimeCmdSetting
```
public static double getSetTimeCmdSetting(Object cmd)
```
    Returns the SetTime commanded setting
    
    Parameters:
    cmd - the SetTime command
    
    Returns:
    a SetTime command setting
  - getSetTimeCmdDescription
```
public static String getSetTimeCmdDescription(Object cmd)
```
    Returns the SetTime command description field
    
    Parameters:
    cmd - the SetTime command
    
    Returns:
    a SetTime command description
  - setSetTimeCmdSetting
```
public static void setSetTimeCmdSetting(Object cmd,
                        double setting)
```
    Sets the SetTime commanded setting
    
    Parameters:
    cmd - the SetTime command
    setting - for the SetTime command
  - setSetTimeCmdDescription
```
public static void setSetTimeCmdDescription(Object cmd,
                            String description)
```
    Sets the SetTime command description field
    
    Parameters:
    cmd - the SetTime command
    description - of the SetTime command
  - createSetTimeStepCmd
```
public static JAXBElement<PositiveScalarElementType> createSetTimeStepCmd(double setting,
                                                          String description)
```
    Generates a SetTimeStep command
    
    Parameters:
    setting - for the SetTimeStep command
    description - of the SetTimeStep command
    
    Returns:
    a JAXBElement containing a SetTimeStep command
  - getSetTimeStepCmdSetting
```
public static double getSetTimeStepCmdSetting(Object cmd)
```
    Returns the SetTimeStep commanded setting
    
    Parameters:
    cmd - the SetTimeStep command
    
    Returns:
    a SetTimeStep command setting
  - getSetTimeStepCmdDescription
```
public static String getSetTimeStepCmdDescription(Object cmd)
```
    Returns the SetTimeStep command description field
    
    Parameters:
    cmd - the SetTimeStep command
    
    Returns:
    a SetTimeStep command description
  - setSetTimeStepCmdSetting
```
public static void setSetTimeStepCmdSetting(Object cmd,
                            double setting)
```
    Sets the SetTimeStep commanded setting
    
    Parameters:
    cmd - the SetTimeStep command
    setting - for the SetTimeStep command
  - setSetTimeStepCmdDescription
```
public static void setSetTimeStepCmdDescription(Object cmd,
                                String description)
```
    Sets the SetTimeStep command description field
    
    Parameters:
    cmd - the SetTimeStep command
    description - for the SetTimeStep command
  - createTraceCmd
```
public static JAXBElement<?> createTraceCmd(boolean enabled,
                            String description)
```
    Generates a Trace command
    
    Parameters:
    enabled - the Trace command
    description - for the Trace command
    
    Returns:
    a JAXBElement containing a Trace command
  - getTraceCmdSetting
```
public static boolean getTraceCmdSetting(Object cmd)
```
    Returns the Trace setting
    
    Parameters:
    cmd - the Trace command
    
    Returns:
    a setting for the Trace command
  - getTraceCmdDescription
```
public static String getTraceCmdDescription(Object cmd)
```
    Returns the Trace command description field
    
    Parameters:
    cmd - the Trace command
    
    Returns:
    a Trace command description
  - setTraceCmdSetting
```
public static void setTraceCmdSetting(Object cmd,
                      boolean setting)
```
    Sets the Trace commanded setting
    
    Parameters:
    cmd - the Trace command
    setting - for the Trace command
  - setTraceCmdDescription
```
public static void setTraceCmdDescription(Object cmd,
                          String description)
```
    Sets the Trace command description field
    
    Parameters:
    cmd - the Trace command
    description - for the Trace command
  - createSetPowerCmd
```
public static JAXBElement<?> createSetPowerCmd(double setting,
                               String description)
```
    Generates a SetPower command with selection ALLPROPELLERS
    
    Parameters:
    setting - for the propeller
    description - of the set power command
    
    Returns:
    a JAXBElement for the set power command
  - createSetPowerCmd
```
public static JAXBElement<?> createSetPowerCmd(int whichProp,
                               double setting,
                               String description)
```
    Generates a SetPower command
    
    Parameters:
    whichProp - left, or right
    setting - for the propeller
    description - of the set power command
    
    Returns:
    a JAXBElement for the set power command
  - getSetPowerCmdPropeller
```
public static int getSetPowerCmdPropeller(Object cmd)
```
    Returns an integer enumeration representing SetPower commanded propeller
    
    Parameters:
    cmd - the SetPower command
    
    Returns:
    a SetPower command setting
  - getSetPowerCmdSetting
```
public static double getSetPowerCmdSetting(Object cmd)
```
    Returns the SetPower speed setting
    
    Parameters:
    cmd - the SetPower command
    
    Returns:
    a SetPower command speed setting
  - getSetPowerCmdDescription
```
public static String getSetPowerCmdDescription(Object cmd)
```
    Returns the SetPower command description field
    
    Parameters:
    cmd - the SetPower command
    
    Returns:
    a SetPower command description
  - setSetPowerCmdSetting
```
public static void setSetPowerCmdSetting(Object cmd,
                         int which,
                         double newValue)
```
    Sets the propeller to be commanded by this SetPower command
    
    Parameters:
    cmd - the SetPower command
    which - propeller
    newValue - setting for a propeller
  - setSetPowerCmdDescription
```
public static void setSetPowerCmdDescription(Object cmd,
                             String description)
```
    Sets the SetPower command description field
    
    Parameters:
    cmd - the SetPower command
    description - of the SetPower command
  - createSetRudderCmd
```
public static JAXBElement<?> createSetRudderCmd(double setting,
                                String description)
```
    Generates a SetRudder command
    
    Parameters:
    setting - the value of the rudder setting
    description - the description of this rudder setting
    
    Returns:
    a JAXBElement containing a SignedPercentElementType
  - getSetRudderCmdSetting
```
public static double getSetRudderCmdSetting(Object cmd)
```
    Returns the SetRudder commanded setting
    
    Parameters:
    cmd - the SetRudder command
    
    Returns:
    a SetRudder command setting
  - getSetRudderCmdDescription
```
public static String getSetRudderCmdDescription(Object cmd)
```
    Returns the SetRudder command description field
    
    Parameters:
    cmd - a SetRudder command
    
    Returns:
    a SetRudder command description
  - setSetRudderCmdSetting
```
public static void setSetRudderCmdSetting(Object cmd,
                          double setting)
```
    Sets the SetRudder commanded setting
    
    Parameters:
    cmd - the SetRudder command
    setting - for the SetRudder command
  - setSetRudderCmdDescription
```
public static void setSetRudderCmdDescription(Object cmd,
                              String description)
```
    Sets the SetRudder command description field
    
    Parameters:
    cmd - the SetRudder command
    description - of the SetRudder command
  - setMoveRotateCmdSetting
```
public static void setMoveRotateCmdSetting(Object cmd,
                           double setting)
```
    Sets the MoveRotate commanded setting - TODO test
    
    Parameters:
    cmd - the MoveRotate command
    setting - for the MoveRotate command
  - createMoveRotateCmd
```
public static JAXBElement<?> createMoveRotateCmd(double setting,
                                 String description)
```
    Generates a MakeRotate command
    
    Parameters:
    setting - for the MoveRotate command
    description - for the MoveRotate command
    
    Returns:
    a JAXBElement containing a MoveRotate command
  - setMoveRotateCmdDescription
```
public static void setMoveRotateCmdDescription(Object cmd,
                               String description)
```
    Sets the MoveRotate command description field
    
    Parameters:
    cmd - the MoveRotate command
    description - of the MoveRotate command

Class AvclScriptCommands

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AvclScriptCommands

Method Detail

valueOrEmptyString

noValueFilter

noValueFilter

createQuitCmd

getQuitCmdDescription

setQuitCmdDescription

createSendMessageCmd

getSendMessageCmdContent

getSendMessageCmdDescription

setSendMessageCmdContent

setSendMessageCmdDescription

createMetaCommand

getMetaCommandName

getMetaCommandContent

getMetaCommandDescription

setMetaCommandName

setMetaCommandContent

setMetaCommandDescription

createWaitCommand

getWaitCommandSetting

getWaitCmdDescription

setWaitCmdSetting

setWaitCmdDescription

createWaitUntilTimeCmd

getWaitUntilTimeCmdSetting

getWaitUntilTimeCmdDescription

setWaitUntilTimeCmdSetting

setWaitUntilTimeCmdDescription

createHelpCmd

getHelpCmdDescription

setHelpCmdDescription

createMakeSpeedCmd

getMakeSpeedCmdSetting

getMakeSpeedCmdSpeedOverGround

getMakeSpeedCmdDescription

setMakeSpeedCmdSetting

setMakeSpeedCmdSpeedOverGround

setMakeSpeedCmdDescription

createMakeKnotsCmd

getMakeKnotsCmdSetting

getMakeKnotsCmdSpeedOverGround

getMakeKnotsCmdDescription

setMakeKnotsCmdSetting

setMakeKnotsCmdSpeedOverGround

setMakeKnotsCmdDescription

createFollowBeaconCmd

getFollowBeaconCmdBeacon

getFollowBeaconCmdTimeOut

getFollowBeaconCmdDescription

setFollowBeaconCmdBeacon

setFollowBeaconCmdTimeOut

setFollowBeaconCmdDescription

createMakeHeadingCmd

getMakeHeadingCmdSetting

getMakeHeadingCmdDescription

setMakeHeadingCmdSetting

setMakeHeadingCmdDescription

createMissionScriptCmd

getMissionScriptCmdPath

getMissionScriptCmdDescription

setMissionScriptCmdPath

setMissionScriptCmdDescription

createMissionScriptInlineCmd

getMissionScriptInlineCmdPath

getMissionScriptInlineCmdDescription

setMissionScriptInlineCmdPath

setMissionScriptInlineCmdDescription

createRealtimeCmd

getRealtimeCmdSetting

getRealtimeCmdDescription

setRealtimeCmdSetting

setRealtimeCmdDescription

createSetStandoffCmd