RemusDictionary (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- workbench.cfgParser.Dictionary
- - workbench.cfgParser.RemusDictionary

```
public class RemusDictionary
extends Dictionary
```
Context free grammar rule set for Remus AUV command language

Author:

christine@aniviza.com

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALTITUDE_KEYWORD`
`static int`	`ATTRIBUTE`
`static int`	`ATTRIBUTES`
`static int`	`AUTO_CAL_DEPTH_KEYWORD`
`static int`	`AUTO_TIMEOUT_KEYWORD`
`static int`	`BOOLEAN`
`static int`	`CLEAR_CALIBRATION_KEYWORD`
`static int`	`DEPTH_CONTROL_MODE_KEYWORD`
`static int`	`DEPTH_KEYWORD`
`static int`	`FILE_KEYWORD`
`static int`	`FIRST_TURN_LEFT_KEYWORD`
`static int`	`FOLLOW_TRACKLINE_KEYWORD`
`static int`	`LABEL_KEYWORD`
`static int`	`LATITUDE_KEYWORD`
`static int`	`LINE_SPACING_KEYWORD`
`static int`	`LOCATION`
`static int`	`LOCATION_LIST`
`static int`	`LOCATION_TOKEN`
`static int`	`LONGITUDE_KEYWORD`
`static int`	`MINIMUM_RANGE_KEYWORD`
`static int`	`MISSION`
`static int`	`MOVE_AWAY_DURATION_KEYWORD`
`static int`	`NULL_LOCATION`
`static int`	`NULL_LOCATION_PARAMETER`
`static int`	`NULL_WAYPOINT_KEYWORD`
`static int`	`NUMBER`
`static int`	`NUMBER_OF_ROWS_KEYWORD`
`static int`	`OBJECTIVE`
`static int`	`OBJECTIVE_LIST`
`static int`	`OBJECTIVE_TOKEN`
`static int`	`OFFSET_DIRECTION_KEYWORD`
`static int`	`OFFSET_DISTANCE_KEYWORD`
`static int`	`OFFSET_Y_AXIS_KEYWORD`
`static int`	`POSITION_REFERENCE_KEYWORD`
`static int`	`REQUIRED_DEPTH_KEYWORD`
`static int`	`REQUIRED_RPM_KEYWORD`
`static int`	`SHOREWARD_LEG_MINIMUM_KEYWORD`
`static int`	`SIDESCAN_RANGE_KEYWORD`
`static int`	`SPEED_KEYWORD`
`static int`	`STRING`
`static int`	`TIMEOUT_CROSS_AXIS_LEGS_KEYWORD`
`static int`	`TIMEOUT_CROSS_AXIS_SEC_KEYWORD`
`static int`	`TIMEOUT_KEYWORD`
`static int`	`TRACK_PING_INTERVAL_KEYWORD`
`static int`	`TRACKLINE_PERCENTAGE_KEYWORD`
`static int`	`TRANSPONDER_DEPTH_KEYWORD`
`static int`	`TRIANGLE_ALTITUDE_KEYWORD`
`static int`	`TRIANGLE_MAXIMUM_KEYWORD`
`static int`	`TRIANGLE_MINIMUM_KEYWORD`
`static int`	`TRIANGLE_RATE_KEYWORD`
`static int`	`TYPE_KEYWORD`
`static int`	`VERIFY_TRANSPONDER_RANGE_KEYWORD`

Fields inherited from class workbench.cfgParser.Dictionary
FAIL_PARSE, numTerminals

Constructor Summary

Constructors
Constructor and Description

RemusDictionary()
Creates a new instance of RemusDictionary

Constructors
Constructor and Description
`RemusDictionary()` Creates a new instance of RemusDictionary

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

int lookup(String token)
Looks up a word in the dictionary and returns its part of speech.
- Methods inherited from class workbench.cfgParser.Dictionary
  put
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`lookup(String token)` Looks up a word in the dictionary and returns its part of speech.

- Field Detail
  - MISSION
```
public static final int MISSION
```
    See Also:
    
    Constant Field Values
  - LOCATION
```
public static final int LOCATION
```
    See Also:
    
    Constant Field Values
  - LOCATION_LIST
```
public static final int LOCATION_LIST
```
    See Also:
    
    Constant Field Values
  - NULL_LOCATION
```
public static final int NULL_LOCATION
```
    See Also:
    
    Constant Field Values
  - NULL_LOCATION_PARAMETER
```
public static final int NULL_LOCATION_PARAMETER
```
    See Also:
    
    Constant Field Values
  - OBJECTIVE
```
public static final int OBJECTIVE
```
    See Also:
    
    Constant Field Values
  - OBJECTIVE_LIST
```
public static final int OBJECTIVE_LIST
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTES
```
public static final int ATTRIBUTES
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE
```
public static final int ATTRIBUTE
```
    See Also:
    
    Constant Field Values
  - NUMBER
```
public static final int NUMBER
```
    See Also:
    
    Constant Field Values
  - STRING
```
public static final int STRING
```
    See Also:
    
    Constant Field Values
  - BOOLEAN
```
public static final int BOOLEAN
```
    See Also:
    
    Constant Field Values
  - LOCATION_TOKEN
```
public static final int LOCATION_TOKEN
```
    See Also:
    
    Constant Field Values
  - OBJECTIVE_TOKEN
```
public static final int OBJECTIVE_TOKEN
```
    See Also:
    
    Constant Field Values
  - TYPE_KEYWORD
```
public static final int TYPE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - LABEL_KEYWORD
```
public static final int LABEL_KEYWORD
```
    See Also:
    
    Constant Field Values
  - OFFSET_DISTANCE_KEYWORD
```
public static final int OFFSET_DISTANCE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - OFFSET_Y_AXIS_KEYWORD
```
public static final int OFFSET_Y_AXIS_KEYWORD
```
    See Also:
    
    Constant Field Values
  - OFFSET_DIRECTION_KEYWORD
```
public static final int OFFSET_DIRECTION_KEYWORD
```
    See Also:
    
    Constant Field Values
  - LATITUDE_KEYWORD
```
public static final int LATITUDE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - LONGITUDE_KEYWORD
```
public static final int LONGITUDE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - POSITION_REFERENCE_KEYWORD
```
public static final int POSITION_REFERENCE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - TRANSPONDER_DEPTH_KEYWORD
```
public static final int TRANSPONDER_DEPTH_KEYWORD
```
    See Also:
    
    Constant Field Values
  - FILE_KEYWORD
```
public static final int FILE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - SPEED_KEYWORD
```
public static final int SPEED_KEYWORD
```
    See Also:
    
    Constant Field Values
  - MINIMUM_RANGE_KEYWORD
```
public static final int MINIMUM_RANGE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - DEPTH_CONTROL_MODE_KEYWORD
```
public static final int DEPTH_CONTROL_MODE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - TIMEOUT_KEYWORD
```
public static final int TIMEOUT_KEYWORD
```
    See Also:
    
    Constant Field Values
  - FOLLOW_TRACKLINE_KEYWORD
```
public static final int FOLLOW_TRACKLINE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - TRACK_PING_INTERVAL_KEYWORD
```
public static final int TRACK_PING_INTERVAL_KEYWORD
```
    See Also:
    
    Constant Field Values
  - SIDESCAN_RANGE_KEYWORD
```
public static final int SIDESCAN_RANGE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - TRACKLINE_PERCENTAGE_KEYWORD
```
public static final int TRACKLINE_PERCENTAGE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - NUMBER_OF_ROWS_KEYWORD
```
public static final int NUMBER_OF_ROWS_KEYWORD
```
    See Also:
    
    Constant Field Values
  - FIRST_TURN_LEFT_KEYWORD
```
public static final int FIRST_TURN_LEFT_KEYWORD
```
    See Also:
    
    Constant Field Values
  - LINE_SPACING_KEYWORD
```
public static final int LINE_SPACING_KEYWORD
```
    See Also:
    
    Constant Field Values
  - TIMEOUT_CROSS_AXIS_SEC_KEYWORD
```
public static final int TIMEOUT_CROSS_AXIS_SEC_KEYWORD
```
    See Also:
    
    Constant Field Values
  - TIMEOUT_CROSS_AXIS_LEGS_KEYWORD
```
public static final int TIMEOUT_CROSS_AXIS_LEGS_KEYWORD
```
    See Also:
    
    Constant Field Values
  - SHOREWARD_LEG_MINIMUM_KEYWORD
```
public static final int SHOREWARD_LEG_MINIMUM_KEYWORD
```
    See Also:
    
    Constant Field Values
  - MOVE_AWAY_DURATION_KEYWORD
```
public static final int MOVE_AWAY_DURATION_KEYWORD
```
    See Also:
    
    Constant Field Values
  - CLEAR_CALIBRATION_KEYWORD
```
public static final int CLEAR_CALIBRATION_KEYWORD
```
    See Also:
    
    Constant Field Values
  - REQUIRED_DEPTH_KEYWORD
```
public static final int REQUIRED_DEPTH_KEYWORD
```
    See Also:
    
    Constant Field Values
  - REQUIRED_RPM_KEYWORD
```
public static final int REQUIRED_RPM_KEYWORD
```
    See Also:
    
    Constant Field Values
  - NULL_WAYPOINT_KEYWORD
```
public static final int NULL_WAYPOINT_KEYWORD
```
    See Also:
    
    Constant Field Values
  - AUTO_CAL_DEPTH_KEYWORD
```
public static final int AUTO_CAL_DEPTH_KEYWORD
```
    See Also:
    
    Constant Field Values
  - VERIFY_TRANSPONDER_RANGE_KEYWORD
```
public static final int VERIFY_TRANSPONDER_RANGE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - DEPTH_KEYWORD
```
public static final int DEPTH_KEYWORD
```
    See Also:
    
    Constant Field Values
  - ALTITUDE_KEYWORD
```
public static final int ALTITUDE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - TRIANGLE_MINIMUM_KEYWORD
```
public static final int TRIANGLE_MINIMUM_KEYWORD
```
    See Also:
    
    Constant Field Values
  - TRIANGLE_MAXIMUM_KEYWORD
```
public static final int TRIANGLE_MAXIMUM_KEYWORD
```
    See Also:
    
    Constant Field Values
  - TRIANGLE_RATE_KEYWORD
```
public static final int TRIANGLE_RATE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - TRIANGLE_ALTITUDE_KEYWORD
```
public static final int TRIANGLE_ALTITUDE_KEYWORD
```
    See Also:
    
    Constant Field Values
  - AUTO_TIMEOUT_KEYWORD
```
public static final int AUTO_TIMEOUT_KEYWORD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RemusDictionary
```
public RemusDictionary()
```
    Creates a new instance of RemusDictionary
- Method Detail
  - lookup
```
public int lookup(String token)
```
    Looks up a word in the dictionary and returns its part of speech. Overload of super method in order to deal with numerical terminals.
    
    Overrides:
    
    lookup in class Dictionary
    
    Parameters:
    
    token - to be looked up
    
    Returns:
    
    dictionary index or FAIL_PARSE

Class RemusDictionary

Field Summary

Fields inherited from class workbench.cfgParser.Dictionary

Constructor Summary

Method Summary

Methods inherited from class workbench.cfgParser.Dictionary

Methods inherited from class java.lang.Object

Field Detail

MISSION

LOCATION

LOCATION_LIST

NULL_LOCATION

NULL_LOCATION_PARAMETER

OBJECTIVE

OBJECTIVE_LIST

ATTRIBUTES

ATTRIBUTE

NUMBER

STRING

BOOLEAN

LOCATION_TOKEN

OBJECTIVE_TOKEN

TYPE_KEYWORD

LABEL_KEYWORD

OFFSET_DISTANCE_KEYWORD

OFFSET_Y_AXIS_KEYWORD

OFFSET_DIRECTION_KEYWORD

LATITUDE_KEYWORD

LONGITUDE_KEYWORD

POSITION_REFERENCE_KEYWORD

TRANSPONDER_DEPTH_KEYWORD

FILE_KEYWORD

SPEED_KEYWORD

MINIMUM_RANGE_KEYWORD

DEPTH_CONTROL_MODE_KEYWORD

TIMEOUT_KEYWORD

FOLLOW_TRACKLINE_KEYWORD

TRACK_PING_INTERVAL_KEYWORD

SIDESCAN_RANGE_KEYWORD

TRACKLINE_PERCENTAGE_KEYWORD

NUMBER_OF_ROWS_KEYWORD

FIRST_TURN_LEFT_KEYWORD

LINE_SPACING_KEYWORD

TIMEOUT_CROSS_AXIS_SEC_KEYWORD

TIMEOUT_CROSS_AXIS_LEGS_KEYWORD

SHOREWARD_LEG_MINIMUM_KEYWORD

MOVE_AWAY_DURATION_KEYWORD

CLEAR_CALIBRATION_KEYWORD

REQUIRED_DEPTH_KEYWORD

REQUIRED_RPM_KEYWORD

NULL_WAYPOINT_KEYWORD

AUTO_CAL_DEPTH_KEYWORD

VERIFY_TRANSPONDER_RANGE_KEYWORD

DEPTH_KEYWORD

ALTITUDE_KEYWORD

TRIANGLE_MINIMUM_KEYWORD

TRIANGLE_MAXIMUM_KEYWORD

TRIANGLE_RATE_KEYWORD

TRIANGLE_ALTITUDE_KEYWORD

AUTO_TIMEOUT_KEYWORD

Constructor Detail

RemusDictionary

Method Detail

lookup