recursive_configurable_driver< T > Class Template Reference

Class that encapsulates recursive_configurable class. More...

#include <recursive_configurable_module.h>

Inheritance diagram for recursive_configurable_driver< T >:

Public Member Functions
	recursive_configurable_driver (std::string name, std::string argname="")
	Constructor for recursive_configurable_driver. More...
	recursive_configurable_driver (recursive_configurable *parent, std::string name)
	Constructor for recursive_configurable_driver. More...
void	set_name (std::string long_name, std::string argname="")
	Set name. More...
void	set_argument_name (std::string argname)
	Set argument name. More...
void	set_environment (std::string name, const void *value)
	Set the pointer to an environmental value associated with an input name. More...
virtual void	load (configuration &config) override
	Do loading. More...
virtual void	configure (configuration &config) override
	Do configure. More...
virtual void	initialize (const configurable::environment_map &environment) override
	Initialize with an environmental map. More...
T *	operator-> ()
	Get the raw pointer. More...
const T *	operator-> () const
	Get the const raw pointer. More...
T *	get ()
	Get the raw pointer. More...
const T *	get () const
	Get the raw pointer. More...
Public Member Functions inherited from configurable
virtual void	setup_now (configuration &config=get_global_configuration())
	Run load - configure - initialize processes.
virtual bool	not_recursive ()
	Check if this instance is not derived from recursive_configurable. More...
Public Member Functions inherited from messageable
virtual bool	send_message (std::string message, void *ptr=nullptr)
	Send a message. More...
virtual bool	const_send_message (std::string message, void *ptr=nullptr) const
	Send a message. More...

Additional Inherited Members
Public Types inherited from configurable
using	environment_map = std::map< std::string, const void * >
	Type for environment_map.
Static Public Member Functions inherited from configurable
static configuration &	set_global_configuration (const configuration &config)
	Assign the global settings of the program. More...
static configuration &	get_global_configuration ()
	Get the global settings of the program. More...
template<class T >
static const T &	get_env (const environment_map &environment, std::string key)
	Extract an specified type of pointer from the input environment. More...
Protected Member Functions inherited from configurable
bool	check_set (const environment_map &environment, std::vector< std::string > names)
	Check if the values for a variable keys exist. More...

Detailed Description

template<class T>
class recursive_configurable_driver< T >

Class that encapsulates recursive_configurable class.

Constructor & Destructor Documentation

recursive_configurable_driver() [1/2]

template<class T >

recursive_configurable_driver< T >::recursive_configurable_driver ( std::string  name, std::string  argname = ""  )

inline

Constructor for recursive_configurable_driver.

Parameters

[in]	name	Module name.
[in]	argname	Argument name for this instance.

recursive_configurable_driver() [2/2]

template<class T >

recursive_configurable_driver< T >::recursive_configurable_driver ( recursive_configurable *  parent, std::string  name  )

inline

Constructor for recursive_configurable_driver.

Parameters

[in]	parent	Full mame for this instance.
[in]	name	Module name.

Member Function Documentation

configure()

template<class T >

virtual void recursive_configurable_driver< T >::configure ( configuration &  config )

inlineoverridevirtual

Do configure.

Parameters

[in]

config

Configuration setting.

Reimplemented from configurable.

get() [1/2]

template<class T >

T* recursive_configurable_driver< T >::get ( )

inline

Get the raw pointer.

Returns

Raw poiter.

get() [2/2]

template<class T >

const T* recursive_configurable_driver< T >::get ( ) const

inline

Get the raw pointer.

Returns

Raw poiter.

initialize()

template<class T >

virtual void recursive_configurable_driver< T >::initialize ( const configurable::environment_map &  environment )

inlineoverridevirtual

Initialize with an environmental map.

Parameters

[in]

environment

Enivironmental map.

Reimplemented from configurable.

load()

template<class T >

virtual void recursive_configurable_driver< T >::load ( configuration &  config )

inlineoverridevirtual

Do loading.

Parameters

[in]

config

Configuration setting.

Reimplemented from configurable.

operator->() [1/2]

template<class T >

T* recursive_configurable_driver< T >::operator-> ( )

inline

Get the raw pointer.

Returns

Raw poiter.

operator->() [2/2]

template<class T >

const T* recursive_configurable_driver< T >::operator-> ( ) const

inline

Get the const raw pointer.

Returns

Const raw poiter.

set_argument_name()

template<class T >

void recursive_configurable_driver< T >::set_argument_name ( std::string  argname )

inline

Set argument name.

Parameters

[in]

argname

Argument name for this instance.

set_environment()

template<class T >

void recursive_configurable_driver< T >::set_environment ( std::string  name, const void *  value  )

inline

Set the pointer to an environmental value associated with an input name.

Parameters

[in]	name	Name for the environmental value to set.
[in]	value	Pointer to the value to set.

set_name()

template<class T >

void recursive_configurable_driver< T >::set_name ( std::string  long_name, std::string  argname = ""  )

inline

Set name.

Parameters

[in]	long_name	Module name.
[in]	argname	Argument name for this instance.

---

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

• include/shiokaze/core/recursive_configurable_module.h