vrLib SDK Documentation
CommPort Class
NamespacesVideoRay.CommunicationCommPort
Abstracts Serial Port handling while providing a bit nicer interface
Declaration Syntax
C#Visual BasicVisual C++
public class CommPort : IDisposable
Public Class CommPort _
	Implements IDisposable
public ref class CommPort : IDisposable
Members
All MembersConstructorsMethodsPropertiesFieldsEvents



IconMemberDescription
CommPort()()()
Initializes a new instance of the CommPort class

Check(String)
Check to see if a port can be opened.

Close()()()
Close the serial port

DefaultBaudRate
Standard baudrate

DiscardBuffers()()()
If port is open flush both the in and out buffers

Dispose()()()
Implement IDisposable

EnumeratePorts(Boolean)
List the comm ports available on a system.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ForceStopEnumerating
Flag to terminate an ennumeration sequence which can possibly take a while.

GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
IsOpen
Gets a value indicating whether the port is open.

Open(String, Int32, Boolean)
Open a serial port a specified baudrate

Open(String)
Open a serial port at the default baudrate

OpenPolled(String)
Open a serial port at the default baudrate in polled mode

ReadTimeout
Set read timeout in mS

ReceivedData
Event fires on reception of serial port data

RxCount
Get the number of bytes in the recieve buffer This is used for polled operation

RxData
Get the data in the recieve buffer This is used for polled operation

SimpleName
Simple name of the fome COM#

ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Write(array<Byte>[]()[])
Send data out the serial port

Write(Byte)
Send a single byte of data out the serial port

WriteTimeout
Set write timeout in mS

Inheritance Hierarchy
Object
CommPort

Assembly: vrLib (Module: vrLib) Version: 2.0.1.0 (2.0.1.0)