VWConnection (Autonomous Unmanned Vehicle (AUV) Workbench Documentation)

java.lang.Object
- execution.network.VWConnection

Direct Known Subclasses:

AuvVWConnection, DisVWConnection, MunitionVWConnection, UavVWConnection, UgvVWConnection, UsvVWConnection
```
public abstract class VWConnection
extends Object
```
Handles network communication between the vehicle and the virtual world as required Simulates network comms if Execution and Dynamics are run in same thread Class must be extended to implement model/vehicle-specific telemetry strings

Field Summary

Fields
Modifier and Type	Field and Description
`static int[]`	`DYNAMICSPORTS`
`protected String`	`dynamicsResponse`
`protected boolean`	`networked`
`protected String`	`telemetryString` Telemetry string that will be read from dynamics.
`static int`	`UAV`
`static int`	`UGV`
`static int`	`UUV`
`protected Execution`	`vehicle` reference to main vehicle object
`static int`	`VEHICLE_TYPE_PORT_OFFSET`
`int`	`VWVECTORSIZE` Number of variables in the virtual world state vector
`protected int`	`vwWrites` counter to determine whether or not to print telemetry summary following write

Constructor Summary

Constructors
Constructor and Description

VWConnection(Execution vehicle)

Constructors
Constructor and Description
`VWConnection(Execution vehicle)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`openConnection(String host, int port)` Opens a socket between the execution object and a networked dynamics object
`String`	`readFromVW()` reads a string from the virtual world
`abstract void`	`readTelemetryFromVW()` reads a new uv telemetry from the virtual world as a space-delimited string and parses it into the uv's vwState object
`abstract void`	`writeTelemetryToVW()` writes the uv telemetry to the virtual world via a DIS connection sans Dynamics calculations
`abstract void`	`writeToVW(String message)`
`void`	`writeToVWSocket(String message)` writes a string over the network to the virtual world

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

- Field Detail
  - vehicle
```
protected Execution vehicle
```
    reference to main vehicle object
  - VWVECTORSIZE
```
public final int VWVECTORSIZE
```
    Number of variables in the virtual world state vector
    
    See Also:
    
    Constant Field Values
  - DYNAMICSPORTS
```
public static final int[] DYNAMICSPORTS
```
  - UUV
```
public static final int UUV
```
    See Also:
    
    Constant Field Values
  - UGV
```
public static final int UGV
```
    See Also:
    
    Constant Field Values
  - UAV
```
public static final int UAV
```
    See Also:
    
    Constant Field Values
  - VEHICLE_TYPE_PORT_OFFSET
```
public static final int VEHICLE_TYPE_PORT_OFFSET
```
    See Also:
    
    Constant Field Values
  - telemetryString
```
protected String telemetryString
```
    Telemetry string that will be read from dynamics.
  - vwWrites
```
protected int vwWrites
```
    counter to determine whether or not to print telemetry summary following write
  - dynamicsResponse
```
protected String dynamicsResponse
```
  - networked
```
protected boolean networked
```
- Constructor Detail
  - VWConnection
```
public VWConnection(Execution vehicle)
```
- Method Detail
  - writeTelemetryToVW
```
public abstract void writeTelemetryToVW()
```
    writes the uv telemetry to the virtual world via a DIS connection sans Dynamics calculations
  - readTelemetryFromVW
```
public abstract void readTelemetryFromVW()
```
    reads a new uv telemetry from the virtual world as a space-delimited string and parses it into the uv's vwState object
  - writeToVW
```
public abstract void writeToVW(String message)
```
  - openConnection
```
public void openConnection(String host,
                           int port)
```
    Opens a socket between the execution object and a networked dynamics object
    
    Parameters:
    
    host - name of virtual world host
    
    port - on remote dynamics object to communicate with
  - writeToVWSocket
```
public void writeToVWSocket(String message)
```
    writes a string over the network to the virtual world
    
    Parameters:
    
    message - to be written
  - readFromVW
```
public String readFromVW()
```
    reads a string from the virtual world
    
    Returns:
    
    String read from virtual world

Class VWConnection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

vehicle

VWVECTORSIZE

DYNAMICSPORTS

UUV

UGV

UAV

VEHICLE_TYPE_PORT_OFFSET

telemetryString

vwWrites

dynamicsResponse

networked

Constructor Detail

VWConnection

Method Detail

writeTelemetryToVW

readTelemetryFromVW

writeToVW

openConnection

writeToVWSocket

readFromVW