DefaultNuisancePathsProvider Struct Reference

#include <DefaultNuisancePathsProvider.h>

Inheritance diagram for DefaultNuisancePathsProvider:

Collaboration diagram for DefaultNuisancePathsProvider:

Public Member Functions
	DefaultNuisancePathsProvider (std::shared_ptr< IPathsProvider > paths_provider=std::make_shared< DefaultPathsProvider >())
fs::path	default_nuisances_path () const override
	Returns the path to the built-in nuisance definition file.
fs::path	user_nuisances_path () const override
	Returns the path to the user override nuisance definition file.
Public Member Functions inherited from INuisancePathsProvider
virtual	~INuisancePathsProvider ()=default
	Virtual destructor for polymorphic use.

Detailed Description

Definition at line 22 of file DefaultNuisancePathsProvider.h.

Constructor & Destructor Documentation

DefaultNuisancePathsProvider()

DefaultNuisancePathsProvider::DefaultNuisancePathsProvider ( std::shared_ptr< IPathsProvider >  paths_provider = std::make_shared<DefaultPathsProvider>() )

inlineexplicit

Definition at line 23 of file DefaultNuisancePathsProvider.h.

Member Function Documentation

default_nuisances_path()

fs::path DefaultNuisancePathsProvider::default_nuisances_path ( ) const

inlineoverridevirtual

Returns the path to the built-in nuisance definition file.

Returns

Filesystem path to the default nuisance registry.

Default: ASSETS_ROOT / "default" / "nuisances.json". Override through APIPath::DEFAULT_NUISANCES.

Implements INuisancePathsProvider.

Definition at line 34 of file DefaultNuisancePathsProvider.h.

user_nuisances_path()

fs::path DefaultNuisancePathsProvider::user_nuisances_path ( ) const

inlineoverridevirtual

Returns the path to the user override nuisance definition file.

Returns

Filesystem path to the user nuisance registry. The returned path may be empty when no user override file is configured.

Default: ASSETS_ROOT / "input_files" / "parameters" / "nuisances.yaml". Override through APIPath::USER_NUISANCES.

Implements INuisancePathsProvider.

Definition at line 44 of file DefaultNuisancePathsProvider.h.

---

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

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