Keypop Calypso Card C++ API - 2.1.2
Component of the Keypop C++ API
Public Member Functions | List of all members
keypop::calypso::card::transaction::SearchCommandData Class Referenceabstract

Contains the input/output data of the CardTransactionManager::prepareSearchRecords(SearchCommandData) method. More...

#include <keypop/calypso/card/transaction/SearchCommandData.hpp>

Public Member Functions

virtual ~SearchCommandData ()=default
 Virtual destructor. More...
 
virtual SearchCommandData & setSfi (std::uint8_t sfi)=0
 Sets the SFI of the EF in which the search is to be performed. More...
 
virtual SearchCommandData & startAtRecord (int recordNumber)=0
 Sets the number of the record where the search should begin. More...
 
virtual SearchCommandData & setOffset (int offset)=0
 Sets the offset in number of bytes from which the analysis should be performed within a record. More...
 
virtual SearchCommandData & enableRepeatedOffset ()=0
 Allows the command to analyze the data present at the given offset, and repeatedly at each following offset, until the end of the record is reached. More...
 
virtual SearchCommandData & setSearchData (const std::vector< std::uint8_t > &data)=0
 Sets the data to search. More...
 
virtual SearchCommandData & setMask (const std::vector< std::uint8_t > &mask)=0
 Sets the mask of bits to take into account during the comparison (padded right with FFh if absent or incomplete). More...
 
virtual SearchCommandData & fetchFirstMatchingResult ()=0
 Requests to fetch the content of the first matching record into the org.calypsonet.terminal.calypso.card.CalypsoCard. More...
 
virtual std::vector< int > & getMatchingRecordNumbers ()=0
 Returns a list containing the numbers of the records who has matched. More...
 

Detailed Description

Contains the input/output data of the CardTransactionManager::prepareSearchRecords(SearchCommandData) method.

Since
1.1.0

Definition at line 27 of file SearchCommandData.hpp.

Constructor & Destructor Documentation

◆ ~SearchCommandData()

virtual keypop::calypso::card::transaction::SearchCommandData::~SearchCommandData ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ enableRepeatedOffset()

virtual SearchCommandData & keypop::calypso::card::transaction::SearchCommandData::enableRepeatedOffset ( )
pure virtual

Allows the command to analyze the data present at the given offset, and repeatedly at each following offset, until the end of the record is reached.

The last offset is less or equal than ((record size) − (length of the search data)).

Returns
The current instance.
Since
1.1.0

◆ fetchFirstMatchingResult()

virtual SearchCommandData & keypop::calypso::card::transaction::SearchCommandData::fetchFirstMatchingResult ( )
pure virtual

Requests to fetch the content of the first matching record into the org.calypsonet.terminal.calypso.card.CalypsoCard.

Returns
The current instance.
Since
1.1.0

◆ getMatchingRecordNumbers()

virtual std::vector< int > & keypop::calypso::card::transaction::SearchCommandData::getMatchingRecordNumbers ( )
pure virtual

Returns a list containing the numbers of the records who has matched.

Returns
An empty list if no record has matched or if the command has not yet been processed.
Since
1.1.0

◆ setMask()

virtual SearchCommandData & keypop::calypso::card::transaction::SearchCommandData::setMask ( const std::vector< std::uint8_t > &  mask)
pure virtual

Sets the mask of bits to take into account during the comparison (padded right with FFh if absent or incomplete).

Requirement: The length of the mask must be less or equal than the length of the data to search.

Parameters
maskThe mask.
Returns
The current instance.
Since
1.1.0

◆ setOffset()

virtual SearchCommandData & keypop::calypso::card::transaction::SearchCommandData::setOffset ( int  offset)
pure virtual

Sets the offset in number of bytes from which the analysis should be performed within a record.

By default, the analysis will start at the beginning of the record (offset 0).

Parameters
offsetThe offset.
Returns
The current instance.
Since
1.1.0

◆ setSearchData()

virtual SearchCommandData & keypop::calypso::card::transaction::SearchCommandData::setSearchData ( const std::vector< std::uint8_t > &  data)
pure virtual

Sets the data to search.

Parameters
dataThe data to search.
Returns
The current instance.
Since
1.1.0

◆ setSfi()

virtual SearchCommandData & keypop::calypso::card::transaction::SearchCommandData::setSfi ( std::uint8_t  sfi)
pure virtual

Sets the SFI of the EF in which the search is to be performed.

Parameters
sfiThe SFI of the EF.
Returns
The current instance.
Since
1.1.0

◆ startAtRecord()

virtual SearchCommandData & keypop::calypso::card::transaction::SearchCommandData::startAtRecord ( int  recordNumber)
pure virtual

Sets the number of the record where the search should begin.

By default, the search will begin from the first record.

Parameters
recordNumberThe number of the record where the search should begin.
Returns
The current instance.
Since
1.1.0
The documentation for this class was generated from the following file: