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

#include <CmdCardSvGet.h>

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

Public Member Functions

 CmdCardSvGet (const CalypsoCardClass calypsoCardClass, const std::shared_ptr< CalypsoCard > calypsoCard, const SvOperation svOperation)
 
bool isSessionBufferUsed () const override
 
CmdCardSvGetsetApduResponse (const std::shared_ptr< ApduResponseApi > apduResponse) override
 
const std::vector< uint8_t > & getSvGetCommandHeader () const
 
uint8_t getCurrentKVC () const
 
int getTransactionNumber () const
 
const std::vector< uint8_t > & getPreviousSignatureLo () const
 
const std::vector< uint8_t > & getChallengeOut () const
 
int getBalance () const
 
const std::shared_ptr< SvLoadLogRecord > getLoadLog () const
 
const std::shared_ptr< SvDebitLogRecord > getDebitLog () const
 
const std::map< const int, const std::shared_ptr< StatusProperties > > & getStatusTable () const override
 
- Public Member Functions inherited from keyple::card::calypso::AbstractCardCommand
 AbstractCardCommand (const CalypsoCardCommand &commandRef)
 
const CalypsoCardCommandgetCommandRef () const override
 
const CalypsoApduCommandException buildCommandException (const std::type_info &exceptionClass, const std::string &message, const CardCommand &commandRef, const int statusWord) const final
 
void checkStatus () override
 
- Public Member Functions inherited from keyple::card::calypso::AbstractApduCommand
 AbstractApduCommand (const CardCommand &commandRef)
 
virtual void addSubName (const std::string &subName) final
 
virtual const std::string & getName () const 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::AbstractApduCommand
static const std::map< const int, const std::shared_ptr< StatusProperties > > STATUS_TABLE
 

Detailed Description

(package-private)
Builds the SV Get command.

Since
2.0.1

Definition at line 50 of file CmdCardSvGet.h.

Constructor & Destructor Documentation

◆ CmdCardSvGet()

keyple::card::calypso::CmdCardSvGet::CmdCardSvGet ( const CalypsoCardClass  calypsoCardClass,
const std::shared_ptr< CalypsoCard >  calypsoCard,
const SvOperation  svOperation 
)

(package-private)
Instantiates a new CmdCardSvGet.

Parameters
calypsoCardClassthe card class.
calypsoCardthe Calypso card.
svOperationthe desired SV operation.
Exceptions
IllegalArgumentExceptionIf the command is inconsistent
Since
2.0.1

Definition at line 44 of file CmdCardSvGet.cpp.

Member Function Documentation

◆ getBalance()

int keyple::card::calypso::CmdCardSvGet::getBalance ( ) const

(package-private)
Gets the current SV balance

Returns
The value of the SV balance
Since
2.0.1

Definition at line 147 of file CmdCardSvGet.cpp.

◆ getChallengeOut()

const std::vector< uint8_t > & keyple::card::calypso::CmdCardSvGet::getChallengeOut ( ) const

(package-private)
Gets the new challenge value generated by the command

Returns
A byte array containing the challenge
Since
2.0.1

Definition at line 142 of file CmdCardSvGet.cpp.

◆ getCurrentKVC()

uint8_t keyple::card::calypso::CmdCardSvGet::getCurrentKVC ( ) const

(package-private)
Gets the current SV KVC

Returns
The value of the current KVC
Since
2.0.1

Definition at line 127 of file CmdCardSvGet.cpp.

◆ getDebitLog()

const std::shared_ptr< SvDebitLogRecord > keyple::card::calypso::CmdCardSvGet::getDebitLog ( ) const

(package-private)
Gets a SvDebitLogRecord containing the last debit record
May return null if the debit record is not available (load case for card rev < 3.2)

Returns
A SvDebitLogRecord object containing the log data or null
Since
2.0.1

Definition at line 157 of file CmdCardSvGet.cpp.

◆ getLoadLog()

const std::shared_ptr< SvLoadLogRecord > keyple::card::calypso::CmdCardSvGet::getLoadLog ( ) const

(package-private)
Gets a SvLoadLogRecord containing the load record
May return null if the load record is not available (debit/undebit case for card rev < 3.2)

Returns
A SvLoadLogRecord object containing the log data or null
Since
2.0.1

Definition at line 152 of file CmdCardSvGet.cpp.

◆ getPreviousSignatureLo()

const std::vector< uint8_t > & keyple::card::calypso::CmdCardSvGet::getPreviousSignatureLo ( ) const

(package-private)
Gets the SignatureLo value of the last SV transaction (reload, debit, undebit)

Returns
A byte array containing the signature data
Since
2.0.1

Definition at line 137 of file CmdCardSvGet.cpp.

◆ getStatusTable()

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

(package-private)
Returns the internal status table

Returns
A not null reference
Since
2.0.1

Since
2.0.1

Reimplemented from keyple::card::calypso::AbstractApduCommand.

Definition at line 189 of file CmdCardSvGet.cpp.

◆ getSvGetCommandHeader()

const std::vector< uint8_t > & keyple::card::calypso::CmdCardSvGet::getSvGetCommandHeader ( ) const

(package-private)
Gets the command header used to build the prepared "load/debit/undebit" SAM commands

Returns
A byte array containing the header data
Since
2.0.1

Definition at line 122 of file CmdCardSvGet.cpp.

◆ getTransactionNumber()

int keyple::card::calypso::CmdCardSvGet::getTransactionNumber ( ) const

(package-private)
Gets the SV transaction number

Returns
The value of the SV transaction number
Since
2.0.1

Definition at line 132 of file CmdCardSvGet.cpp.

◆ isSessionBufferUsed()

bool keyple::card::calypso::CmdCardSvGet::isSessionBufferUsed ( ) const
overridevirtual

(package-private)
Indicates if the session buffer is used when executing this command.Allows the management of the overflow of this buffer.

Returns
True if this command uses the session buffer
Since
2.0.1

Returns
False
Since
2.0.1

Implements keyple::card::calypso::AbstractCardCommand.

Definition at line 72 of file CmdCardSvGet.cpp.

◆ setApduResponse()

CmdCardSvGet & keyple::card::calypso::CmdCardSvGet::setApduResponse ( const std::shared_ptr< ApduResponseApi >  apduResponse)
overridevirtual

(package-private)
Sets the command ApduResponseApi.

Parameters
apduResponseThe APDU response.
Returns
The current instance.
Since
2.0.1
Since
2.0.1

Since
2.0.1

Reimplemented from keyple::card::calypso::AbstractCardCommand.

Definition at line 77 of file CmdCardSvGet.cpp.


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