keypop::calypso::card::transaction::SearchCommandData Class Reference

#include <SearchCommandData.hpp>

Public Member Functions
virtual SearchCommandData &	setSfi (const uint8_t sfi)=0
virtual SearchCommandData &	startAtRecord (const uint8_t recordNumber)=0
virtual SearchCommandData &	setOffset (const int offset)=0
virtual SearchCommandData &	enableRepeatedOffset ()=0
virtual SearchCommandData &	setSearchData (const std::vector< uint8_t > &data)=0
virtual SearchCommandData &	setMask (const std::vector< uint8_t > &mask)=0
virtual SearchCommandData &	fetchFirstMatchingResult ()=0
virtual std::vector< uint8_t > &	getMatchingRecordNumbers ()=0

Detailed Description

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

Since

1.1.0

Definition at line 26 of file SearchCommandData.hpp.

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< uint8_t > & 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< 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

mask

The mask.

Returns

The current instance.

Since

1.1.0

setOffset()

virtual SearchCommandData & keypop::calypso::card::transaction::SearchCommandData::setOffset ( const 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

offset

The offset.

Returns

The current instance.

Since

1.1.0

setSearchData()

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

pure virtual

Sets the data to search.

Parameters

data	The data to search.

Returns

The current instance.

Since

1.1.0

setSfi()

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

pure virtual

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

Parameters

sfi	The SFI of the EF.

Returns

The current instance.

Since

1.1.0

startAtRecord()

virtual SearchCommandData & keypop::calypso::card::transaction::SearchCommandData::startAtRecord ( const uint8_t  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

recordNumber

The 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:

• /github/workspace/include/keypop/calypso/card/transaction/SearchCommandData.hpp