VIPRA Documentation
Loading...
Searching...
No Matches
VIPRA::Modules::BaseModule< class_t > Class Template Reference

VIPRA Module Base CRTP Class. More...

#include <module.hpp>

Inheritance diagram for VIPRA::Modules::BaseModule< class_t >:
Collaboration diagram for VIPRA::Modules::BaseModule< class_t >:

Public Member Functions

void register_base_params (Parameters &paramIn)
 Registers the modules parameters with the parameter reader.
 
void config_base (Parameters &paramIn, VIPRA::Random::Engine &engine)
 Loads in all parameters for the module.
 

Detailed Description

template<typename class_t>
class VIPRA::Modules::BaseModule< class_t >

VIPRA Module Base CRTP Class.

Template Parameters
class_t

Member Function Documentation

◆ config_base()

template<typename class_t>
void VIPRA::Modules::BaseModule< class_t >::config_base ( Parameters & paramIn,
VIPRA::Random::Engine & engine )

Loads in all parameters for the module.

Template Parameters
Parameters
Parameters
paramIn
engine

◆ register_base_params()

template<typename class_t>
void VIPRA::Modules::BaseModule< class_t >::register_base_params ( Parameters & paramIn)

Registers the modules parameters with the parameter reader.

Template Parameters
Parameters
Parameters
paramIn

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