BiometricEvaluation::Framework::Status Class Reference

Information communicated back from framework methods. More...

#include <be_framework_status.h>

Public Types
enum class	Type { Debug , Warning , Error }
	Type of status received. More...

Public Member Functions
	Status (Type type, const std::string &message, const std::string &identifier="")
	Status constructor. More...
Type	getType () const noexcept
	Obtain the Type of this Status' message. More...
std::string	getMessage () const noexcept
	Obtain the explanatory message from this Status. More...
std::string	getIdentifier () const noexcept
	Obtain the identifier from this Status. More...

Detailed Description

Information communicated back from framework methods.

Definition at line 24 of file be_framework_status.h.

Member Enumeration Documentation

Type

enum class BiometricEvaluation::Framework::Status::Type

strong

Type of status received.

Enumerator
Debug	Informational/debugging. Processing should continue.
Warning	Something seems off about the operation, but the output might be fine.
Error	Processing absolutely should stop.

Definition at line 28 of file be_framework_status.h.

Constructor & Destructor Documentation

Status()

BiometricEvaluation::Framework::Status::Status	(	Type	type,
		const std::string &	message,
		const std::string &	identifier = ""
	)

Status constructor.

Parameters

code	Return code from a function or method.
message	Message providing insight into code's value.

Member Function Documentation

getType()

Type BiometricEvaluation::Framework::Status::getType ( ) const

inlinenoexcept

Obtain the Type of this Status' message.

Returns

Type of status

Definition at line 66 of file be_framework_status.h.

getMessage()

std::string BiometricEvaluation::Framework::Status::getMessage ( ) const

inlinenoexcept

Obtain the explanatory message from this Status.

Returns

Explanatory message.

Note

May be empty.

Definition at line 84 of file be_framework_status.h.

getIdentifier()

std::string BiometricEvaluation::Framework::Status::getIdentifier ( ) const

inlinenoexcept

Obtain the identifier from this Status.

The identifier is used to provide more context about the message and is user-defined.

Returns

Identifier associated with this Status.

Note

May be empty.

Definition at line 105 of file be_framework_status.h.

---

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

• be_framework_status.h