LibLogicalAccess  2.5.0
An Open Source RFID Library
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
logicalaccess::OSDPReaderProvider Class Reference

OSDP Reader Provider class. More...

#include <osdpreaderprovider.hpp>

Inheritance diagram for logicalaccess::OSDPReaderProvider:
logicalaccess::ReaderProvider

Public Member Functions

 ~OSDPReaderProvider ()
 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 ReaderListgetReaderList () override
 Get reader list for this reader provider.
 
std::shared_ptr< ReaderUnitcreateReaderUnit () override
 Create a new reader unit for the reader provider.
 
- 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 ReaderListgetReaderList ()=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< ReaderUnitcreateReaderUnit ()=0
 Create a new reader unit for the reader provider.
 

Static Public Member Functions

static std::shared_ptr< OSDPReaderProvidergetSingletonInstance ()
 Get the STidSTReaderProvider instance. Singleton because we can only have one COM communication, and Deister can't have shared access, so we share the same reader unit.
 
- Static Public Member Functions inherited from logicalaccess::ReaderProvider
static std::shared_ptr< ReaderProvidergetReaderProviderFromRPType (std::string rpt)
 Get the reader provider object from the reader provider type.
 

Protected Member Functions

 OSDPReaderProvider ()
 Constructor.
 

Protected Attributes

ReaderList d_readers
 The reader list.
 

Detailed Description

OSDP Reader Provider class.

Constructor & Destructor Documentation

◆ ~OSDPReaderProvider()

logicalaccess::OSDPReaderProvider::~OSDPReaderProvider ( )

Destructor.

◆ OSDPReaderProvider()

logicalaccess::OSDPReaderProvider::OSDPReaderProvider ( )
protected

Constructor.

Member Function Documentation

◆ createReaderUnit()

std::shared_ptr< ReaderUnit > logicalaccess::OSDPReaderProvider::createReaderUnit ( )
overridevirtual

Create a new reader unit for the reader provider.

Returns
A reader unit.

Implements logicalaccess::ReaderProvider.

◆ getReaderList()

const ReaderList & logicalaccess::OSDPReaderProvider::getReaderList ( )
inlineoverridevirtual

Get reader list for this reader provider.

Returns
The reader list.

Implements logicalaccess::ReaderProvider.

◆ getRPName()

std::string logicalaccess::OSDPReaderProvider::getRPName ( ) const
inlineoverridevirtual

Get the reader provider name.

Returns
The reader provider name.

Implements logicalaccess::ReaderProvider.

◆ getRPType()

std::string logicalaccess::OSDPReaderProvider::getRPType ( ) const
inlineoverridevirtual

Get the reader provider type.

Returns
The reader provider type.

Implements logicalaccess::ReaderProvider.

◆ getSingletonInstance()

std::shared_ptr< OSDPReaderProvider > logicalaccess::OSDPReaderProvider::getSingletonInstance ( )
static

Get the STidSTReaderProvider instance. Singleton because we can only have one COM communication, and Deister can't have shared access, so we share the same reader unit.

◆ refreshReaderList()

bool logicalaccess::OSDPReaderProvider::refreshReaderList ( )
overridevirtual

List all readers of the system.

Returns
True if the list was updated, false otherwise.

Implements logicalaccess::ReaderProvider.

◆ release()

void logicalaccess::OSDPReaderProvider::release ( )
overridevirtual

Release the provider resources.

Implements logicalaccess::ReaderProvider.

Member Data Documentation

◆ d_readers

ReaderList logicalaccess::OSDPReaderProvider::d_readers
protected

The reader list.


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