Information about the execution of template comparison. More...

#include <pftiii.h>

Collaboration diagram for PFTIII::CompareProprietaryTemplatesStatus:

Public Member Functions
	CompareProprietaryTemplatesStatus (const Result result=Result::Success, const std::string &message="")
	CompareProprietaryTemplatesStatus constructor. More...

Static Public Member Functions
static CompareProprietaryTemplatesStatus	success ()
	Convenience method for comparison success. More...

static CompareProprietaryTemplatesStatus	failure (const std::string &message="")
	Convenience method for comparison failures. More...

Public Attributes
Result	result {}
	Outcome of comparing two proprietary templates. More...

std::string	message {}
	Explanatory message (optional). More...

Detailed Description

Information about the execution of template comparison.

Definition at line 249 of file pftiii.h.

Constructor & Destructor Documentation

◆ CompareProprietaryTemplatesStatus()

PFTIII::CompareProprietaryTemplatesStatus::CompareProprietaryTemplatesStatus	(	const Result	result = `Result::Success`,
		const std::string &	message = `""`
	)

CompareProprietaryTemplatesStatus constructor.

Parameters

result	Outcome of comparing two proprietary templates.
message	Message providing insight into result's value.

Definition at line 113 of file libpftiii.cpp.

Member Function Documentation

◆ success()

PFTIII::CompareProprietaryTemplatesStatus PFTIII::CompareProprietaryTemplatesStatus::success ( )

static

Convenience method for comparison success.

Returns: A CompareProprietaryTemplatesStatus that indicates success.

Definition at line 135 of file libpftiii.cpp.

◆ failure()

PFTIII::CompareProprietaryTemplatesStatus PFTIII::CompareProprietaryTemplatesStatus::failure ( const std::string & message = "" )

static

Convenience method for comparison failures.

Parameters

message Optional explanatory message regarding the failure.

Returns: A CompareProprietaryTemplatesStatus that indicates failure.

Definition at line 123 of file libpftiii.cpp.

Member Data Documentation

◆ result

Result PFTIII::CompareProprietaryTemplatesStatus::result {}

Outcome of comparing two proprietary templates.

Definition at line 290 of file pftiii.h.

◆ message

std::string PFTIII::CompareProprietaryTemplatesStatus::message {}

Explanatory message (optional).

Definition at line 292 of file pftiii.h.

The documentation for this struct was generated from the following files:

Public Member Functions

Static Public Member Functions

Public Attributes