OBT::ConfigurationTree Class Reference

#include <OBTConfigurationTree.h>

Collaboration diagram for OBT::ConfigurationTree:

[legend]

List of all members.

Public Member Functions
const ConfigurationItem &	getRoot () const
void	addChild (const ConfigurationItem &child)
Private Member Functions
	ConfigurationTree ()
	ConfigurationTree (const ConfigurationTree &ConfigurationTree)
const ConfigurationTree &	operator= (const ConfigurationTree &ConfigurationTree)
virtual	~ConfigurationTree ()
ConfigurationItem &	touchRoot ()
Private Attributes
ConfigurationItem	_parametersRoot
	root of the configuration items
Friends
class	Singleton< ConfigurationTree >
class	AbstractConfigurationFileParser

---

Detailed Description

Singleton class providing a unique access point to the configuration items tree.

Author:

Michaël Rouillé <michael.rouille@gmail.com>

At the very beginnning of the application, this singleton is filled with the configuration items tree loaded by the configuration file parser.

Definition at line 18 of file OBTConfigurationTree.h.

---

Constructor & Destructor Documentation

ConfigurationTree::ConfigurationTree

(

)

[private]

constructor

Definition at line 8 of file OBTConfigurationTree.cpp.

:
_parametersRoot( "ROOT" )
{
}

OBT::ConfigurationTree::ConfigurationTree

(

const ConfigurationTree &

ConfigurationTree

)

[private]

copy constructor, protected and not defined to prevent from copying.

ConfigurationTree::~ConfigurationTree

(

)

[private, virtual]

destructor

Definition at line 17 of file OBTConfigurationTree.cpp.

{  
}

---

Member Function Documentation

const ConfigurationItem & OBT::ConfigurationTree::getRoot

(

)

const [inline]

accessor to the root of the configuration tree

Returns:

a const reference to the configuration tree root

Definition at line 75 of file OBTConfigurationTree.h.

References _parametersRoot.

        {
                return _parametersRoot ;
        }

void OBT::ConfigurationTree::addChild

(

const ConfigurationItem &

child

)

[inline]

add a child to the root

Parameters:

child

const reference to the child to add

Definition at line 84 of file OBTConfigurationTree.h.

References _parametersRoot, and OBT::ConfigurationItem::addChild().

        {
                _parametersRoot.addChild( child ) ;
        }

const ConfigurationTree& OBT::ConfigurationTree::operator=

(

const ConfigurationTree &

ConfigurationTree

)

[private]

assigment operator, protected and not defined to prevent from copying.

ConfigurationItem & OBT::ConfigurationTree::touchRoot

(

)

[inline, private]

allows AbstractConfigurationFileParser to access _parametersRoot

Returns:

a reference to _parametersRoot

Definition at line 93 of file OBTConfigurationTree.h.

References _parametersRoot.

        {
                return _parametersRoot ;
        }

---

Friends And Related Function Documentation

friend class Singleton< ConfigurationTree > [friend]

Definition at line 22 of file OBTConfigurationTree.h.

friend class AbstractConfigurationFileParser [friend]

Definition at line 23 of file OBTConfigurationTree.h.

---

Member Data Documentation

ConfigurationItem OBT::ConfigurationTree::_parametersRoot [private]

root of the configuration items

Definition at line 66 of file OBTConfigurationTree.h.

Referenced by addChild(), getRoot(), and touchRoot().

---