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

#include <CmdSamReadKeyParameters.h>

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

Public Types

enum class  SourceRef { WORK_KEY , SYSTEM_KEY }
 
enum class  NavControl { FIRST , NEXT }
 

Public Member Functions

 CmdSamReadKeyParameters (const std::shared_ptr< CalypsoSamAdapter > calypsoSam)
 
 CmdSamReadKeyParameters (const std::shared_ptr< CalypsoSamAdapter > calypsoSam, const uint8_t kif)
 
 CmdSamReadKeyParameters (const std::shared_ptr< CalypsoSamAdapter > calypsoSam, const uint8_t kif, const uint8_t kvc)
 
 CmdSamReadKeyParameters (const std::shared_ptr< CalypsoSamAdapter > calypsoSam, const SourceRef sourceKeyRef, const int recordNumber)
 
 CmdSamReadKeyParameters (const std::shared_ptr< CalypsoSamAdapter > calypsoSam, const uint8_t kif, const NavControl navControl)
 
const std::vector< uint8_t > getKeyParameters () const
 
const std::map< const int, const std::shared_ptr< StatusProperties > > & getStatusTable () const 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) override
 
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
 

Friends

std::ostream & operator<< (std::ostream &os, const SourceRef &sr)
 
std::ostream & operator<< (std::ostream &os, const NavControl &nc)
 

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 Key Parameters APDU command.

Since
2.0.1

Definition at line 33 of file CmdSamReadKeyParameters.h.

Member Enumeration Documentation

◆ NavControl

Navigation control

Enumerator
FIRST 

First

NEXT 

Next

Definition at line 53 of file CmdSamReadKeyParameters.h.

◆ SourceRef

Source reference

Enumerator
WORK_KEY 

Work key

SYSTEM_KEY 

System key

Definition at line 38 of file CmdSamReadKeyParameters.h.

Constructor & Destructor Documentation

◆ CmdSamReadKeyParameters() [1/5]

keyple::card::calypso::CmdSamReadKeyParameters::CmdSamReadKeyParameters ( const std::shared_ptr< CalypsoSamAdapter calypsoSam)

(package-private)
Instantiates a new CmdSamReadKeyParameters for the null key.

Parameters
calypsoSamThe Calypso SAM.
Since
2.0.1

Definition at line 41 of file CmdSamReadKeyParameters.cpp.

◆ CmdSamReadKeyParameters() [2/5]

keyple::card::calypso::CmdSamReadKeyParameters::CmdSamReadKeyParameters ( const std::shared_ptr< CalypsoSamAdapter calypsoSam,
const uint8_t  kif 
)

(package-private)
Instantiates a new CmdSamReadKeyParameters for the provided kif.

Parameters
calypsoSamThe Calypso SAM.
kifthe kif
Since
2.0.1

Definition at line 54 of file CmdSamReadKeyParameters.cpp.

◆ CmdSamReadKeyParameters() [3/5]

keyple::card::calypso::CmdSamReadKeyParameters::CmdSamReadKeyParameters ( const std::shared_ptr< CalypsoSamAdapter calypsoSam,
const uint8_t  kif,
const uint8_t  kvc 
)

(package-private)
Instantiates a new CmdSamReadKeyParameters for the provided kif and kvc.

Parameters
calypsoSamThe Calypso SAM.
kifthe kif
kvcthe kvc
Since
2.0.1

Definition at line 71 of file CmdSamReadKeyParameters.cpp.

◆ CmdSamReadKeyParameters() [4/5]

keyple::card::calypso::CmdSamReadKeyParameters::CmdSamReadKeyParameters ( const std::shared_ptr< CalypsoSamAdapter calypsoSam,
const SourceRef  sourceKeyRef,
const int  recordNumber 
)

(package-private)
Instantiates a new CmdSamReadKeyParameters for the provided key reference and record number.

Parameters
calypsoSamThe Calypso SAM.
sourceKeyRefthe source key reference
recordNumberthe record number
Since
2.0.1

Definition at line 90 of file CmdSamReadKeyParameters.cpp.

◆ CmdSamReadKeyParameters() [5/5]

keyple::card::calypso::CmdSamReadKeyParameters::CmdSamReadKeyParameters ( const std::shared_ptr< CalypsoSamAdapter calypsoSam,
const uint8_t  kif,
const NavControl  navControl 
)

(package-private)
Instantiates a new CmdSamReadKeyParameters for the provided kif and navigation control flag.

Parameters
calypsoSamThe Calypso SAM.
kifthe kif
navControlthe navigation control flag
Since
2.0.1

Definition at line 130 of file CmdSamReadKeyParameters.cpp.

Member Function Documentation

◆ getKeyParameters()

const std::vector< uint8_t > keyple::card::calypso::CmdSamReadKeyParameters::getKeyParameters ( ) const

(package-private)
Gets the key parameters.

Returns
The key parameters
Since
2.0.1

Definition at line 165 of file CmdSamReadKeyParameters.cpp.

◆ getStatusTable()

const std::map< const int, const std::shared_ptr< StatusProperties > > & keyple::card::calypso::CmdSamReadKeyParameters::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 196 of file CmdSamReadKeyParameters.cpp.

Friends And Related Function Documentation

◆ operator<< [1/2]

std::ostream & operator<< ( std::ostream &  os,
const NavControl nc 
)
friend

Definition at line 224 of file CmdSamReadKeyParameters.cpp.

◆ operator<< [2/2]

std::ostream & operator<< ( std::ostream &  os,
const SourceRef sr 
)
friend

Definition at line 203 of file CmdSamReadKeyParameters.cpp.


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