pineforge::hpo::HpoError Class Reference

Stable machine-readable failure metadata shared by the standard exception families. More...

#include <pineforge/hpo/error.hpp>

Inheritance diagram for pineforge::hpo::HpoError:

Public Member Functions
	HpoError (std::string code, ErrorArguments args={}, FailureOrigin origin=FailureOrigin::Hpo)
	Constructs metadata; HPO codes and argument vocabularies are defined by the catalog.
virtual	~HpoError ()=default
virtual const char *	what () const noexcept=0
	Returns the unchanged legacy English diagnostic.
const std::string &	code () const noexcept
	Returns the stable failure code, never inferred from diagnostic text.
const ErrorArguments &	args () const noexcept
	Returns typed, catalog-declared scalar arguments.
FailureOrigin	origin () const noexcept
	Returns the component which owns the code.

Detailed Description

Stable machine-readable failure metadata shared by the standard exception families.

Catch HpoError for metadata, or the original standard family for legacy compatibility.

Definition at line 48 of file error.hpp.

Constructor & Destructor Documentation

HpoError()

pineforge::hpo::HpoError::HpoError ( std::string  code, ErrorArguments  args = {}, FailureOrigin  origin = FailureOrigin::Hpo  )

inline

Constructs metadata; HPO codes and argument vocabularies are defined by the catalog.

Definition at line 51 of file error.hpp.

~HpoError()

virtual pineforge::hpo::HpoError::~HpoError ( )

virtualdefault

Member Function Documentation

args()

const ErrorArguments & pineforge::hpo::HpoError::args ( ) const

inlinenoexcept

Returns typed, catalog-declared scalar arguments.

Definition at line 59 of file error.hpp.

code()

const std::string & pineforge::hpo::HpoError::code ( ) const

inlinenoexcept

Returns the stable failure code, never inferred from diagnostic text.

Definition at line 57 of file error.hpp.

Referenced by pineforge_hpo.dsr.DsrError::__reduce__(), pineforge_hpo.holdout.HoldoutError::__reduce__(), pineforge_hpo.neighbourhood.NeighbourhoodError::__reduce__(), pineforge_hpo.pareto.ParetoError::__reduce__(), pineforge_hpo.walkforward.WalkforwardError::__reduce__(), pineforge_hpo.dsr.DsrError::document(), pineforge_hpo.holdout.HoldoutError::document(), pineforge_hpo.neighbourhood.NeighbourhoodError::document(), pineforge_hpo.pareto.ParetoError::document(), pineforge_hpo.pbo.PboError::document(), and pineforge_hpo.walkforward.WalkforwardError::document().

origin()

FailureOrigin pineforge::hpo::HpoError::origin ( ) const

inlinenoexcept

Returns the component which owns the code.

Definition at line 61 of file error.hpp.

what()

virtual const char * pineforge::hpo::HpoError::what ( ) const

pure virtualnoexcept

Returns the unchanged legacy English diagnostic.

Implemented in pineforge::hpo::TypedHpoError< Base >.

---

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

• error.hpp