Keyple C++  0.9.0
Keyple, an Open Source SDK for Ticketing
Classes | Public Member Functions | Static Public Member Functions | Friends | List of all members
keyple::calypso::transaction::DirectoryHeader Class Referencefinal

#include <DirectoryHeader.h>

Classes

class  DirectoryHeaderBuilder
 

Public Member Functions

uint16_t getLid () const
 
const std::vector< uint8_t > & getAccessConditions () const
 
const std::vector< uint8_t > & getKeyIndexes () const
 
uint8_t getDfStatus () const
 
uint8_t getKif (const AccessLevel &level) const
 
uint8_t getKvc (const AccessLevel &level) const
 
bool operator== (const DirectoryHeader &o) const
 

Static Public Member Functions

static std::unique_ptr< DirectoryHeaderBuilderbuilder ()
 

Friends

KEYPLECALYPSO_API std::ostream & operator<< (std::ostream &os, const DirectoryHeader &dh)
 

Detailed Description

The class

DirectoryHeader

contains all metadata of a Calypso DF.

Since
0.9

Member Function Documentation

◆ builder()

std::unique_ptr< DirectoryHeaderBuilder > keyple::calypso::transaction::DirectoryHeader::builder ( )
static

(package-private)
Gets a new builder.

Returns
a new builder instance

◆ getAccessConditions()

const std::vector< uint8_t > & keyple::calypso::transaction::DirectoryHeader::getAccessConditions ( ) const

Gets a reference to access conditions.

Returns
a not empty byte array
Since
0.9

◆ getDfStatus()

uint8_t keyple::calypso::transaction::DirectoryHeader::getDfStatus ( ) const

Gets the DF status.

Returns
the DF status byte
Since
0.9

◆ getKeyIndexes()

const std::vector< uint8_t > & keyple::calypso::transaction::DirectoryHeader::getKeyIndexes ( ) const

Gets a reference to keys indexes.

Returns
a not empty byte array
Since
0.9

◆ getKif()

uint8_t keyple::calypso::transaction::DirectoryHeader::getKif ( const AccessLevel level) const

Gets the KIF associated to the provided session access level.

Parameters
levelthe session access level (should be not null)
Returns
a not null value
Exceptions
IllegalArgumentExceptionif level is null.
NoSuchElementExceptionif KIF is not found.
Since
0.9

◆ getKvc()

uint8_t keyple::calypso::transaction::DirectoryHeader::getKvc ( const AccessLevel level) const

Gets the KVC associated to the provided session access level.

Parameters
levelthe session access level (should be not null)
Returns
a not null value
Exceptions
IllegalArgumentExceptionif level is null.
NoSuchElementExceptionif KVC is not found.
Since
0.9

◆ getLid()

uint16_t keyple::calypso::transaction::DirectoryHeader::getLid ( ) const

Gets the associated LID.

Returns
the LID
Since
0.9

◆ operator==()

bool keyple::calypso::transaction::DirectoryHeader::operator== ( const DirectoryHeader o) const

Comparison is based on field "lid".

Parameters
othe object to compare
Returns
the comparison evaluation
Since
0.9

Friends And Related Function Documentation

◆ operator<<

KEYPLECALYPSO_API std::ostream& operator<< ( std::ostream &  os,
const DirectoryHeader dh 
)
friend

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