AUVWorkbenchConfig (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- workbench.main.AUVWorkbenchConfig

All Implemented Interfaces:

Serializable
```
public class AUVWorkbenchConfig
extends Object
implements Serializable
```
Filename : AUVWorkbenchConfig.java Description : AUV Workbench configuration data structure 1. Have not done saveXML() - Execution, Hydrodynamics->AUV, App->... Created Date : 06 November 2003 Course : Thesis Program : AUV Workbench 1.0 Compiler : JDK 1.4.2 onwards Platform : Windows 2000/Windows XP

Version:

$Id: AUVWorkbenchConfig.java 9109 2015-07-29 22:39:46Z brutzman $

Author:

Lee, Chin Siong Daryl

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_XMLFILE

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_XMLFILE`

Constructor Summary

Constructors
Constructor and Description

AUVWorkbenchConfig()
constructor; just initialize local variables

AUVWorkbenchConfig(String fXML)
constructor

Constructors
Constructor and Description
`AUVWorkbenchConfig()` constructor; just initialize local variables
`AUVWorkbenchConfig(String fXML)` constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addVehicleTypes(File skeleton)` Add a type (temporarily);
`boolean`	`browseTo(String url)`
`ConfigApp`	`getApp(String nm)`
`List<ConfigApp>`	`getAppList()` return list of Toolbar applications specified in configuration file
`AUV`	`getAttributesForAUV(Node aNode, String[] sArr)` extract AUV information (XML Attributes) into a AUV object
`Hotkey`	`getAttributesForHotKey(Node aNode, String[] sArr, String sData)` extract hotkeys information from tag e.g.
`void`	`getAttributesForJabber(Node aNode, String[] sArr)` extract Jabber information from tag e.g.
`void`	`getAttributesForWeb(Node aNode, String[] sArr)` extract web server information from tag e.g.
`int`	`getBaudrate()` get baudrate
`List<String>`	`getBrowserList()` return list of browsers specified in configuration file
`int`	`getDataBits()` get data bits
`String`	`getDefaultVehicleType(int typ)` Method for determining default: look for the first one that matches the type id
`String`	`getDirModel()` get the directory location for Models
`String`	`getDirScript()` get the directory location for Scripts
`boolean`	`getDisplayInBrowser()` whether to display in browser or Xj3D
`String`	`getDynamicsDir()` return directory of Dynamics This is the working directory ("user.dir") when launching dynamics process It doesn't need to be the directory of the dynamics classes, nor should it be.
`String`	`getDynamicsFilename()` return filename of Dynamics
`String`	`getDynamicsPath()` return full path of Dynamics
`String`	`getExecutionCDir()` return directory of Execution C
`String`	`getExecutionCFilename()` return filename of Execution C
`String`	`getExecutionCPath()` return full path of Execution C
`String`	`getExecutionJavaDirMUNITION()`
`String`	`getExecutionJavaDirUAV()` return directory of Execution Java
`String`	`getExecutionJavaDirUGV()` return directory of Execution Java
`String`	`getExecutionJavaDirUSV()` return directory of Execution Java
`String`	`getExecutionJavaDirUUV()` return directory of Execution Java
`String`	`getExecutionJavaFilenameMUNITION()`
`String`	`getExecutionJavaFilenameUAV()` return filename of Execution Java
`String`	`getExecutionJavaFilenameUGV()` return filename of Execution Java
`String`	`getExecutionJavaFilenameUSV()` return filename of Execution Java
`String`	`getExecutionJavaFilenameUUV()` return filename of Execution Java
`String`	`getExecutionJavaPathUAV()` return full path of Execution Java
`String`	`getExecutionJavaPathUGV()` return full path of Execution Java
`String`	`getExecutionJavaPathUSV()` return full path of Execution Java
`String`	`getExecutionJavaPathUUV()` return full path of Execution Java
`String`	`getExecutionNoThrusterJavaDir()` return directory of Execution (No Thruster) Java
`String`	`getExecutionNoThrusterJavaFilename()` return filename of Execution (No Thruster) Java
`boolean`	`getHandshake()` get handshake
`List<Hotkey>`	`getHotKeyList()` return list of Hotkeys specified in configuration file
`String`	`getIMDirIn()` get the directory to store incoming binary data.
`String`	`getIMDirOut()` get the directory to store outgoing binary data (e.g. encoded data in Jabber XHTML message)
`String`	`getIMDomain()` get the Jabber logon domain
`String`	`getIMJID()` get the Jabber ID to listen to upon connection
`String`	`getIMNickName()` get the Jabber user nickname
`int`	`getIMPort()` get Jabber port no.
`String`	`getIMResource()` get the Jabber user resource
`String`	`getIMUserName()` get the Jabber user name
`boolean`	`getModemInitialized()` whether the serial (acoustic) modem has been initialized
`boolean`	`getParity()` get parity
`boolean`	`getSerialCommsEnabled()` whether the serial communications are enabled for this application
`String`	`getSerialPort()` get serial port
`boolean`	`getSonarVisEnabled()` whether sonar visualization panel is enabled
`int`	`getStopBits()` get stop bits
`Set<String>`	`getSupportedVehicles()` returns a set (Strings) of all of the vehicles for which config files have been specified
`String`	`getVehicleControlFilename(String vehicle)`
`String`	`getVehicleDisplayName(String vehicleName)`
`String`	`getVehicleDynamicsFilename(String vehicle)`
`int`	`getVehicleIntTypeFromModel(String specialName)`
`String`	`getVehicleType(String vehicle)`
`boolean`	`getWebAutoStart()` get web server autostart flag
`String`	`getWebDocRoot()` get web server document root
`int`	`getWebPort()` get web server port no.
`String`	`getWebUpload()` get web server upload directory
`void`	`loadXML(File file, AUVWorkbenchConfig cfg)` load mission script from a XML file
`void`	`mailTo(String addr, String subj, String cont)`
`boolean`	`runApp(String app, String[] params)`
`boolean`	`runApp(String app, String[] params, boolean waitFor)`
`boolean`	`runApp(String app, String[] params, boolean waitFor, String workingDir)`
`void`	`saveXML(String filename)` save mission script to a XML file
`void`	`setBaudrate(int newValue)` sets the serial communications baudrate
`void`	`setBrowserList(List<String> aLst)` set list of Browser to be written in configuration file
`void`	`setDataBits(int newValue)` sets the serial communications data bits
`void`	`setDirModel(String aDir)` set the directory location for Models
`void`	`setDirScript(String aDir)` set the directory location for Scripts
`void`	`setDisplayInBrowser(boolean newValue)` whether to display in browser or Xj3D
`void`	`setHandshake(boolean newValue)` sets the serial communications handshake
`void`	`setIMDirIn(String sDir)` set the directory to store incoming binary data.
`void`	`setIMDirOut(String sDir)` set the directory to store outgoing binary data (e.g. encoded data in Jabber XHTML message)
`void`	`setIMDomain(String sDomain)` set the Jabber logon domain
`void`	`setIMJID(String sJID)` set the Jabber ID to listen to upon connection
`void`	`setIMNickName(String sNick)` set the Jabber user nickname
`void`	`setIMPort(int iPort)` set Jabber port no.
`void`	`setIMResource(String sResource)` set the Jabber user resource
`void`	`setIMUserName(String sName)` set the Jabber user name
`void`	`setModemInitialized(boolean newValue)` sets whether the serial (acoustic) modem has been initialized
`void`	`setParity(boolean newValue)` sets the serial communications parity
`void`	`setSerialCommsEnabled(boolean newValue)` sets whether the serial communications are enabled for this application
`void`	`setSerialPort(String newValue)` sets the serial communications port name
`void`	`setStopBits(int newValue)` sets the serial communications stop bits
`void`	`show()`
`String`	`toString()`
`void`	`writeLn(String aStr)` write a line to console

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

- Field Detail
  - DEFAULT_XMLFILE
```
public static final String DEFAULT_XMLFILE
```
- Constructor Detail
  - AUVWorkbenchConfig
```
public AUVWorkbenchConfig()
```
    constructor; just initialize local variables
  - AUVWorkbenchConfig
```
public AUVWorkbenchConfig(String fXML)
```
    constructor
    
    Parameters:
    
    fXML - XML to be loaded
- Method Detail
  - getVehicleDisplayName
```
public String getVehicleDisplayName(String vehicleName)
```
  - getVehicleControlFilename
```
public String getVehicleControlFilename(String vehicle)
```
  - getVehicleDynamicsFilename
```
public String getVehicleDynamicsFilename(String vehicle)
```
  - getVehicleType
```
public String getVehicleType(String vehicle)
```
  - getVehicleIntTypeFromModel
```
public int getVehicleIntTypeFromModel(String specialName)
```
  - getDefaultVehicleType
```
public String getDefaultVehicleType(int typ)
```
    Method for determining default: look for the first one that matches the type id
    
    Parameters:
    
    typ - = = UAV, 1 = UUV, etc. (look in Dynamics)
    
    Returns:
    
    standard vehicle name/model string (e.g., Aries)
  - getSupportedVehicles
```
public Set<String> getSupportedVehicles()
```
    returns a set (Strings) of all of the vehicles for which config files have been specified
    
    Returns:
    
    set of vehicles for which configuration files have been specified
  - getDirModel
```
public String getDirModel()
```
    get the directory location for Models
    
    Returns:
    
    Models directory
  - setDirModel
```
public void setDirModel(String aDir)
```
    set the directory location for Models
    
    Parameters:
    
    aDir - directory to be set
  - getDirScript
```
public String getDirScript()
```
    get the directory location for Scripts
    
    Returns:
    
    Models directory
  - setDirScript
```
public void setDirScript(String aDir)
```
    set the directory location for Scripts
    
    Parameters:
    
    aDir - directory to be set
  - getDynamicsDir
```
public String getDynamicsDir()
```
    return directory of Dynamics This is the working directory ("user.dir") when launching dynamics process It doesn't need to be the directory of the dynamics classes, nor should it be. Same for the other methods below
    
    Returns:
    
    String value
  - getDynamicsFilename
```
public String getDynamicsFilename()
```
    return filename of Dynamics
    
    Returns:
    
    String value
  - getDynamicsPath
```
public String getDynamicsPath()
```
    return full path of Dynamics
    
    Returns:
    
    String value
  - getExecutionJavaDirUUV
```
public String getExecutionJavaDirUUV()
```
    return directory of Execution Java
    
    Returns:
    
    String value
  - getExecutionJavaFilenameUUV
```
public String getExecutionJavaFilenameUUV()
```
    return filename of Execution Java
    
    Returns:
    
    String value
  - getExecutionNoThrusterJavaDir
```
public String getExecutionNoThrusterJavaDir()
```
    return directory of Execution (No Thruster) Java
    
    Returns:
    
    String value
  - getExecutionNoThrusterJavaFilename
```
public String getExecutionNoThrusterJavaFilename()
```
    return filename of Execution (No Thruster) Java
    
    Returns:
    
    String value
  - getExecutionJavaDirUGV
```
public String getExecutionJavaDirUGV()
```
    return directory of Execution Java
    
    Returns:
    
    String value
  - getExecutionJavaFilenameUGV
```
public String getExecutionJavaFilenameUGV()
```
    return filename of Execution Java
    
    Returns:
    
    String value
  - getExecutionJavaDirUSV
```
public String getExecutionJavaDirUSV()
```
    return directory of Execution Java
    
    Returns:
    
    String value
  - getExecutionJavaFilenameUSV
```
public String getExecutionJavaFilenameUSV()
```
    return filename of Execution Java
    
    Returns:
    
    String value
  - getExecutionJavaDirUAV
```
public String getExecutionJavaDirUAV()
```
    return directory of Execution Java
    
    Returns:
    
    String value
  - getExecutionJavaFilenameUAV
```
public String getExecutionJavaFilenameUAV()
```
    return filename of Execution Java
    
    Returns:
    
    String value
  - getExecutionJavaDirMUNITION
```
public String getExecutionJavaDirMUNITION()
```
  - getExecutionJavaFilenameMUNITION
```
public String getExecutionJavaFilenameMUNITION()
```
  - getExecutionJavaPathUUV
```
public String getExecutionJavaPathUUV()
```
    return full path of Execution Java
    
    Returns:
    
    String value
  - getExecutionJavaPathUGV
```
public String getExecutionJavaPathUGV()
```
    return full path of Execution Java
    
    Returns:
    
    String value
  - getExecutionJavaPathUSV
```
public String getExecutionJavaPathUSV()
```
    return full path of Execution Java
    
    Returns:
    
    String value
  - getExecutionJavaPathUAV
```
public String getExecutionJavaPathUAV()
```
    return full path of Execution Java
    
    Returns:
    
    String value
  - getExecutionCDir
```
public String getExecutionCDir()
```
    return directory of Execution C
    
    Returns:
    
    String value
  - getExecutionCFilename
```
public String getExecutionCFilename()
```
    return filename of Execution C
    
    Returns:
    
    String value
  - getExecutionCPath
```
public String getExecutionCPath()
```
    return full path of Execution C
    
    Returns:
    
    String value
  - getDisplayInBrowser
```
public boolean getDisplayInBrowser()
```
    whether to display in browser or Xj3D
    
    Returns:
    
    Boolean value
  - getSonarVisEnabled
```
public boolean getSonarVisEnabled()
```
    whether sonar visualization panel is enabled
    
    Returns:
    
    Boolean value
  - getModemInitialized
```
public boolean getModemInitialized()
```
    whether the serial (acoustic) modem has been initialized
    
    Returns:
    
    Boolean value
  - getSerialCommsEnabled
```
public boolean getSerialCommsEnabled()
```
    whether the serial communications are enabled for this application
    
    Returns:
    
    Boolean value
  - getSerialPort
```
public String getSerialPort()
```
    get serial port
    
    Returns:
    
    String value
  - getBaudrate
```
public int getBaudrate()
```
    get baudrate
    
    Returns:
    
    int value
  - getDataBits
```
public int getDataBits()
```
    get data bits
    
    Returns:
    
    int value
  - getStopBits
```
public int getStopBits()
```
    get stop bits
    
    Returns:
    
    int value
  - getParity
```
public boolean getParity()
```
    get parity
    
    Returns:
    
    boolean value
  - getHandshake
```
public boolean getHandshake()
```
    get handshake
    
    Returns:
    
    boolean value
  - getHotKeyList
```
public List<Hotkey> getHotKeyList()
```
    return list of Hotkeys specified in configuration file
    
    Returns:
    
    list of hotkeys "Hotkey" object
  - getIMDirIn
```
public String getIMDirIn()
```
    get the directory to store incoming binary data. (e.g. encoded data in Jabber XHTML message)
    
    Returns:
    
    String value
  - setModemInitialized
```
public void setModemInitialized(boolean newValue)
```
    sets whether the serial (acoustic) modem has been initialized
    
    Parameters:
    
    newValue - Boolean newValue
  - setSerialCommsEnabled
```
public void setSerialCommsEnabled(boolean newValue)
```
    sets whether the serial communications are enabled for this application
    
    Parameters:
    
    newValue -
  - setSerialPort
```
public void setSerialPort(String newValue)
```
    sets the serial communications port name
    
    Parameters:
    
    newValue -
  - setBaudrate
```
public void setBaudrate(int newValue)
```
    sets the serial communications baudrate
    
    Parameters:
    
    newValue -
  - setDataBits
```
public void setDataBits(int newValue)
```
    sets the serial communications data bits
    
    Parameters:
    
    newValue -
  - setStopBits
```
public void setStopBits(int newValue)
```
    sets the serial communications stop bits
    
    Parameters:
    
    newValue -
  - setParity
```
public void setParity(boolean newValue)
```
    sets the serial communications parity
    
    Parameters:
    
    newValue -
  - setHandshake
```
public void setHandshake(boolean newValue)
```
    sets the serial communications handshake
    
    Parameters:
    
    newValue -
  - setDisplayInBrowser
```
public void setDisplayInBrowser(boolean newValue)
```
    whether to display in browser or Xj3D
    
    Parameters:
    
    newValue - value
  - setIMDirIn
```
public void setIMDirIn(String sDir)
```
    set the directory to store incoming binary data. (e.g. encoded data in Jabber XHTML message)
    
    Parameters:
    
    sDir - String value
  - getIMDirOut
```
public String getIMDirOut()
```
    get the directory to store outgoing binary data (e.g. encoded data in Jabber XHTML message)
    
    Returns:
    
    String value
  - setIMDirOut
```
public void setIMDirOut(String sDir)
```
    set the directory to store outgoing binary data (e.g. encoded data in Jabber XHTML message)
    
    Parameters:
    
    sDir - String value
  - getIMDomain
```
public String getIMDomain()
```
    get the Jabber logon domain
    
    Returns:
    
    String value
  - setIMDomain
```
public void setIMDomain(String sDomain)
```
    set the Jabber logon domain
    
    Parameters:
    
    sDomain - String value
  - getIMJID
```
public String getIMJID()
```
    get the Jabber ID to listen to upon connection
    
    Returns:
    
    String value
  - setIMJID
```
public void setIMJID(String sJID)
```
    set the Jabber ID to listen to upon connection
    
    Parameters:
    
    sJID - String value
  - getIMUserName
```
public String getIMUserName()
```
    get the Jabber user name
    
    Returns:
    
    String value
  - setIMUserName
```
public void setIMUserName(String sName)
```
    set the Jabber user name
    
    Parameters:
    
    sName - String value
  - getIMNickName
```
public String getIMNickName()
```
    get the Jabber user nickname
    
    Returns:
    
    String value
  - setIMNickName
```
public void setIMNickName(String sNick)
```
    set the Jabber user nickname
    
    Parameters:
    
    sNick - String value
  - getIMPort
```
public int getIMPort()
```
    get Jabber port no.
    
    Returns:
    
    numeric value
  - setIMPort
```
public void setIMPort(int iPort)
```
    set Jabber port no.
    
    Parameters:
    
    iPort - numeric value
  - getIMResource
```
public String getIMResource()
```
    get the Jabber user resource
    
    Returns:
    
    String value
  - setIMResource
```
public void setIMResource(String sResource)
```
    set the Jabber user resource
    
    Parameters:
    
    sResource - String value
  - getWebAutoStart
```
public boolean getWebAutoStart()
```
    get web server autostart flag
    
    Returns:
    
    boolean value
  - getWebPort
```
public int getWebPort()
```
    get web server port no.
    
    Returns:
    
    numeric value
  - getWebDocRoot
```
public String getWebDocRoot()
```
    get web server document root
    
    Returns:
    
    String value
  - getWebUpload
```
public String getWebUpload()
```
    get web server upload directory
    
    Returns:
    
    String value
  - getAppList
```
public List<ConfigApp> getAppList()
```
    return list of Toolbar applications specified in configuration file
    
    Returns:
    
    list of applications "ConfigApp" object
  - getApp
```
public ConfigApp getApp(String nm)
```
  - runApp
```
public boolean runApp(String app,
                      String[] params)
```
  - runApp
```
public boolean runApp(String app,
                      String[] params,
                      boolean waitFor)
```
  - runApp
```
public boolean runApp(String app,
                      String[] params,
                      boolean waitFor,
                      String workingDir)
```
  - browseTo
```
public boolean browseTo(String url)
```
  - mailTo
```
public void mailTo(String addr,
                   String subj,
                   String cont)
```
  - getBrowserList
```
public List<String> getBrowserList()
```
    return list of browsers specified in configuration file
    
    Returns:
    
    list of browsers
  - setBrowserList
```
public void setBrowserList(List<String> aLst)
```
    set list of Browser to be written in configuration file
    
    Parameters:
    
    aLst - list of Browser
  - addVehicleTypes
```
public int addVehicleTypes(File skeleton)
```
    Add a type (temporarily);
    
    Parameters:
    
    skeleton - vehicle file containing vehicle id
    
    Returns:
    
    Number added
  - loadXML
```
public void loadXML(File file,
                    AUVWorkbenchConfig cfg)
```
    load mission script from a XML file
    
    Parameters:
    
    file - file to be loaded from
    
    cfg -
  - saveXML
```
public void saveXML(String filename)
```
    save mission script to a XML file
    
    Parameters:
    
    filename - file to be loaded from
  - getAttributesForAUV
```
public AUV getAttributesForAUV(Node aNode,
                               String[] sArr)
```
    extract AUV information (XML Attributes) into a AUV object
    
    Parameters:
    
    aNode - affected node
    
    sArr - list of attributes
    
    Returns:
    
    a Mission Point
  - getAttributesForHotKey
```
public Hotkey getAttributesForHotKey(Node aNode,
                                     String[] sArr,
                                     String sData)
```
    extract hotkeys information from tag e.g. Mine located at (100, 100, 5).
    
    Parameters:
    
    aNode - affected node
    
    sArr - list of attributes
    
    sData - data string (stored in node value)
    
    Returns:
    
    created Hotkey
  - getAttributesForWeb
```
public void getAttributesForWeb(Node aNode,
                                String[] sArr)
```
    extract web server information from tag e.g.
    
    Parameters:
    
    aNode - affected node
    
    sArr - list of attributes
  - getAttributesForJabber
```
public void getAttributesForJabber(Node aNode,
                                   String[] sArr)
```
    extract Jabber information from tag e.g.
    
    Parameters:
    
    aNode - affected node
    
    sArr - list of attributes
  - show
```
public void show()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string
  - writeLn
```
public void writeLn(String aStr)
```
    write a line to console
    
    Parameters:
    
    aStr - line to be written to console

Class AUVWorkbenchConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_XMLFILE

Constructor Detail

AUVWorkbenchConfig

AUVWorkbenchConfig

Method Detail

getVehicleDisplayName

getVehicleControlFilename

getVehicleDynamicsFilename

getVehicleType

getVehicleIntTypeFromModel

getDefaultVehicleType

getSupportedVehicles

getDirModel

setDirModel

getDirScript

setDirScript

getDynamicsDir

getDynamicsFilename

getDynamicsPath

getExecutionJavaDirUUV

getExecutionJavaFilenameUUV

getExecutionNoThrusterJavaDir

getExecutionNoThrusterJavaFilename

getExecutionJavaDirUGV

getExecutionJavaFilenameUGV

getExecutionJavaDirUSV

getExecutionJavaFilenameUSV

getExecutionJavaDirUAV

getExecutionJavaFilenameUAV

getExecutionJavaDirMUNITION

getExecutionJavaFilenameMUNITION

getExecutionJavaPathUUV

getExecutionJavaPathUGV

getExecutionJavaPathUSV

getExecutionJavaPathUAV

getExecutionCDir

getExecutionCFilename

getExecutionCPath

getDisplayInBrowser

getSonarVisEnabled

getModemInitialized

getSerialCommsEnabled

getSerialPort

getBaudrate

getDataBits

getStopBits

getParity

getHandshake

getHotKeyList

getIMDirIn

setModemInitialized

setSerialCommsEnabled

setSerialPort

setBaudrate

setDataBits

setStopBits

setParity

setHandshake

setDisplayInBrowser

setIMDirIn

getIMDirOut

setIMDirOut

getIMDomain

setIMDomain

getIMJID

setIMJID

getIMUserName

setIMUserName

getIMNickName

setIMNickName

getIMPort

setIMPort

getIMResource

setIMResource