PFTIII::CreateProprietaryTemplateResult Struct Reference

Output from extracting features into a proprietary template . More...

#include <pftiii.h>

Collaboration diagram for PFTIII::CreateProprietaryTemplateResult:

Static Public Member Functions
static CreateProprietaryTemplateResult	success (const std::vector< std::byte > &proprietaryTemplate, const std::string &message="")
	Convenience method for creation success. More...
static CreateProprietaryTemplateResult	failure (const std::string &message="")
	Convenience method for creation failures. More...

Public Attributes
Result	result {Result::Success}
	Result of extracting features and creating a template. More...
std::vector< std::byte >	proprietaryTemplate {}
	Contents of the proprietary template. More...
std::string	message {}
	Explanatory message (optional). More...

Detailed Description

Output from extracting features into a proprietary template .

Definition at line 207 of file pftiii.h.

Member Function Documentation

success()

PFTIII::CreateProprietaryTemplateResult PFTIII::CreateProprietaryTemplateResult::success ( const std::vector< std::byte > &  proprietaryTemplate, const std::string &  message = ""  )

static

Convenience method for creation success.

Parameters

proprietaryTemplate	Contents of the proprietary template.
message	Optional explanatory message.

Returns

A CreateProprietaryTemplateResult that indicates success.

Definition at line 53 of file libpftiii.cpp.

failure()

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

static

Convenience method for creation failures.

Parameters

message

Optional explanatory message regarding the failure.

Returns

A CreateProprietaryTemplateResult that indicates failure.

Definition at line 40 of file libpftiii.cpp.

Member Data Documentation

result

Result PFTIII::CreateProprietaryTemplateResult::result {Result::Success}

Result of extracting features and creating a template.

Definition at line 241 of file pftiii.h.

proprietaryTemplate

std::vector<std::byte> PFTIII::CreateProprietaryTemplateResult::proprietaryTemplate {}

Contents of the proprietary template.

Definition at line 243 of file pftiii.h.

message

std::string PFTIII::CreateProprietaryTemplateResult::message {}

Explanatory message (optional).

Definition at line 245 of file pftiii.h.

---

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

• pftiii.h
• libpftiii.cpp