ariba::utility::ConfigFile Class Reference

#include <source/ariba/utility/configuration/ConfigFile.h>

Collaboration diagram for ariba::utility::ConfigFile:
Collaboration graph
[legend]

List of all members.

Classes

struct  file_not_found
struct  key_not_found

Public Member Functions

 ConfigFile (string filename, string delimiter="=", string comment="#", string sentry="EndConfigFile")
 ConfigFile ()
template<class T >
read (const string &key) const
template<class T >
read (const string &key, const T &value) const
template<class T >
bool readInto (T &var, const string &key) const
template<class T >
bool readInto (T &var, const string &key, const T &value) const
template<class T >
void add (string key, const T &value)
void remove (const string &key)
bool keyExists (const string &key) const
string getDelimiter () const
string getComment () const
string getSentry () const
string setDelimiter (const string &s)
string setComment (const string &s)

Protected Types

typedef std::map< string,
string >::iterator 
mapi
typedef std::map< string,
string >::const_iterator 
mapci

Static Protected Member Functions

template<class T >
static string T_as_string (const T &t)
template<class T >
static T string_as_T (const string &s)
static void trim (string &s)

Protected Attributes

string myDelimiter
string myComment
string mySentry
std::map< string, string > myContents

Friends

std::ostream & operator<< (std::ostream &os, const ConfigFile &cf)
std::istream & operator>> (std::istream &is, ConfigFile &cf)

Detailed Description

Definition at line 60 of file ConfigFile.h.


Member Typedef Documentation

typedef std::map<string,string>::const_iterator ariba::utility::ConfigFile::mapci [protected]

Definition at line 69 of file ConfigFile.h.

typedef std::map<string,string>::iterator ariba::utility::ConfigFile::mapi [protected]

Definition at line 68 of file ConfigFile.h.


Constructor & Destructor Documentation

ariba::utility::ConfigFile::ConfigFile ( string  filename,
string  delimiter = "=",
string  comment = "#",
string  sentry = "EndConfigFile" 
)

Definition at line 35 of file ConfigFile.cpp.

ariba::utility::ConfigFile::ConfigFile (  ) 

Definition at line 49 of file ConfigFile.cpp.


Member Function Documentation

template<class T >
void ariba::utility::ConfigFile::add ( string  key,
const T &  value 
) [inline]

Definition at line 230 of file ConfigFile.h.

References myContents, T_as_string(), and trim().

string ariba::utility::ConfigFile::getComment (  )  const [inline]

Definition at line 95 of file ConfigFile.h.

References myComment.

string ariba::utility::ConfigFile::getDelimiter (  )  const [inline]

Definition at line 94 of file ConfigFile.h.

References myDelimiter.

string ariba::utility::ConfigFile::getSentry (  )  const [inline]

Definition at line 96 of file ConfigFile.h.

References mySentry.

bool ariba::utility::ConfigFile::keyExists ( const string &  key  )  const

Definition at line 64 of file ConfigFile.cpp.

References myContents.

Referenced by ariba::utility::Configuration::exists().

template<class T >
T ariba::utility::ConfigFile::read ( const string &  key,
const T &  value 
) const [inline]

Definition at line 190 of file ConfigFile.h.

References myContents.

template<class T >
T ariba::utility::ConfigFile::read ( const string &  key  )  const [inline]

Definition at line 180 of file ConfigFile.h.

References myContents.

Referenced by ariba::utility::Configuration::read().

template<class T >
bool ariba::utility::ConfigFile::readInto ( T &  var,
const string &  key,
const T &  value 
) const [inline]

Definition at line 214 of file ConfigFile.h.

References myContents.

template<class T >
bool ariba::utility::ConfigFile::readInto ( T &  var,
const string &  key 
) const [inline]

Definition at line 201 of file ConfigFile.h.

References myContents.

void ariba::utility::ConfigFile::remove ( const string &  key  ) 

Definition at line 56 of file ConfigFile.cpp.

References myContents.

string ariba::utility::ConfigFile::setComment ( const string &  s  )  [inline]

Definition at line 99 of file ConfigFile.h.

References myComment.

string ariba::utility::ConfigFile::setDelimiter ( const string &  s  )  [inline]

Definition at line 97 of file ConfigFile.h.

References myDelimiter.

bool ariba::utility::ConfigFile::string_as_T< bool > ( const string &  s  )  [inline, static, protected]

Definition at line 139 of file ConfigFile.h.

template<class T >
string ariba::utility::ConfigFile::T_as_string ( const T &  t  )  [inline, static, protected]

Definition at line 127 of file ConfigFile.h.

Referenced by add().

void ariba::utility::ConfigFile::trim ( string &  s  )  [static, protected]

Definition at line 73 of file ConfigFile.cpp.

Referenced by add(), and ariba::utility::operator>>().


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const ConfigFile cf 
) [friend]
std::istream& operator>> ( std::istream &  is,
ConfigFile cf 
) [friend]

Member Data Documentation

Definition at line 64 of file ConfigFile.h.

Referenced by getComment(), ariba::utility::operator>>(), and setComment().

std::map<string,string> ariba::utility::ConfigFile::myContents [protected]

Definition at line 65 of file ConfigFile.h.

Referenced by getSentry(), and ariba::utility::operator>>().


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

Generated on Fri Dec 10 11:09:25 2010 for Ariba by  doxygen 1.6.1