humoto::config::RelaxedConfigurableBase Class Reference

Detailed Description

Definition at line 377 of file config.h.

#include <config.h>

Inheritance diagram for humoto::config::RelaxedConfigurableBase:

Public Member Functions
void	readConfig (t_Reader &reader, const bool crash_on_missing_entry=default_crash_on_missing_entry_)
	Read configuration (assuming the configuration node to be in the root). More...
void	readConfig (t_Reader &reader, const std::string &node_name, const bool crash_on_missing_entry=default_crash_on_missing_entry_)
	Read configuration (assuming the configuration node to be in the root). More...
void	readConfig (t_Reader &reader, const char *node_name, const bool crash_on_missing_entry=default_crash_on_missing_entry_)
	Read configuration (assuming the configuration node to be in the root). More...
void	readConfig (const std::string &file_name, const bool crash_on_missing_entry=default_crash_on_missing_entry_)
	Read configuration (assuming the configuration node to be in the root). More...
void	readConfig (const std::string &file_name, const std::string &node_name, const bool crash_on_missing_entry=default_crash_on_missing_entry_)
	Read configuration (assuming the configuration node to be in the root). More...
void	readConfig (const std::string &file_name, const char *node_name, const bool crash_on_missing_entry=default_crash_on_missing_entry_)
	Read configuration (assuming the configuration node to be in the root). More...
void	readNestedConfig (t_Reader &reader, const std::string &node_name, const bool crash_on_missing_entry=default_crash_on_missing_entry_)
	Read nested configuration node. More...
void	writeConfig (t_Writer &writer) const
	Write configuration. More...
void	writeConfig (t_Writer &writer, const std::string &node_name) const
	Write configuration. More...
void	writeConfig (const std::string &file_name) const
	Write configuration. More...
void	writeConfig (const std::string &file_name, const std::string &node_name) const
	Write configuration. More...
void	writeNestedConfig (t_Writer &writer) const
	Write nested configuration node. More...
void	writeNestedConfig (t_Writer &writer, const std::string &node_name) const
	Write nested configuration node. More...

Protected Member Functions
	RelaxedConfigurableBase ()
	~RelaxedConfigurableBase ()
	Protected destructor: prevent destruction of the child classes through a base pointer. More...
virtual void	finalize ()
	This function is called automaticaly after reading a configuration file. Does nothing by default. More...
virtual const std::string &	getConfigSectionID () const=0
	Return the default name of a configuration node corresponding to this class. More...
virtual std::size_t	getNumberOfEntries () const=0
	Get number of entries in the corresponding configuration node. More...
virtual void	setDefaults ()=0
	Set members to their default values. More...

Static Protected Attributes
static const bool	default_crash_on_missing_entry_

Constructor & Destructor Documentation

~RelaxedConfigurableBase()

humoto::config::RelaxedConfigurableBase::~RelaxedConfigurableBase ( )

inlineprotected

Protected destructor: prevent destruction of the child classes through a base pointer.

Definition at line 384 of file config.h.

RelaxedConfigurableBase()

humoto::config::RelaxedConfigurableBase::RelaxedConfigurableBase ( )

inlineprotected

Definition at line 385 of file config.h.

Member Function Documentation

finalize()

virtual void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::finalize ( )

inlineprotectedvirtualinherited

This function is called automaticaly after reading a configuration file. Does nothing by default.

Definition at line 102 of file config.h.

getConfigSectionID()

virtual const std::string& humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::getConfigSectionID ( ) const

protectedpure virtualinherited

Return the default name of a configuration node corresponding to this class.

Returns

the name

Attention

Implementation of this method is added automatically upon inclusion of define_accessors.h if HUMOTO_CONFIG_SECTION_ID is defined.

getNumberOfEntries()

virtual std::size_t humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::getNumberOfEntries ( ) const

protectedpure virtualinherited

Get number of entries in the corresponding configuration node.

Returns

number of entries

readConfig() [1/6]

void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::readConfig ( t_Reader &  reader, const bool  crash_on_missing_entry = default_crash_on_missing_entry_  )

inlineinherited

Read configuration (assuming the configuration node to be in the root).

Parameters

[in]	reader	configuration reader
[in]	crash_on_missing_entry

Definition at line 167 of file config.h.

readConfig() [2/6]

void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::readConfig ( t_Reader &  reader, const std::string &  node_name, const bool  crash_on_missing_entry = default_crash_on_missing_entry_  )

inlineinherited

Read configuration (assuming the configuration node to be in the root).

Parameters

[in]	reader	configuration reader
[in]	crash_on_missing_entry
[in]	node_name	node name, the default is used if empty

Definition at line 183 of file config.h.

readConfig() [3/6]

void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::readConfig ( t_Reader &  reader, const char *  node_name, const bool  crash_on_missing_entry = default_crash_on_missing_entry_  )

inlineinherited

Read configuration (assuming the configuration node to be in the root).

Parameters

[in]	reader	configuration reader
[in]	crash_on_missing_entry
[in]	node_name	node name, the default is used if empty

Note

Intercept implicit conversion of a pointer to bool.

Definition at line 202 of file config.h.

readConfig() [4/6]

void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::readConfig ( const std::string &  file_name, const bool  crash_on_missing_entry = default_crash_on_missing_entry_  )

inlineinherited

Read configuration (assuming the configuration node to be in the root).

Parameters

[in]	file_name	file name
[in]	crash_on_missing_entry

Definition at line 218 of file config.h.

readConfig() [5/6]

void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::readConfig ( const std::string &  file_name, const std::string &  node_name, const bool  crash_on_missing_entry = default_crash_on_missing_entry_  )

inlineinherited

Read configuration (assuming the configuration node to be in the root).

Parameters

[in]	file_name	file name
[in]	node_name	node name, the default is used if empty
[in]	crash_on_missing_entry

Definition at line 235 of file config.h.

readConfig() [6/6]

void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::readConfig ( const std::string &  file_name, const char *  node_name, const bool  crash_on_missing_entry = default_crash_on_missing_entry_  )

inlineinherited

Read configuration (assuming the configuration node to be in the root).

Parameters

[in]	file_name	file name
[in]	crash_on_missing_entry
[in]	node_name	node name, the default is used if empty

Note

Intercept implicit conversion of a pointer to bool.

Definition at line 255 of file config.h.

readNestedConfig()

void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::readNestedConfig ( t_Reader &  reader, const std::string &  node_name, const bool  crash_on_missing_entry = default_crash_on_missing_entry_  )

inlineinherited

Read nested configuration node.

Parameters

[in]	reader
[in]	crash_on_missing_entry
[in]	node_name	node name, the default is used if empty

Definition at line 132 of file config.h.

setDefaults()

virtual void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::setDefaults ( )

protectedpure virtualinherited

Set members to their default values.

writeConfig() [1/4]

void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::writeConfig ( t_Writer &  writer ) const

inlineinherited

Write configuration.

Parameters

[in,out]

writer

configuration writer

Definition at line 300 of file config.h.

writeConfig() [2/4]

void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::writeConfig ( t_Writer &  writer, const std::string &  node_name  ) const

inlineinherited

Write configuration.

Parameters

[in,out]	writer	configuration writer
[in]	node_name	node name, the default is used if empty

Definition at line 313 of file config.h.

writeConfig() [3/4]

void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::writeConfig ( const std::string &  file_name ) const

inlineinherited

Write configuration.

Parameters

[in]

file_name

file name

Definition at line 328 of file config.h.

writeConfig() [4/4]

void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::writeConfig ( const std::string &  file_name, const std::string &  node_name  ) const

inlineinherited

Write configuration.

Parameters

[in]	file_name	file name
[in]	node_name	node name, the default is used if empty

Definition at line 342 of file config.h.

writeNestedConfig() [1/2]

void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::writeNestedConfig ( t_Writer &  writer ) const

inlineinherited

Write nested configuration node.

Parameters

[in,out]

writer

configuration writer

Definition at line 272 of file config.h.

writeNestedConfig() [2/2]

void humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::writeNestedConfig ( t_Writer &  writer, const std::string &  node_name  ) const

inlineinherited

Write nested configuration node.

Parameters

[in,out]	writer	configuration writer
[in]	node_name	node name, the default is used if empty

Definition at line 285 of file config.h.

Member Data Documentation

default_crash_on_missing_entry_

const bool humoto::config::CommonConfigurableBase< t_crash_on_missing_entry >::default_crash_on_missing_entry_

staticprotectedinherited

Definition at line 67 of file config.h.

---

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

• core/include/config.h