Keypop Calypso Crypto Legacy SAM C++ API 0.6.0
Reference Calypso Crypto Legacy SAM API for C++
Public Member Functions | List of all members
keypop::calypso::crypto::legacysam::transaction::ReadTransactionManager< T > Class Template Referencefinalabstract

#include <ReadTransactionManager.hpp>

Inheritance diagram for keypop::calypso::crypto::legacysam::transaction::ReadTransactionManager< T >:
Inheritance graph
[legend]
Collaboration diagram for keypop::calypso::crypto::legacysam::transaction::ReadTransactionManager< T >:
Collaboration graph
[legend]

Public Member Functions

virtual T & prepareReadSystemKeyParameters (const SystemKeyType systemKeyType)=0
 
virtual T & prepareReadCounterStatus (const int counterNumber)=0
 
virtual T & prepareReadAllCountersStatus ()=0
 
- Public Member Functions inherited from keypop::calypso::crypto::legacysam::transaction::TransactionManager< T >
virtual T & processCommands ()=0
 

Detailed Description

template<typename T>
class keypop::calypso::crypto::legacysam::transaction::ReadTransactionManager< T >

Transaction manager dedicated to "READ" operations.

Parameters
<T>The type of the lowest level child object.
Since
0.1.0

Definition at line 27 of file ReadTransactionManager.hpp.

Member Function Documentation

◆ prepareReadAllCountersStatus()

template<typename T >
virtual T & keypop::calypso::crypto::legacysam::transaction::ReadTransactionManager< T >::prepareReadAllCountersStatus ( )
pure virtual

Schedules the execution of a "Read Event Counter" and "Read Ceiling" commands to read the status of all counters.

Returns
The current instance.
Since
0.2.0

◆ prepareReadCounterStatus()

template<typename T >
virtual T & keypop::calypso::crypto::legacysam::transaction::ReadTransactionManager< T >::prepareReadCounterStatus ( const int  counterNumber)
pure virtual

Schedules the execution of a "Read Event Counter" and "Read Ceiling" commands to read the status of a counter.

Note: the status of each counter of the record to which the targeted counter belongs will be read. The number of commands actually transmitted to the SAM will be optimized when the processCommands() method is executed.

Parameters
counterNumberThe number of the counter whose status is to be read (in range [0..26]).
Returns
The current instance.
Exceptions
IllegalArgumentExceptionIf the provided argument is out of range.
Since
0.2.0

◆ prepareReadSystemKeyParameters()

template<typename T >
virtual T & keypop::calypso::crypto::legacysam::transaction::ReadTransactionManager< T >::prepareReadSystemKeyParameters ( const SystemKeyType  systemKeyType)
pure virtual

Schedules the execution of a "Read Key Parameters" command for a system key.

Once this command is processed, the result is accessible with LegacySam::getSystemKeyParameter(SystemKeyType).

Parameters
systemKeyTypeThe type of system key.
Returns
The current instance.
Exceptions
IllegalArgumentExceptionIf the provided argument is null.
Since
0.2.0

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