VectorNav .NET Library
Classes | Static Public Member Functions | List of all members
VectorNav.Sensor.Searcher Class Reference

Helpful class for finding VectorNav sensors. More...

Static Public Member Functions

static bool Search (string portName, out UInt32 foundBaudrate)
 Searches the specified serial port at all valid baudrates for a VectorNav sensor. More...
 
static IEnumerable< Pair< string, UInt32 > > Search ()
 Checks all available serial ports on the system for any VectorNav sensors. More...
 
static IEnumerable< Pair< string, UInt32 > > Search (IEnumerable< string > portsToCheck)
 Checks the provided list of serial ports for any connected VectorNav sensors. More...
 
static bool Test (string portName, UInt32 baudrate)
 Tests if a sensor is connected to the serial port at the specified baudrate. More...
 

Detailed Description

Helpful class for finding VectorNav sensors.

Member Function Documentation

static bool VectorNav.Sensor.Searcher.Search ( string  portName,
out UInt32  foundBaudrate 
)
static

Searches the specified serial port at all valid baudrates for a VectorNav sensor.

Parameters
portNameThe serial port to search.
foundBaudrateIf a sensor is found, this will be set to the baudrate the sensor is communicating at.
Returns
true if a sensor is found; otherwise false.
static IEnumerable<Pair<string, UInt32> > VectorNav.Sensor.Searcher.Search ( )
static

Checks all available serial ports on the system for any VectorNav sensors.

Returns
Collection of serial ports and baudrates for all found sensors.
static IEnumerable<Pair<string, UInt32> > VectorNav.Sensor.Searcher.Search ( IEnumerable< string >  portsToCheck)
static

Checks the provided list of serial ports for any connected VectorNav sensors.

Parameters
portsToCheckList of serial ports to check for sensors.
Returns
Collection of serial ports and baudrates for all found sensors.
static bool VectorNav.Sensor.Searcher.Test ( string  portName,
UInt32  baudrate 
)
static

Tests if a sensor is connected to the serial port at the specified baudrate.

Parameters
portNameThe serial port to test.
baudrateThe baudrate to test at.
Returns
true if a sensor is found; otherwise false.

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