Keyple C++  0.9.0
Keyple, an Open Source SDK for Ticketing
Public Member Functions | List of all members
keyple::core::seproxy::ReaderPlugin Class Referenceabstract

#include <ReaderPlugin.h>

Inherits keyple::core::seproxy::ProxyElement.

Inherited by keyple::core::seproxy::event::ObservablePlugin [virtual], keyple::core::seproxy::plugin::AbstractPlugin [virtual], and keyple::core::seproxy::ReaderPoolPlugin.

Public Member Functions

virtual ~ReaderPlugin ()=default
 
virtual const std::set< std::string > getReaderNames () const =0
 
virtual ConcurrentMap< const std::string, std::shared_ptr< SeReader > > & getReaders ()=0
 
virtual const std::shared_ptr< SeReadergetReader (const std::string &name)=0
 
- Public Member Functions inherited from keyple::core::seproxy::ProxyElement
virtual ~ProxyElement ()=default
 
virtual const std::string & getName () const =0
 
virtual const std::map< const std::string, const std::string > & getParameters () const =0
 
virtual void setParameter (const std::string &key, const std::string &value)=0
 
virtual void setParameters (const std::map< const std::string, const std::string > &parameters)
 

Detailed Description

Card readers plugin interface.

Constructor & Destructor Documentation

◆ ~ReaderPlugin()

virtual keyple::core::seproxy::ReaderPlugin::~ReaderPlugin ( )
virtualdefault

Member Function Documentation

◆ getReader()

virtual const std::shared_ptr<SeReader> keyple::core::seproxy::ReaderPlugin::getReader ( const std::string &  name)
pure virtual

Gets the reader whose name is provided as an argument

Parameters
nameof the reader
Returns
the SeReader object.
Exceptions
KeypleReaderNotFoundExceptionif the wanted reader is not found

Implemented in keyple::plugin::stub::StubPoolPluginImpl, and keyple::core::seproxy::plugin::AbstractPlugin.

◆ getReaderNames()

virtual const std::set<std::string> keyple::core::seproxy::ReaderPlugin::getReaderNames ( ) const
pure virtual

Gets the list of names of all readers

Returns
a list of String

Implemented in keyple::plugin::stub::StubPoolPluginImpl, and keyple::core::seproxy::plugin::AbstractPlugin.

◆ getReaders()

virtual ConcurrentMap<const std::string, std::shared_ptr<SeReader> >& keyple::core::seproxy::ReaderPlugin::getReaders ( )
pure virtual

Gets the readers.

Returns
the map of this plugin's connected reader's name and instance, can be an empty list, can not be null;

Implemented in keyple::plugin::stub::StubPoolPluginImpl, and keyple::core::seproxy::plugin::AbstractPlugin.


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