Information about the framework. More...

Namespaces
namespace	Enumeration

Classes
class	API
	A convenient way to execute biometric technology evaluation API methods safely. More...

class	Status
	Information communicated back from framework methods. More...

Enumerations
enum class	APICurrentState { NeverCalled , WatchdogExpired , SignalCaught , ExceptionCaught , Running , Completed }
	Reasons operations could not complete. More...

Functions
unsigned int	getMajorVersion ()
	Framework major version. More...

unsigned int	getMinorVersion ()
	Framework minor version. More...

std::string	getCompiler ()
	Compiler used to compile this framework. More...

std::string	getCompileDate ()
	Date when this framework was compiled. More...

std::string	getCompileTime ()
	Time when this framework was compiled. More...

std::string	getCompilerVersion ()
	Version string of compiler used to compile this framework. More...

std::string	to_string (const Status &status)
	Obtain a textual representation of a Status. More...

std::ostream &	operator<< (std::ostream &s, const Status &status)
	Output stream operator overload. More...

Detailed Description

Information about the framework.

Enumeration Type Documentation

◆ APICurrentState

enum class BiometricEvaluation::Framework::APICurrentState

strong

Reasons operations could not complete.

Enumerator
NeverCalled	Operation was never executed.
WatchdogExpired	Watchdog timer expired.
SignalCaught	Signal handler was invoked.
ExceptionCaught	An exception was caught.
Running	Operation is running.
Completed	Operation has returned.

Definition at line 28 of file be_framework_api.h.

Function Documentation

◆ getMajorVersion()

unsigned int BiometricEvaluation::Framework::getMajorVersion ( )

Framework major version.

Returns: The major version number of the BiometricFramework

◆ getMinorVersion()

unsigned int BiometricEvaluation::Framework::getMinorVersion ( )

Framework minor version.

Returns: The minor version of the BiometricEvaluation framework.

◆ getCompiler()

std::string BiometricEvaluation::Framework::getCompiler ( )

Compiler used to compile this framework.

Returns: The name of the compiler used to compile this framework.

◆ getCompileDate()

std::string BiometricEvaluation::Framework::getCompileDate ( )

Date when this framework was compiled.

Returns: Date when this framework was compiled, in the form "MMM DD YYYY"

◆ getCompileTime()

std::string BiometricEvaluation::Framework::getCompileTime ( )

Time when this framework was compiled.

Returns: Time when this framework was compiled, in the form "HH:MM:SS"

◆ getCompilerVersion()

std::string BiometricEvaluation::Framework::getCompilerVersion ( )

Version string of compiler used to compile this framework.

Returns: Major, minor, and patch level of the compiler used.

◆ to_string()

std::string BiometricEvaluation::Framework::to_string ( const Status & status )

Obtain a textual representation of a Status.

Parameters

status Status object to convert.

Returns: Textual representation of status.

◆ operator<<()

std::ostream & BiometricEvaluation::Framework::operator<<	(	std::ostream &	s,
		const Status &	status
	)

Output stream operator overload.