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

#include <AbstractSeProxyComponent.h>

Inherited by keyple::core::seproxy::plugin::AbstractPlugin, and keyple::core::seproxy::plugin::AbstractReader.

Public Member Functions

 AbstractSeProxyComponent (const std::string &name)
 
virtual ~AbstractSeProxyComponent ()=default
 
const std::string & getName () const
 
void setParameters (const std::map< const std::string, const std::string > &parameters)
 
virtual void setParameter (const std::string &key, const std::string &value)=0
 

Detailed Description

This abstract class mutualizes the management of the name and part of the configuration of SeProxy components (plugins and readers)

Constructor & Destructor Documentation

◆ AbstractSeProxyComponent()

keyple::core::seproxy::plugin::AbstractSeProxyComponent::AbstractSeProxyComponent ( const std::string &  name)
explicit

Constructor

Parameters
namethe name of the component

◆ ~AbstractSeProxyComponent()

virtual keyple::core::seproxy::plugin::AbstractSeProxyComponent::~AbstractSeProxyComponent ( )
virtualdefault

Member Function Documentation

◆ getName()

const std::string & keyple::core::seproxy::plugin::AbstractSeProxyComponent::getName ( ) const
Returns
the name of the component

◆ setParameter()

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

This method has to be implemented by the reader plugin.
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::StubPluginImpl, and keyple::plugin::pcsc::PcscPluginImpl.

◆ setParameters()

void keyple::core::seproxy::plugin::AbstractSeProxyComponent::setParameters ( const std::map< const std::string, const std::string > &  parameters)

Sets at once a set of parameters for a reader

See setParameter() for more details

Parameters
parametersa Map <String, String> parameter set
Exceptions
KeypleBaseExceptionif one of the parameters could not be set up

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