Keyple Card Calypso C++ Library 2.2.5.6
Reference Terminal Reader API for C++
Public Types | Public Member Functions | List of all members
keyple::card::calypso::CmdSamReadEventCounter Class Referencefinal

#include <CmdSamReadEventCounter.h>

Inheritance diagram for keyple::card::calypso::CmdSamReadEventCounter:
Inheritance graph
[legend]
Collaboration diagram for keyple::card::calypso::CmdSamReadEventCounter:
Collaboration graph
[legend]

Public Types

enum  CounterOperationType { READ_SINGLE_COUNTER , READ_COUNTER_RECORD }
 

Public Member Functions

 CmdSamReadEventCounter (std::shared_ptr< CalypsoSamAdapter > calypsoSam, const CounterOperationType counterOperationType, const int target)
 
const std::map< const int, const std::shared_ptr< StatusProperties > > & getStatusTable () const override
 
void parseApduResponse (std::shared_ptr< ApduResponseApi > apduResponse) override
 
- Public Member Functions inherited from keyple::card::calypso::AbstractSamCommand
 AbstractSamCommand (const CalypsoSamCommand &commandRef, const int expectedResponseLength, const std::shared_ptr< CalypsoSamAdapter > calypsoSam)
 
const std::shared_ptr< CalypsoSamAdaptergetCalypsoSam () const
 
const CalypsoSamCommandgetCommandRef () const override
 
const CalypsoApduCommandException buildCommandException (const std::type_info &exceptionClass, const std::string &message) const final
 
const CalypsoApduCommandException buildUnexpectedResponseLengthException (const std::string &message) const final
 
void parseApduResponse (const std::shared_ptr< ApduResponseApi > apduResponse, const std::shared_ptr< CalypsoSamAdapter > calypsoSam)
 
- Public Member Functions inherited from keyple::card::calypso::AbstractApduCommand
 AbstractApduCommand (const CardCommand &commandRef, const int expectedResponseLength)
 
virtual void addSubName (const std::string &subName) final
 
virtual const std::string & getName () const final
 
virtual void setExpectedResponseLength (const int expectedResponseLength) final
 
virtual void setApduRequest (const std::shared_ptr< ApduRequestAdapter > apduRequest) final
 
virtual const std::shared_ptr< ApduRequestAdaptergetApduRequest () const final
 
virtual const std::shared_ptr< ApduResponseApi > getApduResponse () const final
 
virtual bool isSuccessful () const final
 
virtual const std::string getStatusInformation () const final
 

Additional Inherited Members

- Static Public Attributes inherited from keyple::card::calypso::AbstractSamCommand
static const std::map< const int, const std::shared_ptr< StatusProperties > > STATUS_TABLE = initStatusTable()
 
- Static Public Attributes inherited from keyple::card::calypso::AbstractApduCommand
static const std::map< const int, const std::shared_ptr< StatusProperties > > STATUS_TABLE
 

Detailed Description

(package-private)
Builds the Read Event Counter APDU command.

Since
2.0.1

Definition at line 33 of file CmdSamReadEventCounter.h.

Member Enumeration Documentation

◆ CounterOperationType

Event counter operation type

Enumerator
READ_SINGLE_COUNTER 

Single counter

READ_COUNTER_RECORD 

Counter record

Definition at line 38 of file CmdSamReadEventCounter.h.

Constructor & Destructor Documentation

◆ CmdSamReadEventCounter()

keyple::card::calypso::CmdSamReadEventCounter::CmdSamReadEventCounter ( std::shared_ptr< CalypsoSamAdapter calypsoSam,
const CounterOperationType  counterOperationType,
const int  target 
)

(package-private)
Instantiate a new CmdSamReadEventCounter

Parameters
calypsoSamThe Calypso SAM.
counterOperationTypethe counter operation type.
targetthe counter index (0-26) if READ_SINGLE_COUNTER, the record index (1-3) if READ_COUNTER_RECORD.
Since
2.0.1

Definition at line 37 of file CmdSamReadEventCounter.cpp.

Member Function Documentation

◆ getStatusTable()

const std::map< const int, const std::shared_ptr< StatusProperties > > & keyple::card::calypso::CmdSamReadEventCounter::getStatusTable ( ) const
overridevirtual

(package-private)
Returns the internal status table

Returns
A not null reference
Since
2.0.1
Since
2.0.1

Since
2.0.1

Reimplemented from keyple::card::calypso::AbstractSamCommand.

Definition at line 83 of file CmdSamReadEventCounter.cpp.

◆ parseApduResponse()

void keyple::card::calypso::CmdSamReadEventCounter::parseApduResponse ( std::shared_ptr< ApduResponseApi >  apduResponse)
overridevirtual

(package-private)
Parses the response ApduResponseApi and check the status word.

Parameters
apduResponseThe APDU response.
Exceptions
CalypsoApduCommandExceptionif status is not successful or if the length of the response is not equal to the LE field in the request.
Since
2.0.1
Since
2.0.1

Since
2.2.3

Reimplemented from keyple::card::calypso::AbstractSamCommand.

Definition at line 88 of file CmdSamReadEventCounter.cpp.


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