NIST Fingerprint Image Quality 2
Fingerprint image quality assessment tool
Public Member Functions | List of all members
NFIQ2::Data Class Reference

Binary data. More...

#include <nfiq2_data.hpp>

Inherits std::basic_string< uint8_t >.

Inherited by NFIQ2::FingerprintImageData.

Public Member Functions

 Data ()
 Default Data constructor. More...
 
 Data (const uint8_t *pData, uint32_t dataSize)
 Constructor with available pointer to data. More...
 
 Data (const Data &otherData)
 Copy constructor. More...
 
 Data (const std::basic_string< uint8_t > &otherData)
 Constructor with string-based data. More...
 
virtual ~Data ()
 Destructor. More...
 
void readFromFile (const std::string &filename)
 Reads the content from the a file into this object. More...
 
void writeToFile (const std::string &filename) const
 Writes the content to a file. More...
 
std::string toHexString () const
 Generates a string in hexadecimal format of the buffer. More...
 
void fromBase64String (const std::string &base64String)
 Imports data from a Base64 encoded string. More...
 
std::string toBase64String () const
 Generates a string in Base64 format of the buffer. More...
 

Detailed Description

Binary data.

Definition at line 23 of file nfiq2_data.hpp.

Constructor & Destructor Documentation

◆ Data() [1/4]

NFIQ2::Data::Data ( )

Default Data constructor.

◆ Data() [2/4]

NFIQ2::Data::Data ( const uint8_t *  pData,
uint32_t  dataSize 
)

Constructor with available pointer to data.

Parameters
pDataData pointer.
dataSizeSize of data at data pointer.

◆ Data() [3/4]

NFIQ2::Data::Data ( const Data otherData)

Copy constructor.

◆ Data() [4/4]

NFIQ2::Data::Data ( const std::basic_string< uint8_t > &  otherData)
explicit

Constructor with string-based data.

Parameters
otherDataBinary data in string format.

◆ ~Data()

virtual NFIQ2::Data::~Data ( )
virtual

Destructor.

Member Function Documentation

◆ readFromFile()

void NFIQ2::Data::readFromFile ( const std::string &  filename)

Reads the content from the a file into this object.

Parameters
filenameThe path of the file that will be read.
Exceptions
NFIQ2::ExceptionFile cannot be opened.

◆ writeToFile()

void NFIQ2::Data::writeToFile ( const std::string &  filename) const

Writes the content to a file.

Parameters
filenameThe path of the file that will be written to.
Exceptions
NFIQ2::ExceptionFile cannot be opened.

◆ toHexString()

std::string NFIQ2::Data::toHexString ( ) const

Generates a string in hexadecimal format of the buffer.

Returns
The content of the buffer as hexadecimal string.
Exceptions
NFIQ2::ExceptionNo data available in buffer.

◆ fromBase64String()

void NFIQ2::Data::fromBase64String ( const std::string &  base64String)

Imports data from a Base64 encoded string.

Parameters
base64StringThe Base64 encoded string.
Exceptions
NFIQ2::ExceptionIf invalid character is detected in string.

◆ toBase64String()

std::string NFIQ2::Data::toBase64String ( ) const

Generates a string in Base64 format of the buffer.

Returns
The content of the buffer as Base64 encoded string.

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