INuisanceReader Class Reference

Abstract interface for nuisance specification loaders. More...

#include <INuisanceReader.h>

Inheritance diagram for INuisanceReader:

Public Member Functions
virtual	~INuisanceReader ()=default
	Virtual destructor for polymorphic use.
virtual NuisanceRegistry	load_default () const =0
	Loads the built-in nuisance-parameter registry.
virtual NuisanceRegistry	load_user () const =0
	Loads the nuisance registry from the configured user source.
virtual NuisanceRegistry	load_user (const fs::path &user_path) const =0
	Loads the nuisance registry from an explicit user file.

Detailed Description

Abstract interface for nuisance specification loaders.

A nuisance reader returns registries keyed by ParamId. The default and user registries can be loaded independently so that callers may decide how to merge them.

Definition at line 30 of file INuisanceReader.h.

Constructor & Destructor Documentation

~INuisanceReader()

virtual INuisanceReader::~INuisanceReader ( )

virtualdefault

Virtual destructor for polymorphic use.

Member Function Documentation

load_default()

virtual NuisanceRegistry INuisanceReader::load_default ( ) const

pure virtual

Loads the built-in nuisance-parameter registry.

Returns

Registry containing the default nuisance specifications.

Exceptions

std::runtime_error

if the default source is missing, malformed, or cannot be parsed by the concrete implementation.

Implemented in NuisanceReader.

load_user() [1/2]

virtual NuisanceRegistry INuisanceReader::load_user ( ) const

pure virtual

Loads the nuisance registry from the configured user source.

Returns

Registry containing user-defined nuisance specifications. The registry may be empty when no user source is configured.

Exceptions

std::runtime_error

if the configured user source exists but cannot be read or parsed.

Implemented in NuisanceReader.

load_user() [2/2]

virtual NuisanceRegistry INuisanceReader::load_user ( const fs::path &  user_path ) const

pure virtual

Loads the nuisance registry from an explicit user file.

Parameters

user_path

Path to the user nuisance file. An empty path may be interpreted by implementations as "no user overrides".

Returns

Registry containing nuisance specifications from user_path.

Exceptions

std::runtime_error

if user_path is non-empty but missing, unreadable, or malformed.

Implemented in NuisanceReader.

---

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

• /home/runner/work/Hyperiso/Hyperiso/Hyperiso/Hyperiso/core/src/Statistic/domain/INuisanceReader.h