WorkbenchCommunicator (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- execution.network.WorkbenchCommunicator

```
public class WorkbenchCommunicator
extends Object
```
Implements a simple networked communications link between this execution object and the workbench

Since:

09 November 2004

Version:

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

Author:

Duane Davis

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`COMMSERVER_PORT` Port number to which communicator will connect This declaration is flipped--used to be in ExecutionCommServer, but if we put it here, compilation of the execution package does not depend on the workbench package, whereas the reverse does, by necessity
`static String`	`MSG_AGENDA_GOAL`
`static String`	`MSG_AGENDA_GOALNEW`
`static String`	`MSG_AGENDA_META`
`static String`	`MSG_AGENDA_SCRIPTCMD`
`static String`	`MSG_AGENDA_VEHICLE_STATUS`
`static String`	`MSG_AGENDAEVENT`
`static String`	`MSG_CMDCOMPLETE`
`static String`	`MSG_DISPACKET`
`static String`	`MSG_ENDEXECUTION`
`static String`	`MSG_EXECUTIONID`
`static String`	`MSG_GETPICKRESULTS`
`static String`	`MSG_MAKEPICKERS`
`static String`	`MSG_MUNITION_NEWTRACK`
`static String`	`MSG_NEXTCMD`
`static String`	`MSG_NOPICK`
`static String`	`MSG_PICKRESULT`
`static String`	`MSG_POSITION`
`static String`	`MSG_REALTIME_FALSE`
`static String`	`MSG_REALTIME_TRUE`
`static String`	`MSG_SETPICK`
`static String`	`MSG_STARTCMD`
`static String`	`MSG_STATEREPORT`
`static String`	`MSG_STATEREPORT_NAMES`
`static String`	`MSG_TELEMETRY_FILE_AVAILABLE`
`static String`	`MSG_TELEMETRYFIX`

Constructor Summary

Constructors
Constructor and Description

WorkbenchCommunicator(Execution vehicleExecution)
Creates a new instance of WorkbenchCommunicator

Constructors
Constructor and Description
`WorkbenchCommunicator(Execution vehicleExecution)` Creates a new instance of WorkbenchCommunicator

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`closeWorkbenchChannel()` Close communications
`String`	`readFromWorkbench(boolean block)` Reads a message from the workbench
`void`	`writeToWorkbench(String message)` writes a message to the workbench

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

- Field Detail
  - MSG_DISPACKET
```
public static final String MSG_DISPACKET
```
    See Also:
    
    Constant Field Values
  - MSG_MAKEPICKERS
```
public static final String MSG_MAKEPICKERS
```
    See Also:
    
    Constant Field Values
  - MSG_SETPICK
```
public static final String MSG_SETPICK
```
    See Also:
    
    Constant Field Values
  - MSG_NEXTCMD
```
public static final String MSG_NEXTCMD
```
    See Also:
    
    Constant Field Values
  - MSG_CMDCOMPLETE
```
public static final String MSG_CMDCOMPLETE
```
    See Also:
    
    Constant Field Values
  - MSG_STARTCMD
```
public static final String MSG_STARTCMD
```
    See Also:
    
    Constant Field Values
  - MSG_EXECUTIONID
```
public static final String MSG_EXECUTIONID
```
    See Also:
    
    Constant Field Values
  - MSG_GETPICKRESULTS
```
public static final String MSG_GETPICKRESULTS
```
    See Also:
    
    Constant Field Values
  - MSG_PICKRESULT
```
public static final String MSG_PICKRESULT
```
    See Also:
    
    Constant Field Values
  - MSG_NOPICK
```
public static final String MSG_NOPICK
```
    See Also:
    
    Constant Field Values
  - MSG_POSITION
```
public static final String MSG_POSITION
```
    See Also:
    
    Constant Field Values
  - MSG_TELEMETRYFIX
```
public static final String MSG_TELEMETRYFIX
```
    See Also:
    
    Constant Field Values
  - MSG_ENDEXECUTION
```
public static final String MSG_ENDEXECUTION
```
    See Also:
    
    Constant Field Values
  - MSG_STATEREPORT_NAMES
```
public static final String MSG_STATEREPORT_NAMES
```
    See Also:
    
    Constant Field Values
  - MSG_STATEREPORT
```
public static final String MSG_STATEREPORT
```
    See Also:
    
    Constant Field Values
  - MSG_AGENDAEVENT
```
public static final String MSG_AGENDAEVENT
```
    See Also:
    
    Constant Field Values
  - MSG_AGENDA_GOAL
```
public static final String MSG_AGENDA_GOAL
```
    See Also:
    
    Constant Field Values
  - MSG_AGENDA_GOALNEW
```
public static final String MSG_AGENDA_GOALNEW
```
    See Also:
    
    Constant Field Values
  - MSG_AGENDA_META
```
public static final String MSG_AGENDA_META
```
    See Also:
    
    Constant Field Values
  - MSG_AGENDA_SCRIPTCMD
```
public static final String MSG_AGENDA_SCRIPTCMD
```
    See Also:
    
    Constant Field Values
  - MSG_AGENDA_VEHICLE_STATUS
```
public static final String MSG_AGENDA_VEHICLE_STATUS
```
    See Also:
    
    Constant Field Values
  - MSG_MUNITION_NEWTRACK
```
public static final String MSG_MUNITION_NEWTRACK
```
    See Also:
    
    Constant Field Values
  - MSG_TELEMETRY_FILE_AVAILABLE
```
public static final String MSG_TELEMETRY_FILE_AVAILABLE
```
    See Also:
    
    Constant Field Values
  - MSG_REALTIME_TRUE
```
public static final String MSG_REALTIME_TRUE
```
    See Also:
    
    Constant Field Values
  - MSG_REALTIME_FALSE
```
public static final String MSG_REALTIME_FALSE
```
    See Also:
    
    Constant Field Values
  - COMMSERVER_PORT
```
public static final int COMMSERVER_PORT
```
    Port number to which communicator will connect This declaration is flipped--used to be in ExecutionCommServer, but if we put it here, compilation of the execution package does not depend on the workbench package, whereas the reverse does, by necessity
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WorkbenchCommunicator
```
public WorkbenchCommunicator(Execution vehicleExecution)
```
    Creates a new instance of WorkbenchCommunicator
    
    Parameters:
    
    vehicleExecution - Execution class instance
- Method Detail
  - writeToWorkbench
```
public void writeToWorkbench(String message)
```
    writes a message to the workbench
    
    Parameters:
    
    message - to send to the workbench
  - readFromWorkbench
```
public String readFromWorkbench(boolean block)
```
    Reads a message from the workbench
    
    Parameters:
    
    block - method will block if the reader isn't ready if this is true. will not block if false.
    
    Returns:
    
    a message from the workbench
  - closeWorkbenchChannel
```
public void closeWorkbenchChannel()
```
    Close communications

Class WorkbenchCommunicator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MSG_DISPACKET

MSG_MAKEPICKERS

MSG_SETPICK

MSG_NEXTCMD

MSG_CMDCOMPLETE

MSG_STARTCMD

MSG_EXECUTIONID

MSG_GETPICKRESULTS

MSG_PICKRESULT

MSG_NOPICK

MSG_POSITION

MSG_TELEMETRYFIX

MSG_ENDEXECUTION

MSG_STATEREPORT_NAMES

MSG_STATEREPORT

MSG_AGENDAEVENT

MSG_AGENDA_GOAL

MSG_AGENDA_GOALNEW

MSG_AGENDA_META

MSG_AGENDA_SCRIPTCMD

MSG_AGENDA_VEHICLE_STATUS

MSG_MUNITION_NEWTRACK

MSG_TELEMETRY_FILE_AVAILABLE

MSG_REALTIME_TRUE

MSG_REALTIME_FALSE

COMMSERVER_PORT

Constructor Detail

WorkbenchCommunicator

Method Detail

writeToWorkbench

readFromWorkbench

closeWorkbenchChannel