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

#include <ProxyElement.h>

Inherited by keyple::core::seproxy::ReaderPlugin [virtual], and keyple::core::seproxy::SeReader [virtual].

Public Member Functions

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

(package-private)
Allow keyple::core::seproxy::message::ProxyReader and keyple::core::seproxy::ReaderPlugin to receive configuration parameters

Constructor & Destructor Documentation

◆ ~ProxyElement()

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

Member Function Documentation

◆ getName()

virtual const std::string& keyple::core::seproxy::ProxyElement::getName ( ) const
pure virtual

C++ vs. Java: hack to avoid linker issues. Should be removed in 1.0

Returns
the unique name of the item

Implemented in keyple::plugin::stub::StubPoolPluginImpl, keyple::plugin::stub::StubPluginImpl, keyple::core::seproxy::plugin::AbstractReader, keyple::plugin::pcsc::PcscReaderImpl, and keyple::plugin::pcsc::PcscPluginImpl.

◆ getParameters()

virtual const std::map<const std::string, const std::string>& keyple::core::seproxy::ProxyElement::getParameters ( ) const
pure virtual

◆ setParameter()

virtual void keyple::core::seproxy::ProxyElement::setParameter ( const std::string &  key,
const std::string &  value 
)
pure virtual

Allows to define a proprietary setting for a reader or a plugin (contactless protocols polling sequence, baud rate, … etc.).

Parameters
keythe parameter key
valuethe parameter value
Exceptions
IllegalArgumentExceptionif the parameter or the value is not supported
KeypleReaderIOExceptionif the communication with the reader or the SE has failed

Implemented in keyple::plugin::stub::StubReaderImpl, keyple::plugin::pcsc::PcscReaderImpl, keyple::plugin::stub::StubPoolPluginImpl, keyple::plugin::stub::StubPluginImpl, and keyple::plugin::pcsc::PcscPluginImpl.

◆ setParameters()

virtual void keyple::core::seproxy::ProxyElement::setParameters ( const std::map< const std::string, const std::string > &  parameters)
inlinevirtual

allows to define a set of proprietary settings for a reader or a plugin (contactless protocols polling sequence, baud rate, … etc.).

Parameters
parametersParameters to setup
Exceptions
IllegalArgumentExceptionif the parameters or the values is not supported
KeypleExceptionif the parameter fails to be set up

Reimplemented in keyple::plugin::stub::StubPoolPluginImpl, keyple::plugin::pcsc::PcscReaderImpl, and keyple::plugin::pcsc::PcscPluginImpl.


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