keypop::reader::CardReader Class Reference

Card reader driving the underlying hardware to manage the card detection. More...

#include <keypop/reader/CardReader.hpp>

Inheritance diagram for keypop::reader::CardReader:

Public Member Functions
virtual	~CardReader ()=default
virtual const std::string &	getName () const =0
	Returns the name of the reader. More...
virtual bool	isContactless ()=0
	Checks if the card communication mode is contactless. More...
virtual bool	isCardPresent ()=0
	Checks if the card is present. More...

Detailed Description

Card reader driving the underlying hardware to manage the card detection.

Since

1.0.0

Definition at line 26 of file CardReader.hpp.

Constructor & Destructor Documentation

~CardReader()

virtual keypop::reader::CardReader::~CardReader ( )

virtualdefault

Member Function Documentation

getName()

virtual const std::string & keypop::reader::CardReader::getName ( ) const

pure virtual

Returns the name of the reader.

Returns

A non-empty string containing the name of the reader.

Since

1.0.0

isCardPresent()

virtual bool keypop::reader::CardReader::isCardPresent ( )

pure virtual

Checks if the card is present.

Returns

true if a card is inserted in the reader else false.

Exceptions

ReaderCommunicationException

If the communication with the reader has failed.

Since

1.0.0

isContactless()

virtual bool keypop::reader::CardReader::isContactless ( )

pure virtual

Checks if the card communication mode is contactless.

C++ note: this function cannot be set 'const' as some derived classes will set internal flags accordingly.

Returns

true if the communication mode is contactless else false

Since

1.0.0

---

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

• keypop/reader/CardReader.hpp