ROOT logo

class TEnv: public TObject


The TEnv class reads a config file, by default .rootrc. Three types
of .rootrc files are read: global, user and local files. The global
file resides in $ROOTSYS/etc, the user file in ~/ and the local file
in the current working directory.
The format of the .rootrc file is similar to the .Xdefaults format:

[+]<SystemName>.<RootName|ProgName>.<name>[(type)]:  <value>

Where <SystemName> is either Unix, WinNT, MacOS or Vms,
<RootName> the name as given in the TApplication ctor (or "RootApp"
in case no explicit TApplication derived object was created),
<ProgName> the current program name and <name> the resource name,
with optionally a type specification. <value> can be either a
string, an integer, a float/double or a boolean with the values
TRUE, FALSE, ON, OFF, YES, NO, OK, NOT. Booleans will be returned as
an integer 0 or 1. The options [+] allows the concatenation of
values to the same resouce name.


Unix.Rint.Root.DynamicPath: .:$ROOTSYS/lib:~/lib
myapp.Root.Debug:  FALSE
TH.Root.Debug: YES
*.Root.MemStat: 1

<SystemName> and <ProgName> or <RootName> may be the wildcard "*".
A # in the first column starts comment line.

For the currently defined resources (and their default values) see

Note that the .rootrc config files contain the config for all ROOT
based applications.

To add new entries to a TEnv:
TEnv env(".myfile");

All new entries will be saved in the file corresponding to the
first SaveLevel() command.  If Save() is used, new entries go
into the local file by default.

Function Members (Methods)

TEnv(const char* name = "")
voidTObject::AbstractMethod(const char* method) const
virtual voidTObject::AppendPad(Option_t* option = "")
virtual voidTObject::Browse(TBrowser* b)
static TClass*Class()
static TClass*TObject::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
Bool_tDefined(const char* name)
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
virtual TObject*TObject::FindObject(const char* name) const
virtual TObject*TObject::FindObject(const TObject* obj) const
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
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*GetRcName() const
THashList*GetTable() const
virtual const char*TObject::GetTitle() const
virtual UInt_tTObject::GetUniqueID() const
virtual Int_tGetValue(const char* name, Int_t dflt)
virtual Double_tGetValue(const char* name, Double_t dflt)
virtual const char*GetValue(const char* name, const char* dflt)
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTObject::Hash() const
Bool_tIgnoreDuplicates(Bool_t ignore)
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 TClass*TObject::IsA() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTObject::IsFolder() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tTObject::IsSortable() const
Bool_tTObject::IsZombie() const
virtual TEnvRec*Lookup(const char* n)
virtual voidTObject::ls(Option_t* option = "") const
voidTObject::MayNotUse(const char* method) const
virtual Bool_tTObject::Notify()
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)
TObject&TObject::operator=(const TObject& rhs)
virtual voidTObject::Paint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidPrint(Option_t* option = "") const
virtual voidTObject::Print(Option_t* option = "") const
virtual voidPrintEnv(EEnvLevel level = kEnvAll) const
virtual Int_tTObject::Read(const char* name)
virtual Int_tReadFile(const char* fname, EEnvLevel level)
virtual voidTObject::RecursiveRemove(TObject* obj)
voidTObject::ResetBit(UInt_t f)
virtual voidSave()
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual voidSaveLevel(EEnvLevel level)
virtual voidTObject::SavePrimitive(basic_ostream<char,char_traits<char> >& out, Option_t* option = "")
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)
virtual voidSetRcName(const char* name)
virtual voidTObject::SetUniqueID(UInt_t uid)
virtual voidSetValue(const char* name, EEnvLevel level = kEnvChange)
virtual voidSetValue(const char* name, Int_t value)
virtual voidSetValue(const char* name, Double_t value)
virtual voidSetValue(const char* name, const char* value, EEnvLevel level = kEnvChange, const char* type = 0)
virtual voidShowMembers(TMemberInspector& insp, char* parent)
virtual voidTObject::ShowMembers(TMemberInspector& insp, char* parent)
virtual voidStreamer(TBuffer& b)
virtual voidTObject::Streamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
voidTObject::StreamerNVirtual(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
virtual Int_tWriteFile(const char* fname, EEnvLevel level = kEnvAll)
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
TEnv(const TEnv&)
const char*Getvalue(const char* name)
TEnv&operator=(const TEnv&)

Data Members

Bool_tfIgnoreDupignore duplicates, don't issue warning
TStringfRcNameresource file base name
THashList*fTablehash table containing env records

Class Charts

Inheritance Inherited Members Includes Libraries
Class Charts

Function documentation

TEnv(const char *name)
 Create a resource table and read the (possibly) three resource files, i.e
 $ROOTSYS/system<name> (or ROOTETCDIR/system<name>), $HOME/<name> and
 ./<name>. ROOT always reads ".rootrc" (in TROOT::InitSystem()). You can
 read additional user defined resource files by creating addtional TEnv
 Delete the resource table.
const char * Getvalue(const char* name)
 Returns the character value for a named resouce.
Int_t GetValue(const char *name, Int_t dflt)
 Returns the integer value for a resource. If the resource is not found
 return the dflt value.
Double_t GetValue(const char *name, Double_t dflt)
 Returns the double value for a resource. If the resource is not found
 return the dflt value.
const char * GetValue(const char *name, const char *dflt)
 Returns the character value for a named resouce. If the resource is
 not found the dflt value is returned.
TEnvRec * Lookup(const char* n)
 Loop over all resource records and return the one with name.
 Return 0 in case name is not in the resoucre table.
void Print(Option_t* option = "") const
 Print all resources or the global, user or local resources separately.
void PrintEnv(EEnvLevel level = kEnvAll) const
 Print all resources for a certain level (global, user, local, changed).
Int_t ReadFile(const char* fname, EEnvLevel level)
 Read and parse the resource file for a certain level.
 Returns -1 on case of error, 0 in case of success.
Int_t WriteFile(const char* fname, EEnvLevel level = kEnvAll)
 Write resourse records to file fname for a certain level. Use
 level kEnvAll to write all resources. Returns -1 on case of error,
 0 in case of success.
void Save()
 Write the resource files for each level. The new files have the same
 name as the original files. The old files are renamed to *.bak.
void SaveLevel(EEnvLevel level)
 Write the resource file for a certain level.
void SetValue(const char* name, const char* value, EEnvLevel level = kEnvChange, const char* type = 0)
 Set the value of a resource or create a new resource.
void SetValue(const char *name, EEnvLevel level)
 Set the value of a resource or create a new resource.
 Use this method to set a resource like, "name=val".
 If just "name" is given it will be interpreted as "name=1".
void SetValue(const char *name, Int_t value)
 Set or create an integer resource value.
void SetValue(const char *name, double value)
 Set or create a double resource value.
Bool_t IgnoreDuplicates(Bool_t ignore)
 If set to true, no warnings in case of duplicates are issued.
 Returns previous value.
TEnv(const TEnv&)
TEnv& operator=(const TEnv& )
THashList * GetTable() const
{ return fTable; }
Bool_t Defined(const char* name)
{ return Getvalue(name) != 0; }
const char * GetRcName() const
{ return fRcName; }
void SetRcName(const char* name)
{ fRcName = name; }