cfg::Config Class Reference

A collection of configuration parameters. More...

#include <Config.h>

List of all members.

Public Types
typedef std::map< std::string, Param * >	ParamMap
Public Member Functions
const char *	GetName () const
const char *	GetVersion () const
const char *	GetSource () const
const Param &	operator() (const char *pname) const
const Param &	operator() (const std::string &pname) const
bool	IsEditable () const
std::string	AsXML () const
	Config (const char *name, const char *version, const char *source)
	~Config ()
void	AdoptParam (Param *p)
void	RemoveParam (const char *which="*")
Param &	Par (const char *pname)
Param &	Par (const std::string &pname)
bool	EditOK () const
void	SetReadOnly (int flag=1)
void	SetSource (const char *filename)
ParamMap &	ParMap ()
Static Public Member Functions
void	SetEditAllOK ()
void	Copy (Config &dest, const Config &src, const char *destVersion=0, const char *destSource=0)
Private Attributes
bool	fEditable
	Allow edits to this config?
std::string	fName
	Name of configuration.
std::string	fVersion
	Version tag of configuration.
std::string	fSource
	Source of config. data (file name eg.).
ParamMap	fParam
	Collection of parameters.

---

Detailed Description

A collection of configuration parameters.

Configurations are known by their name and version. The source where the data used to fill them comes from (eg. XML file name, database possibly) is recorded.

In general, configurations are created and seldom modified. Modification of configurations is something of a tricky business as clients of the configuration require notification of the changes but probably don't want then piecemeal (parameter-by-parameter). For that reason the routines which allow modification of the configuration data are defines as protected and access to them is only allowed via the cfg::ConfigEditor class.

Definition at line 28 of file Config.h.

---

Member Typedef Documentation

typedef std::map<std::string, Param*> cfg::Config::ParamMap

Definition at line 63 of file Config.h.

---

Constructor & Destructor Documentation

cfg::Config::Config (  const char *  name, const char *  version, const char *  source )

These methods should *only* be used by cfg::ConfigBuilders and cfg::ConfigEditors. Todo: Find some way to enforce usage only by cfg::ConfigBuilders Definition at line 27 of file Config.cxx. : fEditable( true ), fName ( name ), fVersion ( version ), fSource ( source ) { }

cfg::Config::~Config (   )

Definition at line 38 of file Config.cxx. References fEditable, and RemoveParam(). { fEditable = true; this->RemoveParam("*"); }

---

Member Function Documentation

void cfg::Config::AdoptParam (  Param *  p  )

Definition at line 198 of file Config.cxx. References EditOK(), fParam, and cfg::Param::GetName(). Referenced by cfg::configBuilder::Build(), TestBuilder::BuildCfg1(), TestBuilder::BuildCfg2(), Copy(), evdb::CfgEdit::EditConfig(), and main(). { //====================================================================== // Insert the parameter p into a configuration. If the parameter // already exists in the configuration then replace it. Ownership of // the parameter stored at p is transferred to the configuration. //====================================================================== this->EditOK(); std::string s = p->GetName(); // Check the parameter set for one of this name. If one is found // replace it cfg::Param* param = fParam[s]; if (param==0) delete param; fParam[s] = p; }

std::string cfg::Config::AsXML (   )  const

Write the configuration as an XML formatted string Definition at line 291 of file Config.cxx. References fName, fParam, fVersion, cfg::Param::GetComment(), cfg::Param::GetName(), and cfg::Param::XMLTag(). Referenced by main(). { // I'm not too excited about the need for "setprecision(8)" below, // but without it you seem to either lose precision with doubles and // floats or to gain bogus digits. The number 8 is fairly fine tuned // which is why I'm not excited -- I'd rather have something more // robust. Such is life I suppose. std::ostringstream xml; xml << "<config name=\"" << this->fName << "\" version=\"" << this->fVersion << "\">\n"; ParamMap::const_iterator itr(fParam.begin()); ParamMap::const_iterator itrEnd(fParam.end()); for (; itr!=itrEnd; ++itr) { const cfg::Param* p = itr->second; xml << " <param name=\"" << p->GetName() << "\">\n" << " <" << p->XMLTag() << "> " << std::setprecision(8) << (*p) << " </" << p->XMLTag() << ">\n"; xml << " " << p->GetComment() << "\n"; xml << " </param>\n"; } xml << "</config>\n"; return xml.str(); }

void cfg::Config::Copy (  Config &  dest, const Config &  src, const char *  destVersion = 0, const char *  destSource = 0 )  [static]

Definition at line 245 of file Config.cxx. References AdoptParam(), EditOK(), fName, fParam, fSource, fVersion, and RemoveParam(). Referenced by cfg::configBuilder::Build(), cfg::ConfigEditor::Cancel(), cfg::ConfigEditor::Edit(), and cfg::ConfigEditor::Reset(). { //====================================================================== // Copy one configuration to another // dest - configuration to copy to // src - configuration to copy from // destVersion - version tag appied to dest (default appends '.copy') // destSource - source tag appied to dest (default appends '(copy)' ) //====================================================================== dest.EditOK(); dest.fName = src.fName; if (destVersion==0) { dest.fVersion = src.fVersion; dest.fVersion += ".copy"; } else { dest.fVersion = destVersion; } if (destSource==0) { dest.fSource = src.fSource; dest.fSource += "(copy)"; } else { dest.fSource = destSource; } // Wipe the parameter map clean and build a new one using the cfg::Param // copy constructor on each element in the source map dest.RemoveParam("*"); cfg::Config::ParamMap::const_iterator itr(src.fParam.begin()); cfg::Config::ParamMap::const_iterator itrEnd(src.fParam.end()); for (; itr!=itrEnd; ++itr) { cfg::Param* p = new cfg::Param(*itr->second); dest.AdoptParam(p); } }

bool cfg::Config::EditOK (   )  const

Definition at line 138 of file Config.cxx. References fEditable, and GetVersion(). Referenced by AdoptParam(), Copy(), cfg::ConfigEditor::Edit(), Par(), RemoveParam(), and SetReadOnly(). { //====================================================================== // Check if it is OK to edit this configuration. Throws exception is // edit is not allowed //====================================================================== if (gsAllEditOK) return true; if (fEditable==false) { std::ostringstream os; os << "Attempt to get read access to read-only config " << "." << this->GetVersion(); throw cfg::Exception(cfg::Exception::kConfigRO, os.str().c_str(), __FILE__, __LINE__); } return fEditable; }

const char * cfg::Config::GetName (   )  const

Definition at line 42 of file Config.cxx. References fName. Referenced by cfg::Table::AdoptConfig(), cfg::ConfigEditor::Apply(), evdb::CfgEdit::CfgEdit(), cfg::ConfigEditor::Edit(), cfg::Table::GetConfig(), main(), cfg::Table::Print(), cfg::ConfigBuilder::Publish(), TestObs::Update(), TestObserver::Update(), and evd::Display3D::Update(). { return fName.c_str(); }

const char * cfg::Config::GetSource (   )  const

Definition at line 50 of file Config.cxx. References fSource. Referenced by cfg::ConfigEditor::Cancel(), evdb::CfgEdit::CfgEdit(), cfg::ConfigEditor::Edit(), main(), and cfg::ConfigEditor::Reset(). { return fSource.c_str(); }

const char * cfg::Config::GetVersion (   )  const

Definition at line 46 of file Config.cxx. References fVersion. Referenced by cfg::Table::AdoptConfig(), cfg::ConfigEditor::Apply(), cfg::ConfigEditor::Cancel(), evdb::CfgEdit::CfgEdit(), cfg::ConfigEditor::Edit(), EditOK(), cfg::Table::GetConfig(), main(), cfg::Table::Print(), cfg::ConfigBuilder::Publish(), cfg::ConfigEditor::Reset(), TestObs::Update(), and TestObserver::Update(). { return fVersion.c_str(); }

bool cfg::Config::IsEditable (   )  const

Definition at line 54 of file Config.cxx. { return fEditable; }

const cfg::Param & cfg::Config::operator() (  const std::string &  pname  )  const

Definition at line 75 of file Config.cxx. References fName, fParam, and fVersion. { //====================================================================== // Allows read-only access to parameters //====================================================================== cfg::Config::ParamMap::iterator itr = fParam.find(pname); if (itr==fParam.end()) { std::ostringstream os; os << "Parameter " << pname << " not found in configuration " << fName << ":" << fVersion << std::endl; throw cfg::Exception(cfg::Exception::kParamNotFound, os.str().c_str(), __FILE__, __LINE__); } return (*itr->second); }

const cfg::Param & cfg::Config::operator() (  const char *  pname  )  const

Definition at line 58 of file Config.cxx. References fParam. { //====================================================================== // Allows read-only access to parameters //====================================================================== cfg::Config::ParamMap::iterator itr = fParam.find(pname); if (itr==fParam.end()) { throw cfg::Exception(cfg::Exception::kParamNotFound, pname, __FILE__, __LINE__); } return (*itr->second); }

cfg::Param & cfg::Config::Par (  const std::string &  pname  )

Definition at line 117 of file Config.cxx. References EditOK(), fName, fParam, and fVersion. { //====================================================================== // Allows non-const access to parameters //====================================================================== this->EditOK(); cfg::Config::ParamMap::iterator itr = fParam.find(pname); if (itr==fParam.end()) { std::ostringstream os; os << "Parameter " << pname << " not found in configuration " << fName << ":" << fVersion << std::endl; throw cfg::Exception(cfg::Exception::kParamNotFound, os.str().c_str(), __FILE__, __LINE__); } return (*itr->second); }

cfg::Param & cfg::Config::Par (  const char *  pname  )

Definition at line 95 of file Config.cxx. References EditOK(), fName, fParam, and fVersion. Referenced by cfg::configBuilder::Build(), and TestEditor::EditConfig(). { //====================================================================== // Allows non-const access to parameters //====================================================================== this->EditOK(); std::string p(pname); cfg::Config::ParamMap::iterator itr = fParam.find(p); if (itr==fParam.end()) { std::ostringstream os; os << "Parameter " << pname << " not found in configuration " << fName << ":" << fVersion << std::endl; throw cfg::Exception(cfg::Exception::kParamNotFound, os.str().c_str(), __FILE__, __LINE__); } return (*itr->second); }

ParamMap& cfg::Config::ParMap (   )  [inline]

Definition at line 64 of file Config.h. { return fParam; }

void cfg::Config::RemoveParam (  const char *  which = "*"  )

Definition at line 219 of file Config.cxx. References EditOK(), and fParam. Referenced by Copy(), and ~Config(). { //====================================================================== // Remove a selected parameter from the configuration. "*" removes all // parameters //====================================================================== this->EditOK(); std::string s(which); // If which is "*" remove all parameters if (s=="*") { cfg::Config::ParamMap::iterator itr(fParam.begin()); cfg::Config::ParamMap::iterator itrEnd(fParam.end()); for (; itr!=itrEnd; ++itr) { if (itr->second) { delete itr->second; itr->second = 0; } } return; } // Otherwise just remove the named set cfg::Param* param = fParam[s]; if (param==0) { delete param; fParam[s] = 0; } }

void cfg::Config::SetEditAllOK (   )  [static]

Definition at line 23 of file Config.cxx. References gsAllEditOK. Referenced by evdb::JobMenu::OpenJobXML(). { gsAllEditOK = true; }

void cfg::Config::SetReadOnly (  int  flag = 1  )

Definition at line 159 of file Config.cxx. References EditOK(), fEditable, fVersion, gsNoDefaultEdits, and gsNoEdits. Referenced by cfg::configBuilder::Build(), and cfg::ConfigBuilder::Publish(). { //====================================================================== // Set the read-only status for this configuration. // flag = 0 - allow read/write access // flag = 1 - read only access // flag = -1 - determine read/write accees based on R/W policies for // configurations //====================================================================== if (flag == 1 && fEditable == false) return; // RO already // First make sure we are allowed to change the state. Once set read // only the configuration is always read only this->EditOK(); if (flag == 0) { fEditable = true; return; } // RW if (flag == 1) { fEditable = false; return; } // RO // Apply policy to determine RW status // Edits turned off globally if (gsNoEdits == true) { fEditable = false; return; } // RO // Edits turned off globally for default configurations if ( (gsNoDefaultEdits == true) && (this->fVersion == "default") ) { fEditable = false; // RO return; } // Edit allowed fEditable = true; // RW }

void cfg::Config::SetSource (  const char *  filename  )

Definition at line 194 of file Config.cxx. References fSource. { fSource = filename; }

---

Member Data Documentation

bool cfg::Config::fEditable [private]

Allow edits to this config? Definition at line 67 of file Config.h. Referenced by EditOK(), SetReadOnly(), and ~Config().

std::string cfg::Config::fName [private]

Name of configuration. Definition at line 68 of file Config.h. Referenced by AsXML(), Copy(), GetName(), operator()(), and Par().

ParamMap cfg::Config::fParam [mutable, private]

Collection of parameters. Definition at line 71 of file Config.h. Referenced by AdoptParam(), AsXML(), Copy(), operator()(), Par(), and RemoveParam().

std::string cfg::Config::fSource [private]

Source of config. data (file name eg.). Definition at line 70 of file Config.h. Referenced by Copy(), GetSource(), and SetSource().

std::string cfg::Config::fVersion [private]

Version tag of configuration. Definition at line 69 of file Config.h. Referenced by AsXML(), Copy(), GetVersion(), operator()(), Par(), and SetReadOnly().

---

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

• Config.h
• Config.cxx

---