ConfigFile Class Reference

#include <ConfigFile.hh>

List of all members.

Detailed Description

Class to load and manage configuration files.

Loads and manages a root section and subsections from a given filename.

See also:: ConfigSection

Examples:: example-configfile.cc, and example-configfile.out.

Public Member Functions

ConfigFile (const std::string &filename)

Constructor.

~ConfigFile ()

Deconstructor also deletes m_rootSection.

void printConfiguration ()

Prints the configuration from the rootSection down.

ConfigSection * findSection (std::string sectionName)

Finds a section from ROOT section.

ConfigSection * getRootSection ()

Returns ROOT section.

Constructor & Destructor Documentation

ConfigFile::ConfigFile ( const std::string & filename )

Constructor.
Creates a ConfigFile class. Also loads, parses, and resolves variable substitution.

Parameters:

filename Filename of config file to load

Exceptions:

UnableToReadError On failing FileSystem::isReadAbleFile

UnableToOpenError On failing ifstream::is_open

ConfigFile::~ConfigFile ( )

Deconstructor also deletes m_rootSection.

Member Function Documentation

ConfigSection * ConfigFile::findSection ( std::string sectionName )

Finds a section from ROOT section.

Examples:
example-configfile.cc.

ConfigSection * ConfigFile::getRootSection ( )

Returns ROOT section.

Examples:
example-configfile.cc.

void ConfigFile::printConfiguration ( )

Prints the configuration from the rootSection down.

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