(UNKNOWN PRODUCT) » UTILS » TMrbEnv

class TMrbEnv: public TObject

__________________________________________________[C++ CLASS IMPLEMENTATION]

 Name:           utils/src/TMrbEnv.cxx
 Purpose:        Handle resource files
 Description:    Implements class methods to handle resource files
 Keywords:
 Author:         R. Lutter
 Mailto:         <a href=mailto:rudi.lutter@physik.uni-muenchen.de>R. Lutter</a>
 Revision:       $Id: TMrbEnv.cxx,v 1.22 2008/03/05 09:34:13 Rudolf.Lutter Exp $
 Date:

Function Members (Methods)

public:
TMrbEnv(const TMrbEnv&)
TMrbEnv(const Char_t* ResourceFile = "", const Char_t* DefaultsFile = "")
virtual~TMrbEnv()
voidTObject::AbstractMethod(const char* method) const
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTObject::Clear(Option_t* = "")
virtual TObject*TObject::Clone(const char* newname = "") const
virtual Int_tTObject::Compare(const TObject* obj) const
virtual voidTObject::Copy(TObject& object) const
Int_tCopyDefaults(const TRegexp& Regexp, Bool_t OverWrite = kFALSE, TMrbLofNamedX* LofSubstitutions = 0)
Int_tCopyDefaults(const Char_t* Resource, Bool_t ExactMatch = kTRUE, Bool_t OverWrite = kFALSE, TMrbLofNamedX* LofSubstitutions = 0)
virtual voidTObject::Delete(Option_t* option = "")MENU
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidTObject::Draw(Option_t* option = "")
virtual voidTObject::DrawClass() constMENU
virtual TObject*TObject::DrawClone(Option_t* option = "") constMENU
virtual voidTObject::Dump() constMENU
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
Int_tFind(const Char_t* LofPrefixes, const Char_t* Resource, Int_t Default)
const Char_t*Find(TString& Result, const Char_t* LofPrefixes, const Char_t* Resource, const Char_t* Default = "")
const Char_t*Find(TMrbNamedX& Result, const Char_t* LofPrefixes, const Char_t* Resource, const Char_t* Default = "")
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
Int_tGet(const Char_t* Resource, Int_t Default)
Double_tGet(const Char_t* Resource, Double_t Default)
const Char_t*Get(TString& Result, const Char_t* Resource, const Char_t* Default = "")
const Char_t*Get(TMrbNamedX& Result, const Char_t* Resource, const Char_t* Default = "")
Int_tGetDefault(const Char_t* Resource, Int_t Default)
const Char_t*GetDefault(TString& Result, const Char_t* Resource, const Char_t* Default = "")
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
TEnv*GetEnv()
virtual const char*TObject::GetIconName() const
virtual const char*TObject::GetName() const
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual Option_t*TObject::GetOption() const
virtual const char*TObject::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
Bool_tHasDefaults() const
virtual ULong_tTObject::Hash() const
voidHelp()
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() constMENU
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tIsModified() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tTObject::IsSortable() const
Bool_tTObject::IsZombie() const
virtual voidTObject::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tTObject::Notify()
voidTObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
Bool_tOpen(const Char_t* ResourceFile)
Bool_tOpenDefaults(const Char_t* DefaultsFile)
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
TMrbEnv&operator=(const TMrbEnv&)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
voidPrint() const
virtual voidPrint(Option_t* Option) const
voidPrintDefaults() const
voidPrintInfo()
Int_tPurge(Bool_t Verbose = kFALSE)
virtual Int_tTObject::Read(const char* name)
virtual voidTObject::RecursiveRemove(TObject* obj)
Int_tRemove(const TRegexp& Regexp)
Int_tRemove(const Char_t* Resource, Bool_t ExactMatch = kTRUE)
voidTObject::ResetBit(UInt_t f)
const Char_t*Resource(TString& R, const Char_t* F1, Int_t X1 = -1, const Char_t* F2 = "", Int_t X2 = -1, const Char_t* F3 = "") const
voidSave(Bool_t Verbose = kTRUE)
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
Bool_tSet(const Char_t* Resource, const Char_t* StrVal)
Bool_tSet(const Char_t* Resource, Int_t IntVal, Int_t Base = 10)
Bool_tSet(const Char_t* Resource, Double_t DblVal, Int_t Precision = 4)
Bool_tSet(const Char_t* Resource, TMrbNamedX* NamedVal, Int_t Base = 10)
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual voidTObject::SetDrawOption(Option_t* option = "")MENU
static voidTObject::SetDtorOnly(void* obj)
static voidTObject::SetObjectStat(Bool_t stat)
voidSetPrefix(const Char_t* Prefix)
Int_tSetUndef(const TRegexp& Regexp)
Int_tSetUndef(const Char_t* Resource, Bool_t ExactMatch = kTRUE)
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidShowMembers(TMemberInspector& insp)
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_tTObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const
protected:
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
voidTObject::MakeZombie()

Data Members

public:
enum TObject::EStatusBits { kCanDelete
kMustCleanup
kObjInCanvas
kIsReferenced
kHasUUID
kCannotPick
kNoContextMenu
kInvalidObject
};
enum TObject::[unnamed] { kIsOnHeap
kNotDeleted
kZombie
kBitMask
kSingleKey
kOverwrite
kWriteDelete
};
protected:
TEnv*fCurEnvcurrent resource data base
TStringfCurFilepath to current resource file
TEnv*fDefaultsEnvdefaults data base
TStringfDefaultsFilepath to default resource file
Bool_tfIsModifiedkTRUE, if at least 1 entry modified
Bool_tfIsSystemEnvif mapped to gEnv
TStringfPrefixprefix
TStringfResourceNameresource name

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

TMrbEnv(const Char_t* ResourceFile = "", const Char_t* DefaultsFile = "")
__________________________________________________________________[C++ CTOR]

 Name:           TMrbEnv
 Purpose:        Open a resource file
 Arguments:      Char_t * ResourceFile   -- resource file
                 Char_t * DefaultFile    -- file containing defaults
 Results:        --
 Exceptions:
 Description:    Class constructor
 Keywords:
Bool_t Open(const Char_t* ResourceFile)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Open
 Purpose:        Open resource file
 Arguments:      Char_t * ResourceFile   -- file name
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Opens a resource file
 Keywords:
Bool_t OpenDefaults(const Char_t* DefaultsFile)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::OpenDefaults
 Purpose:        Open defaults file
 Arguments:      Char_t * DefaultsFile   -- file name
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Opens defaults file
 Keywords:
void Save(Bool_t Verbose = kTRUE)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Save
 Purpose:        Save contents to file
 Arguments:      Bool_t Verbose   -- print message if kTRUE
 Results:        --
 Exceptions:
 Description:    Saves resources and closes file.
 Keywords:
void SetPrefix(const Char_t* Prefix)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::SetPrefix
 Purpose:        Define resource prefix
 Arguments:      Char_t * Prefix   -- resource prefix
 Results:        --
 Exceptions:
 Description:    Defines fixed header part of resource string.
 Keywords:
const Char_t * Resource(TString& R, const Char_t* F1, Int_t X1 = -1, const Char_t* F2 = "", Int_t X2 = -1, const Char_t* F3 = "") const
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Resource
 Purpose:        Initialize resource string
 Arguments:      TString & R             -- where to store resulting name
                 Char_t * Field1         -- resource field 1
                 Int_t Index1            -- index field 1
                 Char_t * Field2         -- resource field 2
                 Int_t Index2            -- index field 2
                 Char_t * Field3         -- resource field 3
 Results:        Char_t * ResourceName   -- resource name (same as R)
 Exceptions:
 Description:    Creates a resource string "Prefix.Field1Index1.Field2Index2.Field3"
 Keywords:
Bool_t Set(const Char_t* Resource, const Char_t* StrVal)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Set
 Purpose:        Assign an ascii value
 Arguments:      Char_t * Resource    -- resource name
                 Char_t * StrVal      -- value to be set
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Sets a given resource.
 Keywords:
Bool_t Set(const Char_t* Resource, Int_t IntVal, Int_t Base = 10)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Set
 Purpose:        Assign an integer value
 Arguments:      Char_t * Resource         -- resource name
                 Int_t IntVal              -- value to be set
                 Int_t Base                -- base to be used
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Sets a given resource.
 Keywords:
Bool_t Set(const Char_t* Resource, Double_t DblVal, Int_t Precision = 4)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Set
 Purpose:        Assign an integer value
 Arguments:      Char_t * Resource         -- resource name
                 Double_t DblVal           -- value to be set
                 Int_t Precision           -- precision
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Sets a given resource.
 Keywords:
Bool_t Set(const Char_t* Resource, TMrbNamedX* NamedVal, Int_t Base = 10)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Set
 Purpose:        Assign a pair of name + integer value
 Arguments:      Char_t * Resource         -- resource name
                 TMrbNamedX * NamedVal     -- value to be set
                 Int_t Base                -- numerical base
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Sets a given resource.
 Keywords:
Int_t Get(const Char_t* Resource, Int_t Default)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Get
 Purpose:        Read an int resource from database
 Arguments:      Char_t * Resource     -- resource name
                 Int_t Default         -- default value
 Results:        Int_t Value           -- integer value
 Exceptions:
 Description:    Reads a given resource from database.
 Keywords:
Double_t Get(const Char_t* Resource, Double_t Default)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Get
 Purpose:        Read an int resource from database
 Arguments:      Char_t * Resource     -- resource name
                 Double_t Default      -- default value
 Results:        Double_t Value        -- integer value
 Exceptions:
 Description:    Reads a given resource from database.
 Keywords:
const Char_t * Get(TString& Result, const Char_t* Resource, const Char_t* Default = "")
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Get
 Purpose:        Read an ascii resource from database
 Arguments:      TString & Result      -- where to store resulting value
                 Char_t * Resource     -- resource name
                 Char_t * Default      -- default value
 Results:        Char_t * Value        -- ascii value (same as Result.Data())
 Exceptions:
 Description:    Reads a given resource from database.
 Keywords:
const Char_t * Get(TMrbNamedX& Result, const Char_t* Resource, const Char_t* Default = "")
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Get
 Purpose:        Read an ascii resource from database
 Arguments:      TMrbNamedX & Result   -- where to store resulting value
                 Char_t * Resource     -- resource name
                 Char_t * Default      -- default value
 Results:        Char_t * Value        -- ascii value (same as Result.Data())
 Exceptions:
 Description:    Reads a given resource from database.
 Keywords:
Int_t Find(const Char_t* LofPrefixes, const Char_t* Resource, Int_t Default)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Find
 Purpose:        Search for an int resource in database
 Arguments:      Char_t * LofPrefixes  -- prefixes to be tried out
                 Char_t * Resource     -- resource name
                 Int_t Default         -- default value
 Results:        Int_t Value           -- integer value
 Exceptions:
 Description:    Searches for a given resource trying different prefixes.
 Keywords:
const Char_t * Find(TString& Result, const Char_t* LofPrefixes, const Char_t* Resource, const Char_t* Default = "")
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Find
 Purpose:        Find an ascii resource in database
 Arguments:      TString & Result      -- where to store resulting value
                 Char_t * LofPrefixes  -- prefixes to be tried out
                 Char_t * Resource     -- resource name
                 Char_t * Default      -- default value
 Results:        Char_t * Value        -- ascii value (same as Result.Data())
 Exceptions:
 Description:    Searches for a given resource  trying different prefixes.
 Keywords:
const Char_t * Find(TMrbNamedX& Result, const Char_t* LofPrefixes, const Char_t* Resource, const Char_t* Default = "")
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Find
 Purpose:        Find an ascii resource in database
 Arguments:      TMrbNamedX & Result   -- where to store resulting value
                 Char_t * LofPrefixes  -- prefixes to be tried out
                 Char_t * Resource     -- resource name
                 Char_t * Default      -- default value
 Results:        Char_t * Value        -- ascii value (same as Result.Data())
 Exceptions:
 Description:    Searches for a given resource  trying different prefixes.
 Keywords:
const Char_t * GetDefault(TString& Result, const Char_t* Resource, const Char_t* Default = "")
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::GetDefault
 Purpose:        Read a resource from defaults
 Arguments:      TString & Result  -- where to store resulting value
                 Char_t * Resource -- resource name
                 Char_t * Default  -- default value
 Results:        Char_t * Value    -- resource value (same as Result.Data())
 Exceptions:
 Description:    Reads a given resource from defaults.
 Keywords:
Int_t GetDefault(const Char_t* Resource, Int_t Default)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::GetDefault
 Purpose:        Read a resource from defaults
 Arguments:      Char_t * Resource -- resource name
                 Int_t Default     -- default value
 Results:        Int_t Value       -- integer representation
 Exceptions:
 Description:    Reads a given resource from defaults.
 Keywords:
Int_t CopyDefaults(const Char_t* Resource, Bool_t ExactMatch = kTRUE, Bool_t OverWrite = kFALSE, TMrbLofNamedX* LofSubstitutions = 0)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::CopyDefaults
 Purpose:        Copy a resource value from defaults
 Arguments:      Char_t * Resource                  -- resource name
                 Bool_t ExactMatch                  -- how to match resource names?
                 Bool_t OverWrite                   -- overwrite existing resources?
                 TMrbLofNamedX * LofSubstitutions   -- list of substitutions to be performed
 Results:        Int_t NofRes                       -- number of resources copied
 Exceptions:
 Description:    Sets a resource to its default value.
 Keywords:
Int_t CopyDefaults(const TRegexp& Regexp, Bool_t OverWrite = kFALSE, TMrbLofNamedX* LofSubstitutions = 0)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::CopyDefaults
 Purpose:        Copy resource values within regular expression
 Arguments:      TRegexp Regexp                     -- regular expression
                 Bool_t OverWrite                   -- overwrite existing resources?
                 TMrbLofNamedX * LofSubstitutions   -- list of substitutions to be performed
 Results:        Int_t NofRes                       -- number of resources copied
 Exceptions:
 Description:    Sets resource(s) to default value(s).
 Keywords:
Int_t SetUndef(const Char_t* Resource, Bool_t ExactMatch = kTRUE)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::SetUndef
 Purpose:        Set resource value to "undefined"
 Arguments:      Char_t * Resource    -- resource name
                 Bool_t ExactMatch    -- how to match resource names
 Results:        Int_t NofRes         -- number of resources found
 Exceptions:
 Description:    Sets a resource to <undef>.
 Keywords:
Int_t SetUndef(const TRegexp& Regexp)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::SetUndef
 Purpose:        Set resource value to "undefined"
 Arguments:      TRegexp Regexp      -- regular expression
 Results:        Int_t NofRes        -- number of entries found
 Exceptions:
 Description:    Sets a resource to <undef>.
 Keywords:
Int_t Remove(const Char_t* Resource, Bool_t ExactMatch = kTRUE)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Remove
 Purpose:        Remove resource from file
 Arguments:      Char_t * Resource    -- resource name
                 Bool_t ExactMatch    -- how to match resource names
 Results:        Int_t NofRes         -- number of resources removed
 Exceptions:
 Description:    Removes resource(s) from file.
 Keywords:
Int_t Remove(const TRegexp& Regexp)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Remove
 Purpose:        Remove resource from file
 Arguments:      TRegexp Regexp      -- regular expression
 Results:        Int_t NofRes        -- number of entries removed
 Exceptions:
 Description:    Removes resource(s) from file.
 Keywords:
Int_t Purge(Bool_t Verbose = kFALSE)
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::Remove
 Purpose:        Remove resource from file
 Arguments:      Bool_t Verbose     -- output message if kTRUE
 Results:        Int_t NofRes       -- number of entries removed
 Exceptions:
 Description:    Removes undefined resources from file.
 Keywords:
void PrintInfo()
________________________________________________________________[C++ METHOD]

 Name:           TMrbEnv::PrintInfo()
 Purpose:        Print file info
 Arguments:      --
 Results:        --
 Exceptions:
 Description:    Outputs file info to cout.
 Keywords:
TMrbEnv(const Char_t* ResourceFile = "", const Char_t* DefaultsFile = "")
~TMrbEnv()
void Print(Option_t* Option) const
{ TObject::Print(Option); }
void Print() const
{ fCurEnv->Print(); }
void PrintDefaults() const
{ if (this->HasDefaults()) fDefaultsEnv->Print(); }
TEnv * GetEnv()
{ return(fCurEnv); }
Bool_t HasDefaults() const
{ return(fDefaultsEnv != NULL); }
Bool_t IsModified() const
{ return(fIsModified); }
void Help()
{ gSystem->Exec(Form("mrbHelp %s", this->ClassName())); }


Revision: $Id: TMrbEnv.h,v 1.8 2006/10/31 15:46:33 Rudolf.Lutter Exp $
ROOT page - Home page - Class index - Top of the page
This page has been automatically generated by use of ROOT's THtml class. If you have any comments or suggestions about the page layout send a mail to Marabou Support.