CfgConfigurable Class Reference

#include <CfgConfigurable.h>

Inheritance diagram for CfgConfigurable:

List of all members.

Public Member Functions
	CfgConfigurable ()
virtual	~CfgConfigurable ()
virtual void	Config ()=0
virtual const Registry &	DefaultConfig () const
Registry &	GetConfig ()
const Registry &	GetConfig () const
int	Update ()
void	Set (CfgDialog *d=0)
void	Set (const char *s)
Protected Member Functions
virtual void	CommitDefaultConfig (const Registry &r)
Private Attributes
Registry	fDefConfig
Registry	fConfig

---

Constructor & Destructor Documentation

CfgConfigurable::CfgConfigurable (   )

Definition at line 16 of file CfgConfigurable.cxx. : fConfig(false) { }

CfgConfigurable::~CfgConfigurable (   )  [virtual]

Definition at line 20 of file CfgConfigurable.cxx. { }

---

Member Function Documentation

void CfgConfigurable::CommitDefaultConfig (  const Registry &  r  )  [protected, virtual]

====================================================================== Subclass must call this before the Configurable can have meaningful entries ====================================================================== Definition at line 24 of file CfgConfigurable.cxx. References fDefConfig. Referenced by Conf::Conf(), GfxDigitListCfg::GfxDigitListCfg(), GfxMCVecListCfg::GfxMCVecListCfg(), GfxShowerListCfg::GfxShowerListCfg(), GfxStripListCfg::GfxStripListCfg(), and GfxTrackListCfg::GfxTrackListCfg(). { fDefConfig = r; }

virtual void CfgConfigurable::Config (   )  [pure virtual]

Implemented in BfldLoanPool, Conf, DbiTableProxyRegistry, GfxCfg, GfxCfg, PlexLoanPool, and UgliLoanPool. Referenced by Update().

const Registry & CfgConfigurable::DefaultConfig (  void   )  const [virtual]

====================================================================== Eventually this might go in the database and load the configuration. This would take a name or something. ====================================================================== Reimplemented in BfldLoanPool, PlexLoanPool, and UgliLoanPool. Definition at line 35 of file CfgConfigurable.cxx. { return fDefConfig; }

const Registry & CfgConfigurable::GetConfig (   )  const

====================================================================== Returns the configuration Registry. This const version denies the user any freedom to modify it, but does mean that a configurable object can use it in a const method. ====================================================================== Definition at line 53 of file CfgConfigurable.cxx. { return fConfig; }

Registry & CfgConfigurable::GetConfig (   )

====================================================================== Returns the configuration Registry, this is non-const as the user is user is free to modify ====================================================================== Definition at line 44 of file CfgConfigurable.cxx. Referenced by apply_reg_gui(), UgliGeometry::BuildNodes(), GeoMediumMap::BuildSwimMethodMap(), UgliLoanPool::Config(), Conf::Config(), PlexLoanPool::Config(), DbiTableProxyRegistry::Config(), BfldLoanPool::Config(), RerootToTruthModule::Get(), UgliLoanPool::GetAlwaysUseDbi(), UgliLoanPool::GetMedium(), UgliLoanPool::GetMediumRegistry(), GfxStripListCfg::GetScaleIs(), GfxDigitListCfg::GetScaleIs(), GfxStripListCfg::GetShapeIs(), GfxDigitListCfg::GetShapeIs(), UgliLoanPool::GetShieldOff(), GfxStripListCfg::GetSizeBy(), GfxDigitListCfg::GetSizeBy(), GfxStripListCfg::GetSizeFactor(), GfxDigitListCfg::GetSizeFactor(), GfxStripListCfg::GetSizeIs(), GfxDigitListCfg::GetSizeIs(), GfxStripListCfg::GetStripEnd(), GfxDigitListCfg::GetStripEnd(), UgliLoanPool::GetSwimMethodHighField(), UgliLoanPool::GetSwimMethodLowField(), UgliLoanPool::GetUseNewCavern(), GfxDigitListCfg::GfxDigitListCfg(), GfxStripListCfg::GfxStripListCfg(), UgliLoanPool::Instance(), BfldLoanPool::Instance(), Plexus::Plexus(), UgliLoanPool::Print(), PlexLoanPool::Print(), BfldLoanPool::Print(), UgliLoanPool::PurgeDbiTableCache(), PlexLoanPool::PurgeDbiTableCache(), UgliLoanPool::ReadFromFile(), PlexLoanPool::ReadFromFile(), Set(), UgliLoanPool::SetCut(), UgliLoanPool::SetMedium(), UgliLoanPool::SetProcess(), UgliLoanPool::SetTracking(), testConf(), DbiTableProxyRegistry::~DbiTableProxyRegistry(), PlexLoanPool::~PlexLoanPool(), and UgliLoanPool::~UgliLoanPool(). { return fConfig; }

void CfgConfigurable::Set (  const char *  s  )

====================================================================== Update the configuration given a text string s. Format: "key1=true, key2=10, key3=11.1, key4='A string'" ====================================================================== Definition at line 109 of file CfgConfigurable.cxx. References GetConfig(), Registry::LockValues(), Registry::Merge(), s(), Cfg::StringToRegistry(), and Registry::UnLockValues(). { Registry r; Cfg::StringToRegistry(r,s); this->GetConfig().UnLockValues(); this->GetConfig().Merge(r); this->GetConfig().LockValues(); }

void CfgConfigurable::Set (  CfgDialog *  d = 0  )

Definition at line 80 of file CfgConfigurable.cxx. References GetConfig(), Registry::LockValues(), Registry::Merge(), CfgDialog::Query(), CfgDialog::SetCurrent(), CfgDialog::SetDefault(), and Registry::UnLockValues(). Referenced by far_cosmic_mc_configure(), far_mc_configure(), RerootToTruthModule::Get(), near_mc_configure(), set_sm2_bfield(), UgliLoanPool::SetAlwaysUseDbi(), UgliLoanPool::SetConfigFromEnvironment(), PlexLoanPool::SetConfigFromEnvironment(), DbiTableProxyRegistry::SetConfigFromEnvironment(), BfldLoanPool::SetConfigFromEnvironment(), UgliLoanPool::SetShieldOff(), UgliLoanPool::SetSwimMethodHighField(), UgliLoanPool::SetSwimMethodLowField(), UgliLoanPool::SetUseGeo(), and UgliLoanPool::SetUseNewCavern(). { //====================================================================== // Update the configuration parameters. Allow a CfgDialog object to be // passed in. If none is passed in use the default, text based dialog // object. //====================================================================== bool deleteDialog = false; if (d==0) { d = new CfgDialog(); deleteDialog = true; } // Set up d with the default configuration parameters d->SetDefault(this->DefaultConfig()); d->SetCurrent(this->GetConfig()); // Do the querry Registry r = d->Query(); this->GetConfig().UnLockValues(); this->GetConfig().Merge(r); this->GetConfig().LockValues(); // Clean up the dialog if (deleteDialog) { delete d; d = 0; } }

int CfgConfigurable::Update (   )

====================================================================== Update the class's state given the current configuration. If there is nothing to do just return w/o taking any action. Return's 0 if no action was taken, >0 if the object was reconfigured. ====================================================================== Definition at line 65 of file CfgConfigurable.cxx. References Config(), fConfig, Registry::IsDirty(), and Registry::SetDirty(). Referenced by apply_reg_gui(), far_cosmic_mc_configure(), far_mc_configure(), RerootToTruthModule::Get(), UgliLoanPool::Instance(), BfldLoanPool::Instance(), near_mc_configure(), set_sm2_bfield(), DbiTableProxyRegistry::SetConfigFromEnvironment(), and testConf(). { if (! fConfig.IsDirty()) return 0; // Nothing to do if config is current this->Config(); // Send the "reconfig" message fConfig.SetDirty(false); // Mark the config. as current return 1; }

---

Member Data Documentation

Registry CfgConfigurable::fConfig [private]

Definition at line 81 of file CfgConfigurable.h. Referenced by Update().

Registry CfgConfigurable::fDefConfig [private]

Definition at line 81 of file CfgConfigurable.h. Referenced by CommitDefaultConfig().

---

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

• CfgConfigurable.h
• CfgConfigurable.cxx

---