Alien  1.3.0
User documentation
Loading...
Searching...
No Matches
Alien::BaseParameterMng Class Reference

Public Member Functions

BaseParameterMng * getChild ()
BaseParameterMng const * getChild () const
bool hasChild () const
const BaseParameterMng * getChild (Arccore::Integer child) const
BaseParameterMng * getChild (Integer child)
void setNbChild (Integer nbChild)
template<typename ValueT>
std::map< std::string, ValueT > const & getParams () const
template<typename ValueT>
std::map< std::string, ValueT > & getParams ()
template<typename ValueT>
void setParameter (std::string const &key, ValueT const &value)
template<typename ValueT>
ValueT getParameter (std::string const &key, ValueT default_value) const
template<typename ValueT>
void addOptions (std::vector< std::string > &options, std::map< std::string, ValueT > const &params)
void addOptions (std::vector< std::string > &options)
void notifyParamChangesObserver ()
void resetParamChangesObserver ()
bool needUpdate ()
template<>
std::map< std::string, int > const & getParams () const
template<>
std::map< std::string, int > & getParams ()
template<>
std::map< std::string, double > const & getParams () const
template<>
std::map< std::string, double > & getParams ()
template<>
std::map< std::string, std::string > const & getParams () const
template<>
std::map< std::string, std::string > & getParams ()
template<>
ALIEN_EXPORT std::map< std::string, int > const & getParams () const
template<>
ALIEN_EXPORT std::map< std::string, int > & getParams ()
template<>
ALIEN_EXPORT std::map< std::string, double > const & getParams () const
template<>
ALIEN_EXPORT std::map< std::string, double > & getParams ()
template<>
ALIEN_EXPORT std::map< std::string, std::string > const & getParams () const
template<>
ALIEN_EXPORT std::map< std::string, std::string > & getParams ()

Protected Attributes

std::map< std::string, int > m_int_params
std::map< std::string, double > m_double_params
std::map< std::string, std::string > m_string_params
BaseParameterMng * m_child_mng
Integer m_nb_child
bool m_parameters_have_changed

Detailed Description

Definition at line 37 of file BaseParameterManager.h.

Constructor & Destructor Documentation

◆ BaseParameterMng()

Alien::BaseParameterMng::BaseParameterMng ( )
inline

Definition at line 40 of file BaseParameterManager.h.

◆ ~BaseParameterMng()

virtual Alien::BaseParameterMng::~BaseParameterMng ( )
inlinevirtual

Definition at line 46 of file BaseParameterManager.h.

Member Function Documentation

◆ addOptions() [1/2]

void Alien::BaseParameterMng::addOptions ( std::vector< std::string > & options)
inline

Definition at line 123 of file BaseParameterManager.h.

◆ addOptions() [2/2]

template<typename ValueT>
void Alien::BaseParameterMng::addOptions ( std::vector< std::string > & options,
std::map< std::string, ValueT > const & params )
inline

Definition at line 112 of file BaseParameterManager.h.

◆ getChild() [1/4]

BaseParameterMng * Alien::BaseParameterMng::getChild ( )
inline

Definition at line 54 of file BaseParameterManager.h.

◆ getChild() [2/4]

BaseParameterMng const * Alien::BaseParameterMng::getChild ( ) const
inlinenodiscard

Definition at line 63 of file BaseParameterManager.h.

◆ getChild() [3/4]

const BaseParameterMng * Alien::BaseParameterMng::getChild ( Arccore::Integer child) const
inlinenodiscard

Definition at line 67 of file BaseParameterManager.h.

◆ getChild() [4/4]

BaseParameterMng * Alien::BaseParameterMng::getChild ( Integer child)
inline

Definition at line 73 of file BaseParameterManager.h.

◆ getParameter()

template<typename ValueT>
ValueT Alien::BaseParameterMng::getParameter ( std::string const & key,
ValueT default_value ) const
inline

Definition at line 102 of file BaseParameterManager.h.

◆ getParams() [1/6]

template<>
std::map< std::string, std::string > & Alien::BaseParameterMng::getParams ( )

Definition at line 77 of file BaseParameterManager.cc.

◆ getParams() [2/6]

template<>
std::map< std::string, double > & Alien::BaseParameterMng::getParams ( )

Definition at line 59 of file BaseParameterManager.cc.

◆ getParams() [3/6]

template<>
std::map< std::string, int > & Alien::BaseParameterMng::getParams ( )

Definition at line 41 of file BaseParameterManager.cc.

◆ getParams() [4/6]

template<>
std::map< std::string, std::string > const & Alien::BaseParameterMng::getParams ( ) const

Definition at line 68 of file BaseParameterManager.cc.

◆ getParams() [5/6]

template<>
std::map< std::string, double > const & Alien::BaseParameterMng::getParams ( ) const

Definition at line 50 of file BaseParameterManager.cc.

◆ getParams() [6/6]

template<>
std::map< std::string, int > const & Alien::BaseParameterMng::getParams ( ) const

Definition at line 32 of file BaseParameterManager.cc.

◆ hasChild()

bool Alien::BaseParameterMng::hasChild ( ) const
inlinenodiscard

Definition at line 65 of file BaseParameterManager.h.

◆ needUpdate()

bool Alien::BaseParameterMng::needUpdate ( )
inline

Definition at line 135 of file BaseParameterManager.h.

◆ notifyParamChangesObserver()

void Alien::BaseParameterMng::notifyParamChangesObserver ( )
inline

Definition at line 130 of file BaseParameterManager.h.

◆ resetParamChangesObserver()

void Alien::BaseParameterMng::resetParamChangesObserver ( )
inline

Definition at line 133 of file BaseParameterManager.h.

◆ setNbChild()

void Alien::BaseParameterMng::setNbChild ( Integer nbChild)
inline

Definition at line 79 of file BaseParameterManager.h.

◆ setParameter()

template<typename ValueT>
void Alien::BaseParameterMng::setParameter ( std::string const & key,
ValueT const & value )
inline

Definition at line 96 of file BaseParameterManager.h.

Member Data Documentation

◆ m_child_mng

BaseParameterMng* Alien::BaseParameterMng::m_child_mng
protected

Definition at line 141 of file BaseParameterManager.h.

◆ m_double_params

std::map<std::string, double> Alien::BaseParameterMng::m_double_params
protected

Definition at line 139 of file BaseParameterManager.h.

◆ m_int_params

std::map<std::string, int> Alien::BaseParameterMng::m_int_params
protected

Definition at line 138 of file BaseParameterManager.h.

◆ m_nb_child

Integer Alien::BaseParameterMng::m_nb_child
protected

Definition at line 142 of file BaseParameterManager.h.

◆ m_parameters_have_changed

bool Alien::BaseParameterMng::m_parameters_have_changed
protected

Definition at line 143 of file BaseParameterManager.h.

◆ m_string_params

std::map<std::string, std::string> Alien::BaseParameterMng::m_string_params
protected

Definition at line 140 of file BaseParameterManager.h.

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