TDbiCfgPromptConfigurable.cxx File Reference

#include "TDbiCfgPromptConfigurable.hxx"
#include "TDbiCfgDialog.hxx"
#include <TSK_DBI_Log.hxx>
#include <MsgFormat.h>
#include <string.h>
#include <stdlib.h>
#include <typeinfo>
#include "TDbi.hxx"
#include <assert.h>

Include dependency graph for TDbiCfgPromptConfigurable.cxx:

Go to the source code of this file.

Functions
	ClassImp (TDbiCfgPromptConfigurable) TDbiCfgPromptConfigurable

---

Function Documentation

ClassImp

(

TDbiCfgPromptConfigurable

)

TDbiCfgPromptConfigurable

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 12 of file TDbiCfgPromptConfigurable.cxx.

{
  ////////////////////////////////////////////////////////////////////////////////////
  /// TDbiCfgPromptConfigurable
  ///
  /// 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 ..
  ///   }
  ///
  ///};
}