cfg::ConfigEditor Class Reference

A class to modify an existing configuration and publish changes. More...

#include <ConfigEditor.h>

Inheritance diagram for cfg::ConfigEditor:

List of all members.

Public Member Functions
	ConfigEditor (Config *config)
	A class to modify an existing configuration and publish changes.
virtual	~ConfigEditor ()
virtual int	EditConfig (Config &cfg)
void	Apply ()
void	Edit ()
void	Reset ()
void	Cancel ()
Private Attributes
bool	fNewConfig
	Have we created a config. during the edit?
Config *	fConfig
	The configuration to be edited.
Config *	fConfigCopy
	A copy of the original configuration.

---

Detailed Description

A class to modify an existing configuration and publish changes.

Clients who wish to edit configurations should follow this pattern:

[1] Derive from this class and implement the EditConfig method [2] Conduct the edit like this:

        {
          cfg::Config* cfg = ...;
          MyCfgConfigEditor ed(cfg); // Construct your editor
          ed.Edit();                 // Do the edit
        }
      

Definition at line 27 of file ConfigEditor.h.

---

Constructor & Destructor Documentation

cfg::ConfigEditor::ConfigEditor (  Config *  config  )

A class to modify an existing configuration and publish changes. Definition at line 17 of file ConfigEditor.cxx. : fNewConfig ( false ), fConfig ( config ), fConfigCopy( 0 ) { }

cfg::ConfigEditor::~ConfigEditor (   )  [virtual]

Definition at line 25 of file ConfigEditor.cxx. References fConfigCopy. { //====================================================================== // Free memory used during edit //====================================================================== if (fConfigCopy) { delete fConfigCopy; fConfigCopy = 0; } }

---

Member Function Documentation

void cfg::ConfigEditor::Apply (   )

Reimplemented in evdb::CfgEdit. Definition at line 72 of file ConfigEditor.cxx. References cfg::Table::AdoptConfig(), fConfig, fNewConfig, cfg::Config::GetName(), cfg::Table::GetObservers(), cfg::Config::GetVersion(), cfg::Table::Instance(), and cfg::Table::ObsList. Referenced by Edit(). { //====================================================================== // Apply the changes made to the configuration. //====================================================================== cfg::Table& t = cfg::Table::Instance(); // Insert the configuration into the table of configurations if (fNewConfig) t.AdoptConfig(fConfig); // Alert observers of this configuration to the change it its // state cfg::Table::ObsList olist; t.GetObservers(fConfig->GetName(), fConfig->GetVersion(), olist); cfg::Table::ObsList::iterator itr(olist.begin()); cfg::Table::ObsList::iterator itrEnd(olist.end()); for (; itr!=itrEnd; ++itr) try {(*itr)->Update(*fConfig); } catch (cfg::Exception e) { std::cout << " *-> " << fConfig->GetName() << "." << fConfig->GetVersion() << " "; e.Print(); exit(-1); } }

void cfg::ConfigEditor::Cancel (   )

Reimplemented in evdb::CfgEdit. Definition at line 113 of file ConfigEditor.cxx. References cfg::Config::Copy(), fConfig, fConfigCopy, fNewConfig, cfg::Config::GetSource(), and cfg::Config::GetVersion(). Referenced by Edit(). { //====================================================================== // Cancel the edit operation //====================================================================== cfg::Config::Copy(*fConfig, *fConfigCopy, fConfigCopy->GetVersion(), fConfigCopy->GetSource()); if (fNewConfig) { delete fConfig; fConfig = 0; } }

void cfg::ConfigEditor::Edit (   )

Definition at line 35 of file ConfigEditor.cxx. References Apply(), Cancel(), cfg::Config::Copy(), EditConfig(), cfg::Config::EditOK(), fConfig, fConfigCopy, cfg::Config::GetName(), cfg::Config::GetSource(), and cfg::Config::GetVersion(). Referenced by evdb::CfgEdit::Apply(), and main(). { //====================================================================== // Actually do the edit //====================================================================== // Test if the edit of the configuration is OK if (fConfig->EditOK()==false) return; // Make a copy of the configuration prior to any changes fConfigCopy = new cfg::Config(fConfig->GetName(),"dummy","dummy"); cfg::Config::Copy(*fConfigCopy, *fConfig, fConfig->GetVersion(), fConfig->GetSource()); // Make the edit int apply = this->EditConfig(*fConfig); // Apply any changes if (apply==0) this->Cancel(); else this->Apply(); }

int cfg::ConfigEditor::EditConfig (  Config &  cfg  )  [virtual]

The user edit function. Modify cfg at by some means. Return 1 to apply changes made to cfg, 0 to discard them Reimplemented in TestEditor, and evdb::CfgEdit. Definition at line 61 of file ConfigEditor.cxx. Referenced by Edit(). { //====================================================================== // User edit routine. Modify the configuration cfg. //====================================================================== return 0; // Do not apply edits // return 1; // Apply edits }

void cfg::ConfigEditor::Reset (   )

Definition at line 100 of file ConfigEditor.cxx. References cfg::Config::Copy(), fConfig, fConfigCopy, cfg::Config::GetSource(), and cfg::Config::GetVersion(). { //====================================================================== // Set the state of the configuration back to what it was prior to edit //====================================================================== cfg::Config::Copy(*fConfig, *fConfigCopy, fConfigCopy->GetVersion(), fConfigCopy->GetSource()); }

---

Member Data Documentation

Config* cfg::ConfigEditor::fConfig [private]

The configuration to be edited. Definition at line 43 of file ConfigEditor.h. Referenced by Apply(), Cancel(), Edit(), and Reset().

Config* cfg::ConfigEditor::fConfigCopy [private]

A copy of the original configuration. Definition at line 44 of file ConfigEditor.h. Referenced by Cancel(), Edit(), Reset(), and ~ConfigEditor().

bool cfg::ConfigEditor::fNewConfig [private]

Have we created a config. during the edit? Definition at line 42 of file ConfigEditor.h. Referenced by Apply(), and Cancel().

---

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

• ConfigEditor.h
• ConfigEditor.cxx

---