Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TEnvRec Class Reference

Definition at line 86 of file TEnv.h.

Public Member Functions

 TEnvRec ()
 
 ~TEnvRec ()
 TNamed destructor.
 
EEnvLevel GetLevel () const
 
const char * GetName () const override
 Returns name of object.
 
const char * GetType () const
 
const char * GetValue () const
 
ULong_t Hash () const override
 Return hash value for this object.
 
TClassIsA () const override
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual void Copy (TObject &object) const
 Copy this to obj.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout.
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Private Member Functions

 TEnvRec (const char *n, const char *v, const char *t, EEnvLevel l)
 Ctor of a single resource.
 
void ChangeValue (const char *v, const char *t, EEnvLevel l, Bool_t append=kFALSE, Bool_t ignoredup=kFALSE)
 Change the value of a resource.
 
Int_t Compare (const TObject *obj) const override
 Comparison function for resources.
 
TString ExpandValue (const char *v)
 Replace all strings by the value defined in the shell (obtained via TSystem::Getenv()).
 

Private Attributes

EEnvLevel fLevel
 
Bool_t fModified
 
TString fName
 
TString fType
 
TString fValue
 

Friends

class TEnv
 
class TEnvParser
 
class TReadEnvParser
 
class TWriteEnvParser
 

Additional Inherited Members

- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 

#include <TEnv.h>

Inheritance diagram for TEnvRec:
[legend]

Constructor & Destructor Documentation

◆ TEnvRec() [1/2]

TEnvRec::TEnvRec ( const char *  n,
const char *  v,
const char *  t,
EEnvLevel  l 
)
private

Ctor of a single resource.

Definition at line 274 of file TEnv.cxx.

◆ TEnvRec() [2/2]

TEnvRec::TEnvRec ( )
inline

Definition at line 107 of file TEnv.h.

◆ ~TEnvRec()

TEnvRec::~TEnvRec ( )

TNamed destructor.

Definition at line 284 of file TEnv.cxx.

Member Function Documentation

◆ ChangeValue()

void TEnvRec::ChangeValue ( const char *  v,
const char *  t,
EEnvLevel  l,
Bool_t  append = kFALSE,
Bool_t  ignoredup = kFALSE 
)
private

Change the value of a resource.

Definition at line 293 of file TEnv.cxx.

◆ Class()

static TClass * TEnvRec::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

static const char * TEnvRec::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

static constexpr Version_t TEnvRec::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 115 of file TEnv.h.

◆ Compare()

Int_t TEnvRec::Compare ( const TObject obj) const
overrideprivatevirtual

Comparison function for resources.

Reimplemented from TObject.

Definition at line 325 of file TEnv.cxx.

◆ DeclFileName()

static const char * TEnvRec::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 115 of file TEnv.h.

◆ ExpandValue()

TString TEnvRec::ExpandValue ( const char *  v)
private

Replace all strings by the value defined in the shell (obtained via TSystem::Getenv()).

Definition at line 334 of file TEnv.cxx.

◆ GetLevel()

EEnvLevel TEnvRec::GetLevel ( ) const
inline

Definition at line 112 of file TEnv.h.

◆ GetName()

const char * TEnvRec::GetName ( ) const
inlineoverridevirtual

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 109 of file TEnv.h.

◆ GetType()

const char * TEnvRec::GetType ( ) const
inline

Definition at line 111 of file TEnv.h.

◆ GetValue()

const char * TEnvRec::GetValue ( ) const
inline

Definition at line 110 of file TEnv.h.

◆ Hash()

ULong_t TEnvRec::Hash ( ) const
inlineoverridevirtual

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition TROOT.h:395

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.
ULong_t Hash() const override
Return hash value for this object.
Definition TEnv.h:113
Mother of all ROOT objects.
Definition TObject.h:41
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:993
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2498

Reimplemented from TObject.

Definition at line 113 of file TEnv.h.

◆ IsA()

TClass * TEnvRec::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TObject.

Definition at line 115 of file TEnv.h.

◆ Streamer()

void TEnvRec::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TEnvRec::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 115 of file TEnv.h.

Friends And Related Symbol Documentation

◆ TEnv

friend class TEnv
friend

Definition at line 88 of file TEnv.h.

◆ TEnvParser

friend class TEnvParser
friend

Definition at line 89 of file TEnv.h.

◆ TReadEnvParser

friend class TReadEnvParser
friend

Definition at line 90 of file TEnv.h.

◆ TWriteEnvParser

friend class TWriteEnvParser
friend

Definition at line 91 of file TEnv.h.

Member Data Documentation

◆ fLevel

EEnvLevel TEnvRec::fLevel
private

Definition at line 97 of file TEnv.h.

◆ fModified

Bool_t TEnvRec::fModified
private

Definition at line 98 of file TEnv.h.

◆ fName

TString TEnvRec::fName
private

Definition at line 94 of file TEnv.h.

◆ fType

TString TEnvRec::fType
private

Definition at line 95 of file TEnv.h.

◆ fValue

TString TEnvRec::fValue
private

Definition at line 96 of file TEnv.h.

Libraries for TEnvRec:

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