Interface for a simple port. More...

Inheritance diagram for 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...

Properties
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
	Raised whenever the simple port receives new data. More...

Detailed Description

Interface for a simple port.

Member Function Documentation

void VectorNav.Communication.ISimplePort.Close ( )

Closes the simple port.

void VectorNav.Communication.ISimplePort.Open ( )

Opens the simple port.

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

Allows reading data from the simple port.

Parameters

buffer	The buffer to place any read bytes.
index	The index to start placing any read bytes.
numOfBytesToRead	The maximum number of bytes to read.

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

Writes out data to the simple port.

Parameters

buffer	The buffer containing the data to write out.
index	The index in the buffer to start writing data out.
length	The number of bytes to write out.

int VectorNav.Communication.ISimplePort.BytesToRead

get

Returns the number of bytes available to read in the received buffer.

bool VectorNav.Communication.ISimplePort.IsOpen

get

Indicates if the simple port is open.

EventHandler VectorNav.Communication.ISimplePort.DataReceived

Raised whenever the simple port receives new data.

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