RuntimeFlags (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- execution.RuntimeFlags

public class RuntimeFlags
extends Object

Run-time execution flags and initialization settings. Static variables are globally shared identically among all missions. In general, these variables will be set on startup only. Also contains routines for parsing command-line arguments and configuration file to set these variables.

Version:

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

Latest Modification:


     Date:     10 MAY 2005
     Time:     1015:41
     Author:   Terry Norbraten, NPS MOVES
     Comments: Modified to denote Forward Error Correction (FEC) server
               specific runtime flags

     Date:     16 JUN 2007
     Time:     2153Z
     Author:   Terry Norbraten, NPS MOVES
     Comments: 1) Added additional flag to denote creation of telemetry output
                  from mission execution, or not if just playing back previous
                  mission telemetry

Author:

Duane T. Davis

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RuntimeFlags.ExecutionControlMode
How an execution may be controlled in Execution.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RuntimeFlags.ExecutionControlMode` How an execution may be controlled in Execution.

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`AVCLSCHEMA` schema to be used to decode xsbc mission results (tdn)
`String`	`commsAddress` Multicast address to be used for inter-vehicle communications
`int`	`commsPort` Port to be used for inter-vehicle communications
`String`	`CONTROLCOEFFICIENTSFILE` xml file containing controlCoefficients info
`boolean`	`CREATE_MISSION_TELEMETRY` Create telemetry output
`RuntimeFlags.ExecutionControlMode`	`currentExecutionControlMode`
`static boolean`	`DISPLAY` true if a console is available for message output
`String`	`DYNAMICSCOEFFICIENTSFILE` xml file containing dynamicsCoefficients info
`String`	`DYNAMICSHOST` host for dynamics (virtual world)
`int`	`DYNAMICSPORT` port number on dynamics host for network connection
`boolean`	`ENABLE_OCSX`
`boolean`	`ENABLETEXTOUTPUT` set to true if both xml and text output files are to be generated (just xml if false)
`static boolean`	`ENVIRONMENTALUPDATES` make use of environmental data sources if available
`int`	`FEC_K` FEC Parameter K
`int`	`FEC_N` FEC Parameter N
`int`	`FEC_PACKET_SIZE` FEC Parameter packetSize
`String`	`FECHOST` host on which AUV Workbench is listening for fec traffic
`int`	`FECPORT` port number on fec host for network connection
`boolean`	`FECTRANSFER` Set true if mission results are to be transferred over the network to the AUV Workbench after FEC encoding and in XSBC format.
`double`	`geoOriginLatitude` Latitude of the origin of the Cartesian coordinate system
`double`	`geoOriginLongitude` Longitude of the origin of the Cartesian coordinate system
`boolean`	`geoOriginReset` Flag indicating that the geographic origin has been reset
`int`	`MAXLOOPS` reset mission and start over when mission completed
`int`	`MAXRUNTIME`
`static double`	`MAXSPEEDUPFACTOR` maximum speed-up factor--facilitates synchronization of different execution instances
`boolean`	`METRIC` true if distance measurements are metric (false for British)
`static boolean`	`MULTIPLELOOPSDEFAULT` reset mission and start again once current mission has completed
`boolean`	`MULTIPLELOOPSMISSION` reset mission and start again once current mission has completed
`boolean`	`NETWORKDYNAMICS` set to true if virtual-world is a local object (false if networked)
`String`	`ORDERSOUTFILE` text orders output file
`String`	`OUTPUTDIRECTORY` output file directory
`boolean`	`PAUSE` true if execution run is paused for this mission, false if execution run has resumed for this mission
`static boolean`	`PLANNING_IN_PROGRESS` s
`static boolean`	`REALTIME` run in real time as opposed to best possible run speed
`boolean`	`REPLAY` true if run is replay of an existing telemetry file
`String`	`REPLAYFILE` telemetry file to be used for playback
`String`	`SCHEMA_FOR_FEC` schema to be used to decode fec/xsbc mission results
`String`	`SCRIPTFILE` default mission script file
`boolean`	`TACTICALCONTROL` TODO Dead code, remove once the enum ExecutionControlMode is working
`String`	`TEXTOUTFILE` text telemetry output file
`static boolean`	`TRACE` enable verbose debug messages to console
`int`	`vehicleID` Unique identifier of this vehicle (used when sending and receiving messages
`boolean`	`VIRTUAL` true if run is in the virtual world, false if in water
`String`	`WORKBENCHHOST` host for workbench communications
`int`	`workbenchID` identification for this vehicle utilized to identify it to the AUV Workbench and virtual world
`String`	`WORLDFILE` filename of virtual world X3D file.
`boolean`	`XMLCOMMANDS` true if xml-based script commands are being used
`String`	`XMLOUTFILE` xml telemetry output file (extension added automatically at run time)
`String`	`XSBCHOST` host on which AUV Workbench is listening for xsbc traffic
`int`	`XSBCPORT` port number on xsbc host for network connection
`boolean`	`XSBCTRANSFER` true if mission results are to be transferred over the network to the AUV Workbench in XSBC format

Constructor Summary

Constructors
Constructor and Description

RuntimeFlags(Execution executionVehicle)
Creates a new instance of RuntimeFlags

Constructors
Constructor and Description
`RuntimeFlags(Execution executionVehicle)` Creates a new instance of RuntimeFlags

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getLatitudeFromX(double x)` Method used to compute the Cartesian X coordinate for a specified latitude Computed as the arc distance between the latitude and the geo origin latitude NOTE: This is only an approximation based on a flat earth model and is valid only for locations relatively close to the geographic origin
`double`	`getLongitudeFromY(double latitude, double y)` Method used to compute the Cartesian Y coordinate for a specified longitude Computed as the arc distance between the longitude and the geo origin longitude at the specified latitude NOTE: This is only an approximation based on a flat earth model and is valid only for locations relatively close to the geographic origin
`double`	`getXFromLatitude(double latitude)` Method used to compute the Cartesian X coordinate for a specified latitude Computed as the arc distance between the latitude and the geo origin latitude NOTE: This is only an approximation based on a flat earth model and is valid only for locations relatively close to the geographic origin
`double[]`	`getXy()`
`double`	`getYFromLongitude(double latitude, double longitude)` Method used to compute the Cartesian Y coordinate for a specified longitude Computed as the arc distance between the longitude and the geo origin longitude at the specified latitude NOTE: This is only an approximation based on a flat earth model and is valid only for locations relatively close to the geographic origin
`void`	`setXyFromLatitudeLongitude(double latitude, double longitude)` From a latitude/longitude coordinate, set a local (x, y) point based on a geographic origin

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

- Field Detail
  - TRACE
```
public static boolean TRACE
```
    enable verbose debug messages to console
  - REALTIME
```
public static boolean REALTIME
```
    run in real time as opposed to best possible run speed
  - PLANNING_IN_PROGRESS
```
public static boolean PLANNING_IN_PROGRESS
```
    s
  - ENVIRONMENTALUPDATES
```
public static boolean ENVIRONMENTALUPDATES
```
    make use of environmental data sources if available
  - MAXSPEEDUPFACTOR
```
public static double MAXSPEEDUPFACTOR
```
    maximum speed-up factor--facilitates synchronization of different execution instances
  - DISPLAY
```
public static boolean DISPLAY
```
    true if a console is available for message output
  - MULTIPLELOOPSDEFAULT
```
public static boolean MULTIPLELOOPSDEFAULT
```
    reset mission and start again once current mission has completed
  - MULTIPLELOOPSMISSION
```
public boolean MULTIPLELOOPSMISSION
```
    reset mission and start again once current mission has completed
  - MAXLOOPS
```
public int MAXLOOPS
```
    reset mission and start over when mission completed
  - MAXRUNTIME
```
public int MAXRUNTIME
```
  - XMLCOMMANDS
```
public boolean XMLCOMMANDS
```
    true if xml-based script commands are being used
  - ENABLETEXTOUTPUT
```
public boolean ENABLETEXTOUTPUT
```
    set to true if both xml and text output files are to be generated (just xml if false)
  - currentExecutionControlMode
```
public RuntimeFlags.ExecutionControlMode currentExecutionControlMode
```
  - TACTICALCONTROL
```
public boolean TACTICALCONTROL
```
    TODO Dead code, remove once the enum ExecutionControlMode is working
  - METRIC
```
public boolean METRIC
```
    true if distance measurements are metric (false for British)
  - VIRTUAL
```
public boolean VIRTUAL
```
    true if run is in the virtual world, false if in water
  - REPLAY
```
public boolean REPLAY
```
    true if run is replay of an existing telemetry file
  - PAUSE
```
public boolean PAUSE
```
    true if execution run is paused for this mission, false if execution run has resumed for this mission
  - workbenchID
```
public int workbenchID
```
    identification for this vehicle utilized to identify it to the AUV Workbench and virtual world
  - vehicleID
```
public int vehicleID
```
    Unique identifier of this vehicle (used when sending and receiving messages
  - WORLDFILE
```
public String WORLDFILE
```
    filename of virtual world X3D file. This will be passed to dynamics if it is running as a local object
  - geoOriginReset
```
public boolean geoOriginReset
```
    Flag indicating that the geographic origin has been reset
  - geoOriginLatitude
```
public double geoOriginLatitude
```
    Latitude of the origin of the Cartesian coordinate system
  - geoOriginLongitude
```
public double geoOriginLongitude
```
    Longitude of the origin of the Cartesian coordinate system
  - OUTPUTDIRECTORY
```
public String OUTPUTDIRECTORY
```
    output file directory
  - CONTROLCOEFFICIENTSFILE
```
public String CONTROLCOEFFICIENTSFILE
```
    xml file containing controlCoefficients info
  - DYNAMICSCOEFFICIENTSFILE
```
public String DYNAMICSCOEFFICIENTSFILE
```
    xml file containing dynamicsCoefficients info
  - REPLAYFILE
```
public String REPLAYFILE
```
    telemetry file to be used for playback
  - SCRIPTFILE
```
public String SCRIPTFILE
```
    default mission script file
  - XMLOUTFILE
```
public String XMLOUTFILE
```
    xml telemetry output file (extension added automatically at run time)
  - TEXTOUTFILE
```
public String TEXTOUTFILE
```
    text telemetry output file
  - ORDERSOUTFILE
```
public String ORDERSOUTFILE
```
    text orders output file
  - NETWORKDYNAMICS
```
public boolean NETWORKDYNAMICS
```
    set to true if virtual-world is a local object (false if networked)
  - DYNAMICSHOST
```
public String DYNAMICSHOST
```
    host for dynamics (virtual world)
  - DYNAMICSPORT
```
public int DYNAMICSPORT
```
    port number on dynamics host for network connection
  - WORKBENCHHOST
```
public String WORKBENCHHOST
```
    host for workbench communications
  - XSBCTRANSFER
```
public boolean XSBCTRANSFER
```
    true if mission results are to be transferred over the network to the AUV Workbench in XSBC format
  - XSBCHOST
```
public String XSBCHOST
```
    host on which AUV Workbench is listening for xsbc traffic
  - XSBCPORT
```
public int XSBCPORT
```
    port number on xsbc host for network connection
  - AVCLSCHEMA
```
public String AVCLSCHEMA
```
    schema to be used to decode xsbc mission results (tdn)
  - commsAddress
```
public String commsAddress
```
    Multicast address to be used for inter-vehicle communications
  - commsPort
```
public int commsPort
```
    Port to be used for inter-vehicle communications
  - FECTRANSFER
```
public boolean FECTRANSFER
```
    Set true if mission results are to be transferred over the network to the AUV Workbench after FEC encoding and in XSBC format. Set from the vehicle specific configuration xml file.
  - FECHOST
```
public String FECHOST
```
    host on which AUV Workbench is listening for fec traffic
  - FECPORT
```
public int FECPORT
```
    port number on fec host for network connection
  - SCHEMA_FOR_FEC
```
public String SCHEMA_FOR_FEC
```
    schema to be used to decode fec/xsbc mission results
  - FEC_K
```
public int FEC_K
```
    FEC Parameter K
  - FEC_N
```
public int FEC_N
```
    FEC Parameter N
  - FEC_PACKET_SIZE
```
public int FEC_PACKET_SIZE
```
    FEC Parameter packetSize
  - ENABLE_OCSX
```
public boolean ENABLE_OCSX
```
  - CREATE_MISSION_TELEMETRY
```
public boolean CREATE_MISSION_TELEMETRY
```
    Create telemetry output
- Constructor Detail
  - RuntimeFlags
```
public RuntimeFlags(Execution executionVehicle)
```
    Creates a new instance of RuntimeFlags
    
    Parameters:
    
    executionVehicle - reference to the main class of the vehicle
- Method Detail
  - setXyFromLatitudeLongitude
```
public void setXyFromLatitudeLongitude(double latitude,
                                       double longitude)
```
    From a latitude/longitude coordinate, set a local (x, y) point based on a geographic origin
    
    Parameters:
    
    latitude - the given latitude coordinate
    
    longitude - the given longitude coordinate
  - getXy
```
public double[] getXy()
```
  - getXFromLatitude
```
public double getXFromLatitude(double latitude)
```
    Method used to compute the Cartesian X coordinate for a specified latitude Computed as the arc distance between the latitude and the geo origin latitude NOTE: This is only an approximation based on a flat earth model and is valid only for locations relatively close to the geographic origin
    
    Parameters:
    
    latitude -
    
    Returns:
    
    the Cartesian X coordinate for a specified latitude
  - getLatitudeFromX
```
public double getLatitudeFromX(double x)
```
    Method used to compute the Cartesian X coordinate for a specified latitude Computed as the arc distance between the latitude and the geo origin latitude NOTE: This is only an approximation based on a flat earth model and is valid only for locations relatively close to the geographic origin
    
    Parameters:
    
    x -
    
    Returns:
    
    the Cartesian X coordinate for a specified latitude
  - getYFromLongitude
```
public double getYFromLongitude(double latitude,
                                double longitude)
```
    Method used to compute the Cartesian Y coordinate for a specified longitude Computed as the arc distance between the longitude and the geo origin longitude at the specified latitude NOTE: This is only an approximation based on a flat earth model and is valid only for locations relatively close to the geographic origin
    
    Parameters:
    
    latitude -
    
    longitude -
    
    Returns:
    
    the Cartesian Y coordinate for a specified longitude
  - getLongitudeFromY
```
public double getLongitudeFromY(double latitude,
                                double y)
```
    Method used to compute the Cartesian Y coordinate for a specified longitude Computed as the arc distance between the longitude and the geo origin longitude at the specified latitude NOTE: This is only an approximation based on a flat earth model and is valid only for locations relatively close to the geographic origin
    
    Parameters:
    
    latitude -
    
    y -
    
    Returns:
    
    the longitude for a specified Cartesian Y coordinate

Class RuntimeFlags

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TRACE

REALTIME

PLANNING_IN_PROGRESS

ENVIRONMENTALUPDATES

MAXSPEEDUPFACTOR

DISPLAY

MULTIPLELOOPSDEFAULT

MULTIPLELOOPSMISSION

MAXLOOPS

MAXRUNTIME

XMLCOMMANDS

ENABLETEXTOUTPUT

currentExecutionControlMode

TACTICALCONTROL

METRIC

VIRTUAL

REPLAY

PAUSE

workbenchID

vehicleID

WORLDFILE

geoOriginReset

geoOriginLatitude

geoOriginLongitude

OUTPUTDIRECTORY

CONTROLCOEFFICIENTSFILE

DYNAMICSCOEFFICIENTSFILE

REPLAYFILE

SCRIPTFILE

XMLOUTFILE

TEXTOUTFILE

ORDERSOUTFILE

NETWORKDYNAMICS

DYNAMICSHOST

DYNAMICSPORT

WORKBENCHHOST

XSBCTRANSFER

XSBCHOST

XSBCPORT

AVCLSCHEMA

commsAddress

commsPort

FECTRANSFER

FECHOST

FECPORT

SCHEMA_FOR_FEC

FEC_K

FEC_N

FEC_PACKET_SIZE

ENABLE_OCSX

CREATE_MISSION_TELEMETRY

Constructor Detail

RuntimeFlags

Method Detail

setXyFromLatitudeLongitude

getXy

getXFromLatitude

getLatitudeFromX

getYFromLongitude

getLongitudeFromY