logicalaccess::LibUSBReaderProvider Class Reference

LibUSB Reader Provider class. More...

#include <libusbreaderprovider.hpp>

Inheritance diagram for logicalaccess::LibUSBReaderProvider:

Public Member Functions
	~LibUSBReaderProvider ()
	Destructor.
void	release () override
	Release the provider resources.
std::string	getRPType () const override
	Get the reader provider type.
std::string	getRPName () const override
	Get the reader provider name.
bool	refreshReaderList () override
	List all readers of the system.
const ReaderList &	getReaderList () override
	Get reader list for this reader provider.
std::shared_ptr< ReaderUnit >	createReaderUnit () override
	Create a new reader unit for the reader provider. param ip The reader address param port The reader port.
libusb_context *	getContext () const
	Get the LibUSB context.
Public Member Functions inherited from logicalaccess::ReaderProvider
	ReaderProvider ()
	Constructor.
virtual	~ReaderProvider ()
	Destructor.
virtual void	release ()=0
	Release the provider resources.
virtual bool	refreshReaderList ()=0
	List all readers of the system.
virtual const ReaderList &	getReaderList ()=0
	Get reader list for this reader provider.
virtual const ReaderList	waitForReaders (std::vector< std::string > readers, double maxwait, bool all)
	Lock until one or all ready are detected.
virtual std::string	getRPType () const =0
	Get the reader provider type.
virtual std::string	getRPName () const =0
	Get the reader provider name.
virtual std::shared_ptr< ReaderUnit >	createReaderUnit ()=0
	Create a new reader unit for the reader provider.

Static Public Member Functions
static std::shared_ptr< LibUSBReaderProvider >	createInstance ()
	Create a new LibUSB reader provider instance.
Static Public Member Functions inherited from logicalaccess::ReaderProvider
static std::shared_ptr< ReaderProvider >	getReaderProviderFromRPType (std::string rpt)
	Get the reader provider object from the reader provider type.

Protected Member Functions
	LibUSBReaderProvider ()
	Constructor.

Protected Attributes
ReaderList	d_readers
	The reader list.
libusb_context *	d_context
	The LibUSB Context.

Detailed Description

LibUSB Reader Provider class.

Constructor & Destructor Documentation

~LibUSBReaderProvider()

logicalaccess::LibUSBReaderProvider::~LibUSBReaderProvider

(

)

Destructor.

LibUSBReaderProvider()

logicalaccess::LibUSBReaderProvider::LibUSBReaderProvider ( )

protected

Constructor.

Member Function Documentation

createInstance()

std::shared_ptr< LibUSBReaderProvider > logicalaccess::LibUSBReaderProvider::createInstance ( )

static

Create a new LibUSB reader provider instance.

Returns

The LibUSB reader provider instance.

createReaderUnit()

std::shared_ptr< ReaderUnit > logicalaccess::LibUSBReaderProvider::createReaderUnit ( )

overridevirtual

Create a new reader unit for the reader provider. param ip The reader address param port The reader port.

Returns

A reader unit.

Implements logicalaccess::ReaderProvider.

getContext()

libusb_context * logicalaccess::LibUSBReaderProvider::getContext ( ) const

inline

Get the LibUSB context.

Returns

The LibUSB context.

getReaderList()

const ReaderList & logicalaccess::LibUSBReaderProvider::getReaderList ( )

inlineoverridevirtual

Get reader list for this reader provider.

Returns

The reader list.

Implements logicalaccess::ReaderProvider.

getRPName()

std::string logicalaccess::LibUSBReaderProvider::getRPName ( ) const

inlineoverridevirtual

Get the reader provider name.

Returns

The reader provider name.

Implements logicalaccess::ReaderProvider.

getRPType()

std::string logicalaccess::LibUSBReaderProvider::getRPType ( ) const

inlineoverridevirtual

Get the reader provider type.

Returns

The reader provider type.

Implements logicalaccess::ReaderProvider.

refreshReaderList()

bool logicalaccess::LibUSBReaderProvider::refreshReaderList ( )

overridevirtual

List all readers of the system.

Returns

True if the list was updated, false otherwise.

Implements logicalaccess::ReaderProvider.

release()

void logicalaccess::LibUSBReaderProvider::release ( )

overridevirtual

Release the provider resources.

Implements logicalaccess::ReaderProvider.

Member Data Documentation

d_context

libusb_context* logicalaccess::LibUSBReaderProvider::d_context

protected

The LibUSB Context.

d_readers

ReaderList logicalaccess::LibUSBReaderProvider::d_readers

protected

The reader list.

---

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

• C:/dev/lla/liblogicalaccess/plugins/logicalaccess/plugins/readers/libusb/libusbreaderprovider.hpp
• C:/dev/lla/liblogicalaccess/plugins/logicalaccess/plugins/readers/libusb/libusbreaderprovider.cpp