CfgConfig Class Reference

#include <CfgConfig.h>

List of all members.

Public Types
typedef std::map< std::string, CfgParam * >	CfgParamMap
Public Member Functions
const char *	GetName () const
const char *	GetVersion () const
const char *	GetSource () const
const CfgParam &	operator() (const char *pname) const
const CfgParam &	operator() (const std::string &pname) const
bool	IsEditable () const
	CfgConfig (const char *name, const char *version, const char *source)
	~CfgConfig ()
void	AdoptParam (CfgParam *p)
void	RemoveParam (const char *which="*")
CfgParam &	Param (const char *pname)
CfgParam &	Param (const std::string &pname)
bool	EditOK () const
void	SetReadOnly (int flag=1)
void	SetSource (const char *filename)
CfgParamMap &	ParamMap ()
Static Public Member Functions
static void	SetEditAllOK ()
static void	Copy (CfgConfig &dest, const CfgConfig &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.).
CfgParamMap	fParam
	Collection of parameters.

---

Detailed Description

Definition at line 26 of file CfgConfig.h.

---

Member Typedef Documentation

typedef std::map<std::string, CfgParam*> CfgConfig::CfgParamMap

Definition at line 60 of file CfgConfig.h.

---

Constructor & Destructor Documentation

CfgConfig::CfgConfig	(	const char *	name,
		const char *	version,
		const char *	source
	)

Definition at line 25 of file CfgConfig.cxx.

                                 : 
  fEditable( true    ),
  fName    ( name    ),
  fVersion ( version ),
  fSource  ( source  )
{ }

CfgConfig::~CfgConfig

(

)

Definition at line 36 of file CfgConfig.cxx.

References fEditable, and RemoveParam().

{ fEditable = true; this->RemoveParam("*"); }

---

Member Function Documentation

void CfgConfig::AdoptParam

(

CfgParam *

p

)

Definition at line 196 of file CfgConfig.cxx.

References EditOK(), fParam, p, and s.

Referenced by CfgXMLconfigBuilder::Build(), TestBuilder::BuildCfg1(), TestBuilder::BuildCfg2(), Copy(), EVDCfgEdit::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
  CfgParam* param = fParam[s];
  if (param==0) delete param;
  
  fParam[s] = p;
}

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

Definition at line 243 of file CfgConfig.cxx.

References AdoptParam(), EditOK(), fName, fParam, fSource, fVersion, p, and RemoveParam().

Referenced by CfgXMLconfigBuilder::Build(), CfgConfigEditor::Cancel(), CfgConfigEditor::Edit(), and CfgConfigEditor::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 CfgParam
  // copy constructor on each element in the source map
  dest.RemoveParam("*");
  CfgParamMap::const_iterator    itr(src.fParam.begin());
  CfgParamMap::const_iterator itrEnd(src.fParam.end());
  for (; itr!=itrEnd; ++itr) {
    CfgParam* p = new CfgParam(*itr->second);
    dest.AdoptParam(p);
  }
}

bool CfgConfig::EditOK

(

)

const

Definition at line 136 of file CfgConfig.cxx.

References fEditable, GetVersion(), gsAllEditOK, CfgException::kConfigRO, and os.

Referenced by AdoptParam(), Copy(), CfgConfigEditor::Edit(), Param(), 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 CfgException(CfgException::kConfigRO,
               os.str().c_str(),
               __FILE__,
               __LINE__);
  }
  return fEditable;
}

const char * CfgConfig::GetName

(

)

const

Definition at line 40 of file CfgConfig.cxx.

References fName.

Referenced by CfgTable::AdoptConfig(), CfgConfigEditor::Edit(), EVDCfgEdit::EVDCfgEdit(), main(), CfgConfigBuilder::Publish(), TPCBadChannel::Update(), TestObs::Update(), TestObserver::Update(), RunConfig::Update(), and RICHChan::Update().

{ return fName.c_str(); }

const char * CfgConfig::GetSource

(

)

const

Definition at line 48 of file CfgConfig.cxx.

References fSource.

Referenced by CfgConfigEditor::Cancel(), CfgConfigEditor::Edit(), EVDCfgEdit::EVDCfgEdit(), main(), CfgConfigEditor::Reset(), TPCBadChannel::Update(), RICHExample::Update(), and RICHChan::Update().

{ return fSource.c_str(); }

const char * CfgConfig::GetVersion

(

)

const

Definition at line 44 of file CfgConfig.cxx.

References fVersion.

Referenced by CfgTable::AdoptConfig(), CfgConfigEditor::Cancel(), CfgConfigEditor::Edit(), EditOK(), EVDCfgEdit::EVDCfgEdit(), main(), CfgConfigBuilder::Publish(), CfgConfigEditor::Reset(), TPCBadChannel::Update(), TestObs::Update(), TestObserver::Update(), and RICHChan::Update().

{ return fVersion.c_str(); }

bool CfgConfig::IsEditable

(

)

const

Definition at line 52 of file CfgConfig.cxx.

References fEditable.

{ return fEditable; }

const CfgParam & CfgConfig::operator()

(

const std::string &

pname

)

const

Definition at line 73 of file CfgConfig.cxx.

References fName, fParam, fVersion, CfgException::kParamNotFound, and os.

{
//======================================================================
// Allows read-only access to parameters
//======================================================================
  CfgParamMap::iterator itr = fParam.find(pname);
  if (itr==fParam.end()) {
    std::ostringstream os;
    os << "Parameter " << pname    << " not found in configuration " 
       << fName << ":" << fVersion << std::endl;
    throw CfgException(CfgException::kParamNotFound,
               os.str().c_str(),
               __FILE__,
               __LINE__);
  }
  return (*itr->second);
}

const CfgParam & CfgConfig::operator()

(

const char *

pname

)

const

Definition at line 56 of file CfgConfig.cxx.

References fParam, and CfgException::kParamNotFound.

{
//======================================================================
// Allows read-only access to parameters
//======================================================================
  CfgParamMap::iterator itr = fParam.find(pname);
  if (itr==fParam.end()) {
    throw CfgException(CfgException::kParamNotFound,
               pname, 
               __FILE__,
               __LINE__);
  }
  return (*itr->second);
}

CfgParam & CfgConfig::Param

(

const std::string &

pname

)

Definition at line 115 of file CfgConfig.cxx.

References EditOK(), fName, fParam, fVersion, CfgException::kParamNotFound, and os.

{
//======================================================================
// Allows non-const access to parameters
//======================================================================
  this->EditOK();
  CfgParamMap::iterator itr = fParam.find(pname);
  if (itr==fParam.end()) {
    std::ostringstream os;
    os << "Parameter " << pname    << " not found in configuration " 
       << fName << ":" << fVersion << std::endl;
    throw CfgException(CfgException::kParamNotFound,
               os.str().c_str(),
               __FILE__,
               __LINE__);
  }
  return (*itr->second);
}

CfgParam & CfgConfig::Param

(

const char *

pname

)

Definition at line 93 of file CfgConfig.cxx.

References EditOK(), fName, fParam, fVersion, CfgException::kParamNotFound, os, and p.

Referenced by CfgXMLconfigBuilder::Build(), and TestEditor::EditConfig().

{
//======================================================================
// Allows non-const access to parameters
//======================================================================
  this->EditOK();
  std::string p(pname);
  CfgParamMap::iterator itr = fParam.find(p);
  if (itr==fParam.end()) {
    std::ostringstream os;
    os << "Parameter " << pname    << " not found in configuration " 
       << fName << ":" << fVersion << std::endl;
    throw CfgException(CfgException::kParamNotFound,
               os.str().c_str(),
               __FILE__,
               __LINE__);
  }
  return (*itr->second);
}

CfgParamMap& CfgConfig::ParamMap

(

)

[inline]

Definition at line 61 of file CfgConfig.h.

References fParam.

{ return fParam; }

void CfgConfig::RemoveParam

(

const char *

which = "*"

)

Definition at line 217 of file CfgConfig.cxx.

References EditOK(), fParam, and s.

Referenced by Copy(), and ~CfgConfig().

{
//======================================================================
// Remove a selected parameter from the configuration. "*" removes all
// parameters
//======================================================================
  this->EditOK();

  std::string s(which);
  // If which is "*" remove all parameters
  if (s=="*") {
    CfgParamMap::iterator    itr(fParam.begin());
    CfgParamMap::iterator itrEnd(fParam.end());
    for (; itr!=itrEnd; ++itr) {
      if (itr->second) { delete itr->second; itr->second = 0; }
    }
    return;
  }
  
  // Otherwise just remove the named set
  CfgParam* param = fParam[s];
  if (param==0) { delete param; fParam[s] = 0; }
}

void CfgConfig::SetEditAllOK

(

)

[static]

Definition at line 21 of file CfgConfig.cxx.

References gsAllEditOK.

Referenced by EVDJobMenu::OpenJobXML().

{ gsAllEditOK = true; }

void CfgConfig::SetReadOnly

(

int

flag = 1

)

Definition at line 157 of file CfgConfig.cxx.

References EditOK(), fEditable, gsNoDefaultEdits, and gsNoEdits.

Referenced by CfgXMLconfigBuilder::Build(), and CfgConfigBuilder::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 CfgConfig::SetSource

(

const char *

filename

)

Definition at line 192 of file CfgConfig.cxx.

References fSource.

{ fSource = filename; }

---

Member Data Documentation

bool CfgConfig::fEditable [private]

Allow edits to this config?

Definition at line 64 of file CfgConfig.h.

Referenced by EditOK(), IsEditable(), SetReadOnly(), and ~CfgConfig().

std::string CfgConfig::fName [private]

Name of configuration.

Definition at line 65 of file CfgConfig.h.

Referenced by Copy(), GetName(), operator()(), and Param().

CfgParamMap CfgConfig::fParam [mutable, private]

Collection of parameters.

Definition at line 68 of file CfgConfig.h.

Referenced by AdoptParam(), Copy(), operator()(), Param(), ParamMap(), and RemoveParam().

std::string CfgConfig::fSource [private]

Source of config. data (file name eg.).

Definition at line 67 of file CfgConfig.h.

Referenced by Copy(), GetSource(), and SetSource().

std::string CfgConfig::fVersion [private]

Version tag of configuration.

Definition at line 66 of file CfgConfig.h.

Referenced by Copy(), GetVersion(), operator()(), and Param().

---

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

• CfgConfig.h
• CfgConfig.cxx

---