keypop::reader::selection::CardSelectionResult Class Reference

#include <CardSelectionResult.hpp>

Public Member Functions
virtual const std::map< int, std::shared_ptr< SmartCard > > &	getSmartCards () const =0
virtual std::shared_ptrespi::SmartCard::SmartCard	getActiveSmartCard () const =0
virtual int	getActiveSelectionIndex () const =0

Detailed Description

Result of a selection process.

Each selection case prepared with the card selection manager is associated with an index corresponding to its rank in the order of preparation.
The same index is used here to find out which selection cases were successful.
However, only one case will correspond to the selected card state. The getters of this interface allow to make use of these results according to the configurations and the needs of the application.

Since

1.0.0

Definition at line 35 of file CardSelectionResult.hpp.

Member Function Documentation

getActiveSelectionIndex()

virtual int keypop::reader::selection::CardSelectionResult::getActiveSelectionIndex ( ) const

pure virtual

Gets the index of the active selection if any.

Returns

A positive value if there is an active selection, -1 if there is no active selection.

Since

1.0.0

getActiveSmartCard()

virtual std::shared_ptrespi::SmartCard::SmartCard keypop::reader::selection::CardSelectionResult::getActiveSmartCard ( ) const

pure virtual

Gets the active matching card. I.e. the card that has been selected.

Returns

Null if there is no active card.

Since

1.0.0

getSmartCards()

virtual const std::map< int, std::shared_ptr< SmartCard > > & keypop::reader::selection::CardSelectionResult::getSmartCards ( ) const

pure virtual

Gets all SmartCard corresponding to all successful selection cases in a map for which the key is the selection index provided by the CardSelectionManager::prepareSelection(CardSelection) method.

Returns

A not null but possibly empty map.

Since

1.0.0

---

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

• /github/workspace/include/keypop/reader/selection/CardSelectionResult.hpp