Keypop Calypso Card C++ API 2.0.0
Reference Calypso Card API for C++
Public Types | Public Member Functions | Friends | List of all members
keypop::calypso::card::card::ElementaryFile Class Referenceabstract

#include <ElementaryFile.hpp>

Public Types

enum  Type {
  LINEAR , BINARY , CYCLIC , COUNTERS ,
  SIMULATED_COUNTERS
}
 

Public Member Functions

virtual uint8_t getSfi () const =0
 
virtual const std::shared_ptr< FileHeadergetHeader () const =0
 
virtual const std::shared_ptr< FileDatagetData () const =0
 

Friends

std::ostream & operator<< (std::ostream &os, const ElementaryFile &ef)
 
std::ostream & operator<< (std::ostream &os, const std::shared_ptr< ElementaryFile > ef)
 
std::ostream & operator<< (std::ostream &os, const std::vector< std::shared_ptr< ElementaryFile > > &ef)
 

Detailed Description

Calypso Elementary File.

Since
1.0.0

Definition at line 31 of file ElementaryFile.hpp.

Member Enumeration Documentation

◆ Type

The different types of EF.

Since
1.0.0
Enumerator
LINEAR 

A Linear EF is made of 1 to several records.

Since
1.0.0
BINARY 

A Binary EF contains a single continuous sequence of data bytes from byte #0 (first byte) to byte #N−1 (last byte, for a binary file of N bytes).

Since
1.0.0
CYCLIC 

A Cyclic EF is made of 1 to several records organized in a cycle, from the most recent (record #1) to the oldest.

Since
1.0.0
COUNTERS 

A Counters EF is made of a single record containing an ordered sequence of K counters of three bytes each, from counter #1 (bytes at offsets 0, 1 and 2 of the record) to counter #K.

Since
1.0.0
SIMULATED_COUNTERS 

A Simulated Counter EF is a linear file with a single record.
Simulated Counter EFs are present for compatibility with the Calypso Revision 2 access to simulated individual counters.

Since
1.0.0

Definition at line 38 of file ElementaryFile.hpp.

Member Function Documentation

◆ getData()

virtual const std::shared_ptr< FileData > keypop::calypso::card::card::ElementaryFile::getData ( ) const
pure virtual

Gets the file data.

Returns
A not null data reference.
Since
1.0.0

◆ getHeader()

virtual const std::shared_ptr< FileHeader > keypop::calypso::card::card::ElementaryFile::getHeader ( ) const
pure virtual

Gets the file header.

Returns
Null if header is not yet set.
Since
1.0.0

◆ getSfi()

virtual uint8_t keypop::calypso::card::card::ElementaryFile::getSfi ( ) const
pure virtual

Gets the associated SFI.

Returns
The SFI.
Since
1.0.0

Friends And Related Function Documentation

◆ operator<< [1/3]

std::ostream & operator<< ( std::ostream &  os,
const ElementaryFile ef 
)
friend

Definition at line 108 of file ElementaryFile.hpp.

◆ operator<< [2/3]

std::ostream & operator<< ( std::ostream &  os,
const std::shared_ptr< ElementaryFile ef 
)
friend

Definition at line 119 of file ElementaryFile.hpp.

◆ operator<< [3/3]

std::ostream & operator<< ( std::ostream &  os,
const std::vector< std::shared_ptr< ElementaryFile > > &  ef 
)
friend

Definition at line 133 of file ElementaryFile.hpp.


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