PineForge HPO 1.11.0
Native hyperparameter optimization for PineForge strategies
Loading...
Searching...
No Matches
pineforge::hpo::EngineError Class Reference

An engine-owned failure whose optional metadata is forwarded without reclassification. More...

#include <pineforge/hpo/error.hpp>

+ Inheritance diagram for pineforge::hpo::EngineError:

Public Member Functions

 EngineError (std::optional< std::string > code, std::optional< std::string > args, const std::string &message)
 Preserves unavailable getters as null metadata and the original diagnostic text.
 
const std::optional< std::string > & raw_args () const noexcept
 Returns the untrusted engine JSON for transport validation, or unavailable metadata.
 
- Public Member Functions inherited from pineforge::hpo::TypedHpoError< Base >
 TypedHpoError (std::string code, ErrorArguments args, const std::string &message, FailureOrigin origin=FailureOrigin::Hpo)
 Constructs a coded exception with unchanged English text and optional provenance.
 
const char * what () const noexcept override
 Returns the original standard exception diagnostic.
 
- Public Member Functions inherited from pineforge::hpo::HpoError
 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
 
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

An engine-owned failure whose optional metadata is forwarded without reclassification.

Definition at line 84 of file error.hpp.

Constructor & Destructor Documentation

◆ EngineError()

pineforge::hpo::EngineError::EngineError ( std::optional< std::string >  code,
std::optional< std::string >  args,
const std::string &  message 
)
inline

Preserves unavailable getters as null metadata and the original diagnostic text.

Definition at line 87 of file error.hpp.

Member Function Documentation

◆ raw_args()

const std::optional< std::string > & pineforge::hpo::EngineError::raw_args ( ) const
inlinenoexcept

Returns the untrusted engine JSON for transport validation, or unavailable metadata.

Definition at line 93 of file error.hpp.


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