FTDI_Scanner Class Reference

A Scanner class. More...

#include <scanner.hpp>

Public Member Functions
std::vector< struct usb_device * >	find_devices (uint16_t vendor, uint16_t product)
int	get_manufacturer (unsigned int index, std::string &manufacturer)
int	get_manufacturer (std::string &manufacturer)
int	get_product (unsigned int index, std::string &product)
int	get_product (std::string &product)
int	get_serial_id (unsigned int index, std::string &serial_id)
int	get_serial_id (std::string &serial_id)
int	reset ()
int	retrieve ()
int	scan ()

Private Attributes
std::vector< std::map< std::string, std::string > >	descriptions
std::vector< struct usb_device * >	devices
bool	retrieved
bool	scanned

Detailed Description

A Scanner class.

A Scanner class for FTDI device.

Definition at line 56 of file scanner.hpp.

Member Function Documentation

std::vector<struct usb_device *> FTDI_Scanner::find_devices ( uint16_t  vendor, uint16_t  product  )

inline

find_devices with given vendor and device id by using libusb library

Parameters

[in]	vendor	vendor id of targeted usb device
[in]	product	product id of targeted usb device

Returns

vector of usb_device structure found.

Definition at line 64 of file scanner.hpp.

int FTDI_Scanner::get_manufacturer ( unsigned int  index, std::string &  manufacturer  )

inline

Parameters

[in]	index	index of scanned device
[out]	manufacturer	manufacturer name of ftdi device

Returns

0 on success
-1 on failure

See also

get_serial_id(unsigned int, std::string&), get_serial_id(std::string&) , get_manufacturer(unsigned int, std::string&), get_manufacturer(std::string&) , get_product(unsigned int, std::string&), get_product(std::string&)

Definition at line 158 of file scanner.hpp.

int FTDI_Scanner::get_manufacturer ( std::string &  manufacturer )

inline

Parameters

[out]

manufacturer

manufacturer name of of ftdi device

Returns

0 on success
-1 on failure

See also

get_serial_id(unsigned int, std::string&), get_serial_id(std::string&) , get_manufacturer(unsigned int, std::string&), get_manufacturer(std::string&) , get_product(unsigned int, std::string&), get_product(std::string&)

Definition at line 196 of file scanner.hpp.

int FTDI_Scanner::get_product ( unsigned int  index, std::string &  product  )

inline

Parameters

[in]	index	index of scanned device
[out]	product	product name of ftdi device

Returns

0 on success
-1 on failure

See also

get_serial_id(unsigned int, std::string&), get_serial_id(std::string&) , get_manufacturer(unsigned int, std::string&), get_manufacturer(std::string&) , get_product(unsigned int, std::string&), get_product(std::string&)

Definition at line 173 of file scanner.hpp.

int FTDI_Scanner::get_product ( std::string &  product )

inline

Parameters

[out]

product

product name of of ftdi device

Returns

0 on success
-1 on failure

See also

get_serial_id(unsigned int, std::string&), get_serial_id(std::string&) , get_manufacturer(unsigned int, std::string&), get_manufacturer(std::string&) , get_product(unsigned int, std::string&), get_product(std::string&)

Definition at line 205 of file scanner.hpp.

int FTDI_Scanner::get_serial_id ( unsigned int  index, std::string &  serial_id  )

inline

Parameters

[in]	index	index of scanned device
[out]	serial_id	serial number of ftdi device

Returns

0 on success
-1 on failure

See also

get_serial_id(unsigned int, std::string&), get_serial_id(std::string&) , get_manufacturer(unsigned int, std::string&), get_manufacturer(std::string&) , get_product(unsigned int, std::string&), get_product(std::string&)

Definition at line 143 of file scanner.hpp.

int FTDI_Scanner::get_serial_id ( std::string &  serial_id )

inline

Parameters

[out]

serial_id

serial number of ftdi device

Returns

0 on success
-1 on failure

See also

get_serial_id(unsigned int, std::string&), get_serial_id(std::string&) , get_manufacturer(unsigned int, std::string&), get_manufacturer(std::string&) , get_product(unsigned int, std::string&), get_product(std::string&)

Definition at line 187 of file scanner.hpp.

int FTDI_Scanner::reset ( )

inline

reset the connected usb device to recall it to standard tty interface

Returns

0 on success
-1 on failure

Definition at line 211 of file scanner.hpp.

int FTDI_Scanner::retrieve ( )

inline

Retrieve descriptions of scanned devices. Retrived desctiptions are stored internally.

Returns

positive number of retrieved devices.
-1 on failure

See also

get_serial_id(unsigned int, std::string&), get_serial_id(std::string&) , get_manufacturer(unsigned int, std::string&), get_manufacturer(std::string&) , get_product(unsigned int, std::string&), get_product(std::string&)

Definition at line 106 of file scanner.hpp.

int FTDI_Scanner::scan ( )

inline

Scan the usb device that have given vendor and product id.

Returns

positive number of devices connected.
-1 on failure

Definition at line 89 of file scanner.hpp.

Member Data Documentation

std::vector<std::map<std::string, std::string> > FTDI_Scanner::descriptions

private

Container for usb data of devices found. such as serial_number, product name, manufacture name

Definition at line 230 of file scanner.hpp.

std::vector<struct usb_device *> FTDI_Scanner::devices

private

Container for data structure of usb devices found

Definition at line 229 of file scanner.hpp.

bool FTDI_Scanner::retrieved

private

flags to indicated current status of calss

Definition at line 228 of file scanner.hpp.

bool FTDI_Scanner::scanned

private

flags to indicated current status of calss

Definition at line 227 of file scanner.hpp.

---

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

• scanner.hpp