BAOS SDK  18.2.0
Public Types | Public Member Functions | Static Public Member Functions | List of all members
kdrive::baos::BaosUsbEnumerator Class Reference

Finds all available USB BAOS devices. More...

#include <BaosEnumerator.h>

Public Types

typedef kdrive::utility::PropertyCollection Device
 
typedef std::vector< DeviceDevices
 

Public Member Functions

 BaosUsbEnumerator (bool autoScan=true)
 Creates a Baos Enumerator. More...
 
 ~BaosUsbEnumerator ()
 Destroys the BaosUsbEnumerator. More...
 
const Devicesscan ()
 Searches for usb baos devices. More...
 
const DevicesgetDevices () const
 Returns the list of found devices. More...
 

Static Public Member Functions

static unsigned int getUsbVendorId (const Device &device)
 Returns the USB device vendor ID. More...
 
static unsigned int getUsbProductId (const Device &device)
 Returns the USB device product ID. More...
 
static std::string getUsbManufacturerString (const Device &device)
 Returns the USB manufacturer string. More...
 
static std::string getUsbProductString (const Device &device)
 Returns the USB product string. More...
 
static std::string getUsbSerialNumberString (const Device &device)
 Returns the USB serial number string. More...
 

Detailed Description

Finds all available USB BAOS devices.

Examples:
BaosUsbEnumerator.cpp.

Member Typedef Documentation

typedef kdrive::utility::PropertyCollection kdrive::baos::BaosUsbEnumerator::Device

Constructor & Destructor Documentation

BaosUsbEnumerator::BaosUsbEnumerator ( bool  autoScan = true)

Creates a Baos Enumerator.

If autoScan is true it will automatically scan If false, you will have to explicitly run scan

BaosUsbEnumerator::~BaosUsbEnumerator ( )

Destroys the BaosUsbEnumerator.

Member Function Documentation

const BaosUsbEnumerator::Devices & BaosUsbEnumerator::getDevices ( ) const

Returns the list of found devices.

Examples:
BaosUsbEnumerator.cpp.
std::string BaosUsbEnumerator::getUsbManufacturerString ( const Device device)
static

Returns the USB manufacturer string.

Examples:
BaosUsbEnumerator.cpp.
unsigned int BaosUsbEnumerator::getUsbProductId ( const Device device)
static

Returns the USB device product ID.

Examples:
BaosUsbEnumerator.cpp.
std::string BaosUsbEnumerator::getUsbProductString ( const Device device)
static

Returns the USB product string.

Examples:
BaosUsbEnumerator.cpp.
std::string BaosUsbEnumerator::getUsbSerialNumberString ( const Device device)
static

Returns the USB serial number string.

Examples:
BaosUsbEnumerator.cpp.
unsigned int BaosUsbEnumerator::getUsbVendorId ( const Device device)
static

Returns the USB device vendor ID.

Examples:
BaosUsbEnumerator.cpp.
const BaosUsbEnumerator::Devices & BaosUsbEnumerator::scan ( )

Searches for usb baos devices.


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