VIPRA::Parameters Class Reference

Public Member Functions
void	reset ()
	Clears the parameters, does NOT reset the input module.
void	register_param (Modules::Type module, std::string const &moduleName, std::string const &paramName)
	Registers a parameter for a module.
auto	has_param (Modules::Type module, std::string const &moduleName, std::string const &paramName) const -> bool
	Returns true if the parameter exists, otherwise false.
auto	has_required_param (Modules::Type module, std::string const &moduleName, std::string const &paramName) const -> bool
	Returns true if the parameter exists, otherwise false.
auto	get_input () -> VIPRA::Input::JSON &
auto	get_used_parameters () const -> std::string
template<typename data_t>
auto	get_param (Modules::Type module, std::string const &moduleName, std::string const &paramName, Random::Engine &engine) const -> std::remove_cvref_t< data_t >
	Returns the value of the parameter if it exists, otherwise throws an error.

Member Function Documentation

get_param()

template<typename data_t>

auto VIPRA::Parameters::get_param ( Modules::Type module, std::string const & moduleName, std::string const & paramName, Random::Engine & engine ) const -> std::remove_cvref_t<data_t>

nodiscard

Returns the value of the parameter if it exists, otherwise throws an error.

Template Parameters

data_t

Parameters

module
moduleName
paramName

Returns

data_t

has_param()

auto VIPRA::Parameters::has_param ( Modules::Type module, std::string const & moduleName, std::string const & paramName ) const -> bool

nodiscard

Returns true if the parameter exists, otherwise false.

Parameters

module
moduleName
paramName

Returns

true

false

has_required_param()

auto VIPRA::Parameters::has_required_param ( Modules::Type module, std::string const & moduleName, std::string const & paramName ) const -> bool

nodiscard

Returns true if the parameter exists, otherwise false.

Parameters

module
moduleName
paramName

Returns

true

false

register_param()

void VIPRA::Parameters::register_param	(	Modules::Type	module,
		std::string const &	moduleName,
		std::string const &	paramName )

Registers a parameter for a module.

Template Parameters

module_t
param_t

Parameters

module
moduleName
paramName
param

reset()

void VIPRA::Parameters::reset

(

)

Clears the parameters, does NOT reset the input module.

Template Parameters

VIPRA::Input::JSON

---

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

• include/vipra/special_modules/parameters.hpp
• src/parameters.cpp