TDbiCfgPromptConfigurable Class Reference

A nice base class to use with configurable objects. More...

#include <TDbiCfgPromptConfigurable.hxx>

Collaboration diagram for TDbiCfgPromptConfigurable:

[legend]

List of all members.

Public Member Functions
	TDbiCfgPromptConfigurable ()
	TDbiCfgPromptConfigurable (const TDbiRegistry &r)
virtual	~TDbiCfgPromptConfigurable ()
const TDbiRegistry &	GetConfig () const
void	UnLockKeys ()
void	LockKeys ()
void	UnLockValues ()
void	LockValues ()
void	Set (const char *key, char val)
void	Set (const char *key, const char *val)
void	Set (const char *key, double val)
void	Set (const char *key, int val)
void	Set (const char *key, const TDbiRegistry &val)
void	Set (const char *setstring)
void	Set (TDbiCfgDialog *d=0)
void	Set (const TDbiRegistry &stuff, Bool_t recursive=false)
Static Public Member Functions
static Bool_t	Split (const char *line, char sep, std::string &a, std::string &b)
static Bool_t	Split (const std::string &line, char sep, std::string &a, std::string &b)
static Bool_t	IsInt (const std::string &s, Int_t &val)
static Bool_t	IsFloat (const std::string &s, Double_t &val)
static Bool_t	SafeMerge (TDbiRegistry &modify, const TDbiRegistry &stuff, Bool_t recursive=false)
Protected Member Functions
void	InitializeConfig (const TDbiRegistry &initConfig)
virtual void	ConfigModified (void)=0
Private Member Functions
	ClassDef (TDbiCfgPromptConfigurable, 1)
Private Attributes
TDbiRegistry	fConfig
TDbiRegistry	fDefaultConfig

---

Detailed Description

A nice base class to use with configurable objects.

Like the TDbiCfg(Lazy)Configurable class, but doesn't use lazy execution.

How to use it: Set up defaults in the constructor (or somehwere else that happens soon) and call InitializeConfig() with them.

At any time, use the Set() commands to modify your object. By default, your object has keys locked and values unlocked: This means that:

• If you try to set a key that doesn't exist, it fails. (Typo protection)
• If you try to set a key to different type, it fails. (Type protection)

Note that the Set() commands include: Set( key, int ) | Set( key, double ) |- Work like TDbiRegistry() commands, but with above safeties Set( key, const char* ) | Set( key, TDbiRegistry ) | Set( TDbiRegistry ) - Works like Merge(), but with above safeties Set( TDbiRegistry, true) - Ditto, but Merge()s sub-registries as well, with the same rules. Set( string ) - Works like JobControl parser i.e. Set("myint=1 myfloat=2.0 mystring=blahDeblah");

If the configuration changes, ConfigModified() will be called, letting you read the new configuration variables. But it's smart: your function only gets called if a variable has changed, not if they've stayed the same.

Example:

   class MyClass : public TDbiCfgPromptConfigurable 
   {
      MyClass() {
        TDbiRegistry r;
        r.Set("Default1",1);
        r.Set("Default2",2.0);
        InitializeConfig(r);
      };
   
      void ConfigModified() {
        GetConfig().Get("Default1",fDefault1);
        .. etc ..
      }
    

};

Definition at line 61 of file TDbiCfgPromptConfigurable.hxx.

---

Constructor & Destructor Documentation

TDbiCfgPromptConfigurable::TDbiCfgPromptConfigurable

(

)

TDbiCfgPromptConfigurable::TDbiCfgPromptConfigurable

(

const TDbiRegistry &

r

)

[inline]

Definition at line 65 of file TDbiCfgPromptConfigurable.hxx.

References InitializeConfig().

{InitializeConfig(r);};

Here is the call graph for this function:

virtual TDbiCfgPromptConfigurable::~TDbiCfgPromptConfigurable

(

)

[inline, virtual]

Definition at line 66 of file TDbiCfgPromptConfigurable.hxx.

{};

---

Member Function Documentation

TDbiCfgPromptConfigurable::ClassDef	(	TDbiCfgPromptConfigurable	,
		1
	)			[private]

virtual void TDbiCfgPromptConfigurable::ConfigModified

(

void

)

[protected, pure virtual]

Referenced by InitializeConfig(), and Set().

Here is the caller graph for this function:

const TDbiRegistry& TDbiCfgPromptConfigurable::GetConfig

(

)

const [inline]

Definition at line 69 of file TDbiCfgPromptConfigurable.hxx.

References fConfig.

{ return fConfig; };

void TDbiCfgPromptConfigurable::InitializeConfig

(

const TDbiRegistry &

initConfig

)

[protected]

Definition at line 66 of file TDbiCfgPromptConfigurable.cxx.

References TDbiRegistry::Clear(), ConfigModified(), fConfig, fDefaultConfig, TDbiRegistry::LockKeys(), TDbiRegistry::SetDirty(), TDbiRegistry::UnLockKeys(), and TDbiRegistry::UnLockValues().

Referenced by TDbiCfgPromptConfigurable().

{
  fConfig.UnLockKeys();
  fConfig.UnLockValues();
  fConfig.Clear();
  fConfig=initConfig;
  fConfig.SetDirty(false); // Do this whenever ConfigModified is called.
  fConfig.LockKeys();
  fConfig.UnLockValues();

  // For GUIs:
  fDefaultConfig=initConfig;

  ConfigModified();
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool TDbiCfgPromptConfigurable::IsFloat	(	const std::string &	s,
		Double_t &	val
	)			[static]

Definition at line 141 of file TDbiCfgPromptConfigurable.cxx.

Referenced by Set().

{
//======================================================================
// Does the string s represent an integer?
//======================================================================
  char* endptr;
  double d = strtod(s.c_str(), &endptr);
  if (endptr==s && d==0.0) return false; // Conversion to double failed...

  // All checks for "floatness" passed
  val = d;
  return true;
}

Here is the caller graph for this function:

bool TDbiCfgPromptConfigurable::IsInt	(	const std::string &	s,
		Int_t &	val
	)			[static]

Definition at line 117 of file TDbiCfgPromptConfigurable.cxx.

Referenced by Set().

{
  //======================================================================
  // Does the string s represent an integer?
  //======================================================================
  const char* ss = s.c_str();
  char* endptr;
  double d = strtod(ss, &endptr);
  if (endptr==ss && d==0.0) return false; // Conversion to double failed...

  // Check if this number is int or float
  if (strchr(ss,'.')) return false;
  if (strchr(ss,'E')) return false;
  if (strchr(ss,'e')) return false;

  // All checks for "intness" passed
  i = atoi(ss);

  return true;
}

Here is the caller graph for this function:

void TDbiCfgPromptConfigurable::LockKeys

(

)

[inline]

Definition at line 73 of file TDbiCfgPromptConfigurable.hxx.

References fConfig, and TDbiRegistry::LockKeys().

{ fConfig.LockKeys(); };

Here is the call graph for this function:

void TDbiCfgPromptConfigurable::LockValues

(

)

[inline]

Definition at line 75 of file TDbiCfgPromptConfigurable.hxx.

References fConfig, and TDbiRegistry::LockValues().

{ fConfig.LockValues(); };

Here is the call graph for this function:

Bool_t TDbiCfgPromptConfigurable::SafeMerge	(	TDbiRegistry &	modify,
		const TDbiRegistry &	stuff,
		Bool_t	recursive = false
	)			[static]

Sets multiple things at once in registry. If anything gets modified (to a new value) it returns true. Works recursively on owned registries. Keeps type-safety.. better than TDbiRegistry::Merge()

Throws EBadTDbiRegistryKeys();

Definition at line 258 of file TDbiCfgPromptConfigurable.cxx.

References TDbiRegistry::Get(), TDbiRegistry::GetType(), TDbiRegistry::GetTypeAsString(), TDbiRegistry::GetValueAsString(), TDbiRegistry::Key(), TDbiRegistry::KeyExists(), TDbiRegistry::KeysLocked(), TDbiRegistry::LockKeys(), TDbiRegistry::PrettyPrint(), TDbiRegistry::Set(), SK_DBI_Info, SK_DBI_Severe, SK_DBI_Warn, TDbiRegistry::UnLockValues(), and TDbiRegistry::ValuesLocked().

Referenced by Set().

{
 
  // First, see if we're locked up too tight to set anything.
  if(modify.ValuesLocked()) {
    SK_DBI_Warn( "Configurable has values locked. Can't set:" << "  ");
    SK_DBI_Warn( stuff << "  ");
    return false;
  }


  bool modified = false;

  // Iterate through all the keys in stuff.
  TDbiRegistry::TDbiRegistryKey keyitr = stuff.Key();
  const char* key;
  while( (key = keyitr()) ) {
                                                
    // Does modify have this key?
    if(!modify.KeyExists(key)) {
      // Key doesn't exist.

      if(modify.KeysLocked()) {

        // Keys are locked, so throw away with an error.
        SK_DBI_Warn( "Key " << key << " is not initialized in this Configurable. Skipping." << "  ");
        SK_DBI_Info("Current key/values are:" <<"  ");
   modify.PrettyPrint(std::cout);
        SK_DBI_Severe("FATAL: " << "\"" << key << "\" is an illegal key! Fix your script!" << "  ");
        throw EBadTDbiRegistryKeys();
        continue;

      } else {
        // Key exists. Go on to save this one.
      }

    } else {
      // Key exists.

      // Is the key the right type?
      if(modify.GetType(key)!=stuff.GetType(key)) {
        SK_DBI_Warn( "Key \"" << key << "\" is not initialized as type ("
                                          << modify.GetType(key).name()
                                          << ") but you've tried to set it to type ("
                                          << stuff.GetType(key).name()
                                          << ")" << "  ");
        continue;
      }

      if( modify.GetValueAsString(key)==stuff.GetValueAsString(key) ) {
        // The values are identical. So save the work and skip it.
        continue;
      }
    }

    // Switch on type:
    int    vint;
    double vdouble;
    char   vchar;
    const char* vcharstar;
    TDbiRegistry vregistry;

    const type_info& theType(modify.GetType(key));

    if((theType==typeid(char))&&(stuff.Get(key,vchar)))   modify.Set(key,vchar);
    if((theType==typeid(int))&&(stuff.Get(key,vint)))    modify.Set(key,vint);
    if((theType==typeid(double))&&(stuff.Get(key,vdouble))) modify.Set(key,vdouble);
    if((theType==typeid(const char*))&&(stuff.Get(key,vcharstar))) modify.Set(key,vcharstar);
    if(stuff.GetTypeAsString(key) == "TDbiRegistry"){
      if(stuff.Get(key,vregistry)) {
        // Registries are harder. Merge using this function.
        if(recursive) {

          TDbiRegistry old;
          if(modify.Get(key,old)) {
            TDbiRegistry old;
            // Just for safety:
            old.UnLockValues();
            old.LockKeys();
            if(SafeMerge(old,vregistry)) modified = true;
            modify.Set(key,old);
          }

        } else {
          modify.Set(key,vregistry);
        }
      }
    }

    modified = true;
  };

  return modified;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void TDbiCfgPromptConfigurable::Set	(	const TDbiRegistry &	stuff,
		Bool_t	recursive = false
	)

Definition at line 244 of file TDbiCfgPromptConfigurable.cxx.

References ConfigModified(), fConfig, SafeMerge(), and TDbiRegistry::SetDirty().

{
  if(SafeMerge(fConfig,stuff,recursive)) {
    // Something got changed, so allow user to change stuff:
    ConfigModified();
    fConfig.SetDirty(false);
  }
}

Here is the call graph for this function:

void TDbiCfgPromptConfigurable::Set

(

TDbiCfgDialog *

d = 0

)

Definition at line 156 of file TDbiCfgPromptConfigurable.cxx.

References fConfig, fDefaultConfig, TDbiCfgDialog::Query(), Set(), TDbiCfgDialog::SetCurrent(), and TDbiCfgDialog::SetDefault().

{
//======================================================================
// Update the configuration parameters. Allow a TDbiCfgDialog 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 TDbiCfgDialog();
    deleteDialog = true;
  }

  // Set up d with the default configuration parameters
  d->SetDefault(fDefaultConfig);
  d->SetCurrent(fConfig);

  // Do the querry
  TDbiRegistry r = d->Query();
  Set(r);

  // Clean up the dialog
  if (deleteDialog) { delete d; d = 0; }
}

Here is the call graph for this function:

void TDbiCfgPromptConfigurable::Set

(

const char *

setstring

)

Definition at line 202 of file TDbiCfgPromptConfigurable.cxx.

References IsFloat(), IsInt(), Set(), TDbiRegistry::Set(), SK_DBI_Warn, and Split().

{
  // Parse a whole string.

  // First, look for spaces to seperate entries.
  TDbiRegistry r;
  string a,b;
  string line = setstring;
  bool split;
  do {
    split = Split(line,' ',a,b);

    // a contains the possible code.
    string key, val;
    if(a.size()>0) {
      if(Split(a,'=',key,val)) {
        Int_t i;
        Double_t f;
        if(IsInt(val,i)) {
          r.Set(key.c_str(),i);
        } else if(IsFloat(val,f)) {
          r.Set(key.c_str(),f);
        } else {
          r.Set(key.c_str(),val.c_str());
        };
        
        
      } else {
        SK_DBI_Warn(  "Can't parse fragment: " << a << "  ");
      }
    }

    line = b;
  } while ( split );

  // Add the data.
  Set(r);
}

Here is the call graph for this function:

void TDbiCfgPromptConfigurable::Set	(	const char *	key,
		const TDbiRegistry &	val
	)

Definition at line 198 of file TDbiCfgPromptConfigurable.cxx.

References Set(), and TDbiRegistry::Set().

{ TDbiRegistry r;  r.Set(key,val); Set(r); }

Here is the call graph for this function:

void TDbiCfgPromptConfigurable::Set	(	const char *	key,
		int	val
	)

Definition at line 194 of file TDbiCfgPromptConfigurable.cxx.

References Set(), and TDbiRegistry::Set().

{ TDbiRegistry r;  r.Set(key,val); Set(r); }

Here is the call graph for this function:

void TDbiCfgPromptConfigurable::Set	(	const char *	key,
		double	val
	)

Definition at line 190 of file TDbiCfgPromptConfigurable.cxx.

References Set(), and TDbiRegistry::Set().

{ TDbiRegistry r;  r.Set(key,val); Set(r); }

Here is the call graph for this function:

void TDbiCfgPromptConfigurable::Set	(	const char *	key,
		const char *	val
	)

Definition at line 185 of file TDbiCfgPromptConfigurable.cxx.

References Set(), and TDbiRegistry::Set().

{ TDbiRegistry r;  r.Set(key,val); Set(r); }

Here is the call graph for this function:

void TDbiCfgPromptConfigurable::Set	(	const char *	key,
		char	val
	)

Definition at line 181 of file TDbiCfgPromptConfigurable.cxx.

References TDbiRegistry::Set().

Referenced by Set().

{ TDbiRegistry r;  r.Set(key,val); Set(r); }

Here is the call graph for this function:

Here is the caller graph for this function:

static Bool_t TDbiCfgPromptConfigurable::Split	(	const std::string &	line,
		char	sep,
		std::string &	a,
		std::string &	b
	)			[inline, static]

Definition at line 93 of file TDbiCfgPromptConfigurable.hxx.

References Split().

Referenced by Split().

  { return Split(line.c_str(),sep,a,b); };

Here is the call graph for this function:

Here is the caller graph for this function:

static Bool_t TDbiCfgPromptConfigurable::Split	(	const char *	line,
		char	sep,
		std::string &	a,
		std::string &	b
	)			[static]

Referenced by Set().

Here is the caller graph for this function:

void TDbiCfgPromptConfigurable::UnLockKeys

(

)

[inline]

Definition at line 72 of file TDbiCfgPromptConfigurable.hxx.

References fConfig, and TDbiRegistry::UnLockKeys().

{ fConfig.UnLockKeys(); };

Here is the call graph for this function:

void TDbiCfgPromptConfigurable::UnLockValues

(

)

[inline]

Definition at line 74 of file TDbiCfgPromptConfigurable.hxx.

References fConfig, and TDbiRegistry::UnLockValues().

{ fConfig.UnLockValues(); };

Here is the call graph for this function:

---

Member Data Documentation

TDbiRegistry TDbiCfgPromptConfigurable::fConfig [private]

Definition at line 113 of file TDbiCfgPromptConfigurable.hxx.

Referenced by GetConfig(), InitializeConfig(), LockKeys(), LockValues(), Set(), UnLockKeys(), and UnLockValues().

TDbiRegistry TDbiCfgPromptConfigurable::fDefaultConfig [private]

Definition at line 114 of file TDbiCfgPromptConfigurable.hxx.

Referenced by InitializeConfig(), and Set().

---

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

• src/TDbiCfgPromptConfigurable.hxx
• src/TDbiCfgPromptConfigurable.cxx