VectorNav .NET Library
Public Member Functions | Properties | Events | List of all members
VectorNav.Communication.AutoConnectPort Class Reference
Inheritance diagram for VectorNav.Communication.AutoConnectPort:
VectorNav.Communication.ISimplePort

Public Member Functions

void Open ()
 Opens the simple port. More...
 
void Close ()
 Closes the simple port. More...
 
void Write (byte[] buffer, int index, int length)
 Writes out data to the simple port. More...
 
int Read (byte[] buffer, int index, int numOfBytesToRead)
 Allows reading data from the simple port. More...
 
void Start ()
 
void Stop ()
 
void Update ()
 
void Destroy ()
 

Properties

bool IsOpen [get]
 
int BytesToRead [get]
 
- Properties inherited from VectorNav.Communication.ISimplePort
bool IsOpen [get]
 Indicates if the simple port is open. More...
 
int BytesToRead [get]
 Returns the number of bytes available to read in the received buffer. More...
 

Events

EventHandler DataReceived
 
- Events inherited from VectorNav.Communication.ISimplePort
EventHandler DataReceived
 Raised whenever the simple port receives new data. More...
 

Member Function Documentation

void VectorNav.Communication.AutoConnectPort.Close ( )

Closes the simple port.

Implements VectorNav.Communication.ISimplePort.

void VectorNav.Communication.AutoConnectPort.Open ( )

Opens the simple port.

Implements VectorNav.Communication.ISimplePort.

int VectorNav.Communication.AutoConnectPort.Read ( byte[]  buffer,
int  index,
int  numOfBytesToRead 
)

Allows reading data from the simple port.

Parameters
bufferThe buffer to place any read bytes.
indexThe index to start placing any read bytes.
numOfBytesToReadThe maximum number of bytes to read.
Returns
The actual number of bytes read.

Implements VectorNav.Communication.ISimplePort.

void VectorNav.Communication.AutoConnectPort.Write ( byte[]  buffer,
int  index,
int  length 
)

Writes out data to the simple port.

Parameters
bufferThe buffer containing the data to write out.
indexThe index in the buffer to start writing data out.
lengthThe number of bytes to write out.

Implements VectorNav.Communication.ISimplePort.


The documentation for this class was generated from the following file: