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

ROOT top level object description.

The TROOT object is the entry point to the ROOT system. The single instance of TROOT is accessible via the global gROOT. Using the gROOT pointer one has access to basically every object created in a ROOT based program. The TROOT object is essentially a container of several lists pointing to the main ROOT objects.

The following lists are accessible from gROOT object:

gROOT->GetListOfClasses
gROOT->GetListOfColors
gROOT->GetListOfTypes
gROOT->GetListOfGlobals
gROOT->GetListOfGlobalFunctions
gROOT->GetListOfFiles
gROOT->GetListOfMappedFiles
gROOT->GetListOfSockets
gROOT->GetListOfCanvases
gROOT->GetListOfStyles
gROOT->GetListOfFunctions
gROOT->GetListOfSpecials (for example graphical cuts)
gROOT->GetListOfGeometries
gROOT->GetListOfBrowsers
gROOT->GetListOfCleanups
gROOT->GetListOfMessageHandlers
#define gROOT
Definition TROOT.h:417

The TROOT class provides also many useful services:

  • Get pointer to an object in any of the lists above
  • Time utilities TROOT::Time

The ROOT object must be created as a static object. An example of a main program creating an interactive version is shown below:

Example of a main program

#include "TRint.h"
int main(int argc, char **argv)
{
TRint *theApp = new TRint("ROOT example", &argc, argv);
// Init Intrinsics, build all windows, and enter event loop
theApp->Run();
return(0);
}
int main()
Definition Prototype.cxx:12
Definition TRint.h:31
void Run(Bool_t retrn=kFALSE) override
Main application eventloop.
Definition TRint.cxx:388

Definition at line 107 of file TROOT.h.

Public Types

enum  { kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
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))
}
typedef std::vector< std::pair< std::string, int > > FwdDeclArgsToKeepCollection_t

Public Member Functions

 TROOT (const char *name, const char *title, VoidFuncPtr_t *initfunc=nullptr)
 Initialize the ROOT system.
virtual ~TROOT ()
 Clean up and free resources used by ROOT (files, network sockets, shared memory segments, etc.).
void AbstractMethod (const char *method) const
 Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
virtual void Add (TObject *obj, Bool_t replace=kFALSE)
 Append object to this directory.
void AddClass (TClass *cl)
 Add a class to the list and map of classes.
void AddClassGenerator (TClassGenerator *gen)
 Add a class generator.
void Append (TObject *obj, Bool_t replace=kFALSE) override
 Append object to this directory.
virtual Int_t AppendKey (TKey *)
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
void Browse (TBrowser *b) override
 Add browsable objects to TBrowser.
virtual void Build (TFile *motherFile=nullptr, TDirectory *motherDir=nullptr)
virtual Bool_t cd ()
 Change current directory to "this" directory.
virtual Bool_t cd (const char *path)
 Change current directory to "this" directory or to the directory described by the path if given one.
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.
Bool_t ClassSaved (TClass *cl)
 return class status 'ClassSaved' for class cl This function is called by the SavePrimitive functions writing the C++ code for an object.
void Clear (Option_t *option="") override
 Delete all objects from a Directory list.
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
virtual TObjectCloneObject (const TObject *obj, Bool_t autoadd=kTRUE)
 Clone an object.
virtual void Close (Option_t *option="")
 Delete all objects from memory and directory structure itself.
void CloseFiles ()
 Close any files and sockets that gROOT knows about.
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
void Copy (TObject &) const override
 Copy this to obj.
void Delete (const char *namecycle="") override
 Delete Objects or/and keys in a directory.
virtual void DeleteAll (Option_t *option="")
 Delete all objects from memory.
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
void Draw (Option_t *option="") override
 Fill Graphics Structure and Paint.
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.
void EndOfProcessCleanups ()
 Execute the cleanups necessary at the end of the process, in particular those that must be executed before the library start being unloaded.
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 void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
virtual TKeyFindKey (const char *) const
virtual TKeyFindKeyAny (const char *) const
TObjectFindObject (const char *name) const override
 Returns address of a ROOT object if it exists.
TObjectFindObject (const TObject *obj) const override
 Find an object in one Root folder.
TObjectFindObjectAny (const char *name) const override
 Return a pointer to the first object with name starting at //root.
TObjectFindObjectAnyFile (const char *name) const override
 Scan the memory lists of all files for an object with name.
const char * FindObjectClassName (const char *name) const
 Returns class name of a ROOT object including CINT globals.
const char * FindObjectPathName (const TObject *obj) const
 Return path name of obj somewhere in the //root/... path.
TObjectFindSpecialObject (const char *name, void *&where)
 Returns address and folder of a ROOT object if it exists.
TClassFindSTLClass (const char *name, Bool_t load, Bool_t silent=kFALSE) const
 return a TClass object corresponding to 'name' assuming it is an STL container.
void ForceStyle (Bool_t force=kTRUE)
Bool_t FromPopUp () const
template<class T>
T * Get (const char *namecycle)
 See documentation of TDirectoryFile::Get(const char *namecycle).
virtual TObjectGet (const char *namecycle)
 Return pointer to object identified by namecycle.
TApplicationGetApplication () const
virtual Int_t GetBufferSize () const
Int_t GetBuiltDate () const
Int_t GetBuiltTime () const
TClassGetClass (const char *name, Bool_t load=kTRUE, Bool_t silent=kFALSE) const
 Return pointer to class with name. Obsolete, use TClass::GetClass directly.
TClassGetClass (const std::type_info &typeinfo, Bool_t load=kTRUE, Bool_t silent=kFALSE) const
 Return pointer to class from its name.
TSeqCollectionGetClipboard () const
TColorGetColor (Int_t color) const
 Return address of color with index color.
const char * GetConfigFeatures () const
const char * GetConfigOptions () const
const char * GetCutClassName () const
const char * GetDefCanvasName () const
virtual TDirectoryGetDirectory (const char *namecycle, Bool_t printError=false, const char *funcname="GetDirectory")
 Find a directory using apath.
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
Bool_t GetEditHistograms () const
Int_t GetEditorMode () const
TFileGetFile () const override
TFileGetFile (const char *name) const
 Return pointer to file with name.
Bool_t GetForceStyle () const
TObjectGetFunction (const char *name) const
 Return pointer to function with name.
TFunctionTemplateGetFunctionTemplate (const char *name)
TObjectGetGeometry (const char *name) const
 Return pointer to Geometry with name.
const char * GetGitBranch () const
const char * GetGitCommit () const
const char * GetGitDate ()
 Return date/time make was run.
TGlobalGetGlobal (const char *name, Bool_t load=kFALSE) const
 Return pointer to global variable by name.
TGlobalGetGlobal (const TObject *obj, Bool_t load=kFALSE) const
 Return pointer to global variable with address addr.
TFunctionGetGlobalFunction (const char *name, const char *params=nullptr, Bool_t load=kFALSE)
 Return pointer to global function by name.
TFunctionGetGlobalFunctionWithPrototype (const char *name, const char *proto=nullptr, Bool_t load=kFALSE)
 Return pointer to global function by name.
virtual const char * GetIconName () const
 Returns mime type name of object.
TInterpreterGetInterpreter () const
virtual TKeyGetKey (const char *, Short_t=9999) const
virtual TListGetList () const
TListGetListOfBrowsables () const
TSeqCollectionGetListOfBrowsers () const
TSeqCollectionGetListOfCanvases () const
TCollectionGetListOfClasses () const
TCollectionGetListOfClassGenerators () const
TSeqCollectionGetListOfCleanups () const
TSeqCollectionGetListOfClosedObjects () const
TSeqCollectionGetListOfColors () const
TSeqCollectionGetListOfDataSets () const
TCollectionGetListOfEnums (Bool_t load=kFALSE)
TSeqCollectionGetListOfFiles () const
TCollectionGetListOfFunctionOverloads (const char *name) const
 Return the collection of functions named "name".
TCollectionGetListOfFunctions () const
TCollectionGetListOfFunctionTemplates ()
TSeqCollectionGetListOfGeometries () const
TCollectionGetListOfGlobalFunctions (Bool_t load=kFALSE)
 Return list containing the TFunctions currently defined.
TCollectionGetListOfGlobals (Bool_t load=kFALSE)
 Return list containing the TGlobals currently defined.
virtual TListGetListOfKeys () const
TSeqCollectionGetListOfMappedFiles () const
TSeqCollectionGetListOfMessageHandlers () const
TSeqCollectionGetListOfSockets () const
TSeqCollectionGetListOfSpecials () const
TSeqCollectionGetListOfStreamerInfo () const
TSeqCollectionGetListOfStyles () const
TSeqCollectionGetListOfTasks () const
TCollectionGetListOfTypes (Bool_t load=kFALSE)
 Return a dynamic list giving access to all TDataTypes (typedefs) currently defined.
TObjectGetMother () const
TDirectoryGetMotherDir () const
const char * GetName () const override
 Returns name of object.
virtual Int_t GetNbytesKeys () const
Int_t GetNclasses () const
 Get number of classes.
virtual Int_t GetNkeys () const
Int_t GetNtypes () const
 Get number of types.
template<class T>
void GetObject (const char *namecycle, T *&ptr)
 Get an object with proper type checking.
virtual void * GetObjectChecked (const char *namecycle, const char *classname)
 See documentation of TDirectory::GetObjectCheck(const char *namecycle, const TClass *cl).
virtual void * GetObjectChecked (const char *namecycle, const TClass *cl)
 Return pointer to object identified by namecycle if and only if the actual object is a type suitable to be stored as a pointer to a "expectedClass" If expectedClass is null, no check is performed.
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
virtual void * GetObjectUnchecked (const char *namecycle)
 Return pointer to object identified by namecycle.
virtual Option_tGetOption () const
virtual const char * GetPath () const
 Returns the full path of the directory.
virtual const char * GetPathStatic () const
 Returns the full path of the directory.
TPluginManagerGetPluginManager () const
TFolderGetRootFolder () const
virtual Long64_t GetSeekDir () const
virtual Long64_t GetSeekKeys () const
virtual Long64_t GetSeekParent () const
TVirtualPadGetSelectedPad () const
const TObjectGetSelectedPrimitive () const
TStyleGetStyle (const char *name) const
 Return pointer to style with name.
const char * GetTitle () const override
 Returns title of object.
TDataTypeGetType (const char *name, Bool_t load=kFALSE) const
 Return pointer to type with name.
virtual UInt_t GetUniqueID () const
 Return the unique object id.
TUUID GetUUID () const
TProcessUUIDGetUUIDs () const
const char * GetVersion () const
Int_t GetVersionCode () const
Int_t GetVersionDate () const
Int_t GetVersionInt () const
Int_t GetVersionTime () const
const TStringGetWebDisplay () const
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
ULong_t Hash () const override
 Return hash value for this object.
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.
void Idle (UInt_t idleTimeInSec, const char *command=nullptr)
 Execute command when system has been idle for idleTimeInSec seconds.
Int_t IgnoreInclude (const char *fname, const char *expandedfname)
 Return 1 if the name of the given include file corresponds to a class that is known to ROOT, e.g.
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)
TClassIsA () const override
Bool_t IsBatch () const
Bool_t IsBuilt () const
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).
Bool_t IsEscaped () const
Bool_t IsExecutingMacro () const
Bool_t IsFolder () const override
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
Bool_t IsInterrupted () const
Bool_t IsLineProcessing () const
virtual Bool_t IsModified () const
Bool_t IsOnHeap () const
Bool_t IsRootFile (const char *filename) const
 Return true if the file is local and is (likely) to be a ROOT file.
Bool_t IsSortable () const override
Bool_t IsWebDisplay () const
Bool_t IsWebDisplayBatch () const
virtual Bool_t IsWritable () const
Bool_t IsZombie () const
Int_t LoadClass (const char *classname, const char *libname, Bool_t check=kFALSE)
 Check if class "classname" is known to the interpreter (in fact, this check is not needed anymore, so classname is ignored).
TClassLoadClass (const char *name, Bool_t silent=kFALSE) const
 Helper function used by TClass::GetClass().
Int_t LoadMacro (const char *filename, Int_t *error=nullptr, Bool_t check=kFALSE)
 Load a macro in the interpreter's memory.
void ls (Option_t *option="") const override
 To list all objects of the application.
Longptr_t Macro (const char *filename, Int_t *error=nullptr, Bool_t padUpdate=kTRUE)
 Execute a macro in the interpreter.
TCanvasMakeDefCanvas () const
 Return a default canvas.
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).
void Message (Int_t id, const TObject *obj)
 Process message id called by obj.
virtual TDirectorymkdir (const char *name, const char *title="", Bool_t returnExistingDirectory=kFALSE)
 Create a sub-directory "a" or a hierarchy of sub-directories "a/b/c/...".
Bool_t MustClean () const
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.
virtual TFileOpenFile (const char *, Option_t *="", const char *="", Int_t=1, Int_t=0)
void operator delete (void *, size_t)
 Operator delete for sized deallocation.
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 *, size_t)
 Operator delete [] for sized deallocation.
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 Paint (Option_t *option="") override
 Paint all objects in the directory.
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
void Print (Option_t *option="") const override
 Print all objects in the directory.
Longptr_t ProcessLine (const char *line, Int_t *error=nullptr)
 Process interpreter command via TApplication::ProcessLine().
Longptr_t ProcessLineFast (const char *line, Int_t *error=nullptr)
 Process interpreter command directly via CINT interpreter.
Longptr_t ProcessLineSync (const char *line, Int_t *error=nullptr)
 Process interpreter command via TApplication::ProcessLine().
virtual void Purge (Short_t=1)
virtual void pwd () const
 Print the path of the directory.
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
virtual void ReadAll (Option_t *="")
Bool_t ReadingObject () const
 Deprecated (will be removed in next release).
virtual Int_t ReadKeys (Bool_t=kTRUE)
virtual Int_t ReadTObject (TObject *, const char *)
void RecursiveRemove (TObject *obj) override
 Recursively remove this object from the list of Cleanups.
void RefreshBrowsers ()
 Refresh all browsers.
TObjectRemove (TObject *) override
 Remove an object from the in-memory list.
void RemoveClass (TClass *)
 Remove a class from the list and map of classes.
void Reset (Option_t *option="")
 Delete all global interpreter objects created since the last call to Reset.
void ResetBit (UInt_t f)
void ResetClassSaved ()
 Reset the ClassSaved status of all classes.
virtual void rmdir (const char *name)
 Removes subdirectory from the directory When directory is deleted, all keys in all subdirectories will be read first and deleted from file (if exists) Equivalent call is Delete("name;*");.
virtual void Save ()
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
void SaveContext ()
 Save the current interpreter context.
virtual Int_t SaveObjectAs (const TObject *, const char *="", Option_t *="") const
 Save object in filename, if filename is nullptr or "", a file with "<objectname>.root" is created.
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
virtual void SaveSelf (Bool_t=kFALSE)
void SetApplication (TApplication *app)
void SetBatch (Bool_t batch=kTRUE)
 Set batch mode for ROOT If the argument evaluates to true, the session does not use interactive graphics.
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 SetBufferSize (Int_t)
void SetCutClassName (const char *name="TCutG")
 Set the default graphical cut class name for the graphics editor By default the graphics editor creates an instance of a class TCutG.
void SetDefCanvasName (const char *name="c1")
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
void SetEditHistograms (Bool_t flag=kTRUE)
void SetEditorMode (const char *mode="")
 Set editor mode.
void SetEscape (Bool_t flag=kTRUE)
void SetExecutingMacro (Bool_t flag=kTRUE)
void SetFromPopUp (Bool_t flag=kTRUE)
void SetInterrupt (Bool_t flag=kTRUE)
void SetLineHasBeenProcessed ()
void SetLineIsProcessing ()
virtual void SetModified ()
virtual void SetMother (TObject *mother)
void SetMustClean (Bool_t flag=kTRUE)
void SetName (const char *newname) override
 Set the name for directory If the directory name is changed after the directory was written once, ROOT currently would NOT change the name of correspondent key in the mother directory.
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
void SetReadingObject (Bool_t flag=kTRUE)
virtual void SetSeekDir (Long64_t)
void SetSelectedPad (TVirtualPad *pad)
void SetSelectedPrimitive (const TObject *obj)
void SetStyle (const char *stylename="Default")
 Change current style to style with name stylename.
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
virtual void SetTRefAction (TObject *, TObject *)
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
void SetWebDisplay (const char *webdisplay="")
 Specify where web graphics shall be rendered.
virtual void SetWritable (Bool_t)
Int_t Sizeof () const override
 Return size of the TNamed part of the TObject.
void Streamer (TBuffer &) override
 TDirectory Streamer.
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
Bool_t TestBit (UInt_t f) const
Int_t TestBits (UInt_t f) const
void Time (Int_t casetime=1)
Int_t Timer () 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 *=nullptr, Int_t=0, Int_t=0) const override
 Write this object to the current directory.
virtual Int_t Write (const char *=nullptr, Int_t=0, Int_t=0) override
 Write this object to the current directory.
virtual void WriteDirHeader ()
virtual void WriteKeys ()
template<typename T>
std::enable_if_t< std::is_base_of< TObject, T >::value, Int_tWriteObject (const T *obj, const char *name, Option_t *option="", Int_t bufsize=0)
 Write an object with proper type checking.
template<typename T>
std::enable_if_t<!std::is_base_of< TObject, T >::value, Int_tWriteObject (const T *obj, const char *name, Option_t *option="", Int_t bufsize=0)
 Write an object with proper type checking.
virtual Int_t WriteObjectAny (const void *, const char *, const char *, Option_t *="", Int_t=0)
virtual Int_t WriteObjectAny (const void *, const TClass *, const char *, Option_t *="", Int_t=0)
virtual Int_t WriteTObject (const TObject *obj, const char *name=nullptr, Option_t *="", Int_t=0)

Static Public Member Functions

static void _R__DEPRECATED_ ("will be removed in ROOT v" "7" "." "00" ": " "This function has no effect on ROOT") AddDirectory(Bool_t add
static Bool_t _R__DEPRECATED_ ("will be removed in ROOT v" "7" "." "00" ": " "This function has no effect on ROOT") AddDirectoryStatus()
static const std::vector< std::string > & AddExtraInterpreterArgs (const std::vector< std::string > &args)
 Provide command line arguments to the interpreter construction.
static Bool_t Cd (const char *path)
static TClassClass ()
static const char * Class_Name ()
static constexpr Version_t Class_Version ()
static Int_t ConvertVersionCode2Int (Int_t code)
 Convert version code to an integer, i.e. 331527 -> 51507.
static Int_t ConvertVersionInt2Code (Int_t v)
 Convert version as an integer to version code as used in RVersion.h.
static std::atomic< TDirectory * > & CurrentDirectory ()
 Return the current directory for the current thread.
static const char * DeclFileName ()
static size_t DecodeNameCycle (const char *namecycle, char *name, Short_t &cycle, const size_t namesize=0)
static Int_t DecreaseDirLevel ()
 Decrease the indentation level for ls().
static const TStringGetBinDir ()
 Get the binary directory in the installation. Static utility function.
static const TStringGetDataDir ()
 Get the data directory in the installation. Static utility function.
static Int_t GetDirLevel ()
 return directory level
static const TStringGetDocDir ()
 Get the documentation directory in the installation. Static utility function.
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
static const TStringGetEtcDir ()
 Get the sysconfig directory in the installation. Static utility function.
static const char **& GetExtraInterpreterArgs ()
 INTERNAL function!
static const TStringGetIncludeDir ()
 Get the include directory in the installation. Static utility function.
static const TStringGetLibDir ()
 Get the library directory in the installation.
static const TStringGetMacroDir ()
 Get the macro directory in the installation. Static utility function.
static const char * GetMacroPath ()
 Get macro search path. Static utility function.
static Bool_t GetObjectStat ()
 Get status of object stat flag.
static const TStringGetRootSys ()
 Get the rootsys directory in the installation. Static utility function.
static const TStringGetSharedLibDir ()
 Get the shared libraries directory in the installation.
static const TStringGetTutorialDir ()
 Get the tutorials directory in the installation. Static utility function.
static Int_t IncreaseDirLevel ()
 Increase the indentation level for ls().
static void IndentLevel ()
 Functions used by ls() to indent an object hierarchy.
static void Initialize ()
 Initialize ROOT explicitly.
static Bool_t Initialized ()
 Return kTRUE if the TROOT object has been initialized.
static void RegisterModule (const char *modulename, const char **headers, const char **includePaths, const char *payLoadCode, const char *fwdDeclCode, void(*triggerFunc)(), const FwdDeclArgsToKeepCollection_t &fwdDeclsArgToSkip, const char **classesHeaders, bool hasCxxModule=false)
 Called by static dictionary initialization to register clang modules for headers.
static Int_t RootVersionCode ()
 Return ROOT version code as defined in RVersion.h.
static void SetDirLevel (Int_t level=0)
 Return Indentation level for ls().
static void SetDtorOnly (void *obj)
 Set destructor only flag.
static void SetMacroPath (const char *newpath)
 Set or extend the macro search path.
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.

Protected Types

enum  { kOnlyPrepStep = (1ULL << (3)) }
typedef std::atomic< TListOfEnums * > AListOfEnums_t
using SharedGDirectory_t = std::shared_ptr<std::atomic<TDirectory *>>

Protected Member Functions

 TROOT ()
 Only used by Dictionary.
void BuildDirectory (TFile *motherFile, TDirectory *motherDir)
 Initialise directory to defaults.
Bool_t cd1 (const char *path)
 Change current directory to "this" directory or to the directory described by the path if given one.
void CleanTargets ()
 Clean the pointers to this object (gDirectory, TContext, etc.).
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
void FillFullPath (TString &buf) const
 Recursive method to fill full path for directory.
TListOfFunctionsGetGlobalFunctions ()
 Internal routine returning, and creating if necessary, the list of global function.
void InitInterpreter ()
 Initialize interpreter (cling).
void InitSystem ()
 Operating System interface.
void InitThreads ()
 Initialize threads library.
void MakeZombie ()
void * operator new (size_t l)
void * operator new (size_t l, void *ptr)
void ReadGitInfo ()
 Read Git commit SHA1 and branch name.
void RegisterContext (TContext *ctxt)
void RegisterGDirectory (SharedGDirectory_t &ptr)
void SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
 Save object name and title into the output stream "out".
void UnregisterContext (TContext *ctxt)
 UnRegister a TContext pointing to this TDirectory object.

Static Protected Member Functions

static Bool_t Cd1 (const char *path)
 Change current directory to "path".
static SharedGDirectory_tGetSharedLocalCurrentDirectory ()
 Return the (address of) a shared pointer to the struct holding the actual thread local gDirectory pointer and the atomic_flag for its lock.
static void SavePrimitiveConstructor (std::ostream &out, TClass *cl, const char *variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
 Save object constructor in the output stream "out".
static void SavePrimitiveDraw (std::ostream &out, const char *variable_name, Option_t *option=nullptr)
 Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
static TString SavePrimitiveVector (std::ostream &out, const char *prefix, Int_t len, Double_t *arr, Int_t flag=0)
 Save array in the output stream "out" as vector.

Protected Attributes

std::atomic< TApplication * > fApplication = nullptr
 Pointer to current application.
Bool_t fBatch = true
 True if session without graphics.
TListfBrowsables = nullptr
 List of browsables.
TSeqCollectionfBrowsers = nullptr
 List of browsers.
Int_t fBuiltDate = 0
 Date of ROOT built.
Int_t fBuiltTime = 0
 Time of ROOT built.
TSeqCollectionfCanvases = nullptr
 List of canvases.
TCollectionfClasses = nullptr
 List of classes definition.
TCollectionfClassGenerators = nullptr
 List of user defined class generators;.
TSeqCollectionfCleanups = nullptr
 List of recursiveRemove collections.
TSeqCollectionfClipboard = nullptr
 List of clipboard objects.
TSeqCollectionfClosedObjects = nullptr
 List of closed objects from the list of files and sockets, so we can delete them if neededCl.
TSeqCollectionfColors = nullptr
 List of colors.
TString fConfigFeatures
 ROOT ./configure detected build features.
TString fConfigOptions
 ROOT ./configure set build options.
TContextfContext {nullptr}
 ! Pointer to a list of TContext object pointing to this TDirectory
std::atomic< size_t > fContextPeg {0}
 ! Counter delaying the TDirectory destructor from finishing.
TString fCutClassName
 Name of default CutG class in graphics editor.
TSeqCollectionfDataSets = nullptr
 List of data sets (TDSet or TChain).
TString fDefCanvasName
 Name of default canvas.
Bool_t fEditHistograms = true
 True if histograms can be edited with the mouse.
Int_t fEditorMode = 0
 Current Editor mode.
AListOfEnums_t fEnums = nullptr
 List of enum types.
Bool_t fEscape = false
 True if ESC has been pressed.
Bool_t fExecutingMacro = false
 True while executing a TMacro.
TSeqCollectionfFiles = nullptr
 List of files.
Bool_t fForceStyle = false
 Force setting of current style when reading objects.
Bool_t fFromPopUp = true
 True if command executed from a popup menu.
TListOfFunctionTemplatesfFuncTemplate = nullptr
 List of global function templates.
TCollectionfFunctions = nullptr
 List of analytic functions.
std::vector< SharedGDirectory_tfGDirectories
 ! thread local gDirectory pointing to this object.
TSeqCollectionfGeometries = nullptr
 List of geometries.
TString fGitBranch
 Git branch.
TString fGitCommit
 Git commit SHA1 of built.
TString fGitDate
 Date and time when make was run.
TListOfFunctionsfGlobalFunctions = nullptr
 List of global functions.
TListOfDataMembersfGlobals = nullptr
 List of global variables.
TInterpreterfInterpreter = nullptr
 Command interpreter.
Bool_t fInterrupt = false
 True if macro should be interrupted.
Bool_t fIsWebDisplay = false
 True if session uses web widgets.
Bool_t fIsWebDisplayBatch = false
 True if web widgets are not displayed.
TListfList {nullptr}
 List of objects in memory.
TSeqCollectionfMappedFiles = nullptr
 List of memory mapped files.
TSeqCollectionfMessageHandlers = nullptr
 List of message handlers.
TObjectfMother {nullptr}
 pointer to mother of the directory
Bool_t fMustClean = true
 True if object destructor scans canvases.
TString fName
TString fPathBuffer
 ! Buffer for GetPath() function
TPluginManagerfPluginManager = nullptr
 Keeps track of plugin library handlers.
const TObjectfPrimitive = nullptr
 Currently selected primitive.
TFolderfRootFolder = nullptr
 top level folder //root
TVirtualPadfSelectPad = nullptr
 Currently selected pad.
TSeqCollectionfSockets = nullptr
 List of network sockets.
TSeqCollectionfSpecials = nullptr
 List of special objects.
std::atomic_flag fSpinLock
 ! MSVC doesn't support = ATOMIC_FLAG_INIT;
TSeqCollectionfStreamerInfo = nullptr
 List of active StreamerInfo classes.
TSeqCollectionfStyles = nullptr
 List of styles.
TSeqCollectionfTasks = nullptr
 List of tasks.
Int_t fTimer = 0
 Timer flag.
TString fTitle
TCollectionfTypes = nullptr
 List of data types definition.
TUUID fUUID {TUUID::UUIDv4()}
 Unique identifier.
TProcessUUIDfUUIDs = nullptr
 Pointer to TProcessID managing TUUIDs.
TString fVersion
 ROOT version as TString, example: 0.05.01.
Int_t fVersionCode = 0
 ROOT version code as used in RVersion.h.
Int_t fVersionDate = 0
 Date of ROOT version (ex 951226).
Int_t fVersionInt = 0
 ROOT version in integer format (501).
Int_t fVersionTime = 0
 Time of ROOT version (ex 1152).
TString fWebDisplay
 If not empty it defines where web graphics should be rendered (cef, qt6, browser...).

Static Protected Attributes

static Bool_t fgAddDirectory = false
 !

Private Member Functions

 TROOT (const TROOT &)=delete
TROOToperator= (const TROOT &)=delete

Static Private Member Functions

static void AddToTObjectTable (TObject *)
 Private helper function which will dispatch to TObjectTable::AddObj.

Private Attributes

UInt_t fBits
 bit field status word
Int_t fLineIsProcessing = 0
 To synchronize multi-threads.
UInt_t fUniqueID
 object unique identifier

Static Private Attributes

static Int_t fgDirLevel = 0
 Indentation level for ls().
static Longptr_t fgDtorOnly = 0
 object for which to call dtor only (i.e. no delete)
static Bool_t fgObjectStat = kTRUE
 if true keep track of objects in TObjectTable
static Bool_t fgRootInit = kFALSE
 Singleton initialization flag.

Friends

class ::ROOT::Internal::TROOTAllocator
TROOTROOT::Internal::GetROOT2 ()
class TCling

#include <TROOT.h>

Inheritance diagram for TROOT:
TDirectory TNamed TObject

Member Typedef Documentation

◆ AListOfEnums_t

typedef std::atomic<TListOfEnums*> TROOT::AListOfEnums_t
protected

Definition at line 122 of file TROOT.h.

◆ FwdDeclArgsToKeepCollection_t

typedef std::vector<std::pair<std::string, int> > TROOT::FwdDeclArgsToKeepCollection_t

Definition at line 198 of file TROOT.h.

◆ SharedGDirectory_t

using TDirectory::SharedGDirectory_t = std::shared_ptr<std::atomic<TDirectory *>>
protectedinherited

Definition at line 147 of file TDirectory.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
kOnlyPrepStep 

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer.

This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kSingleKey 

write collection with single key

kOverwrite 

overwrite existing object with same name

kWriteDelete 

write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kIsOnHeap 

object is on heap

kNotDeleted 

object has not been deleted

kZombie 

object ctor failed

kInconsistent 

class overload Hash but does call RecursiveRemove in destructor

kBitMask 

Definition at line 89 of file TObject.h.

◆ EDeprecatedStatusBits

Enumerator
kObjInCanvas 

for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ EStatusBits

enum TObject::EStatusBits
inherited
Enumerator
kCanDelete 

if object in a list can be deleted

kMustCleanup 

if object destructor must call RecursiveRemove()

kIsReferenced 

if object is referenced by a TRef or TRefArray

kHasUUID 

if object has a TUUID (its fUniqueID=UUIDNumber)

kCannotPick 

if object in a pad cannot be picked

kNoContextMenu 

if object does not want context menu

kInvalidObject 

if object ctor succeeded but object should not be used

Definition at line 70 of file TObject.h.

Constructor & Destructor Documentation

◆ TROOT() [1/3]

TROOT::TROOT ( const TROOT & )
privatedelete

◆ TROOT() [2/3]

TROOT::TROOT ( )
protected

Only used by Dictionary.

Default ctor.

Definition at line 784 of file TROOT.cxx.

◆ TROOT() [3/3]

TROOT::TROOT ( const char * name,
const char * title,
VoidFuncPtr_t * initfunc = nullptr )

Initialize the ROOT system.

The creation of the TROOT object initializes the ROOT system. It must be the first ROOT related action that is performed by a program. The TROOT object must be created on the stack (can not be called via new since "operator new" is protected). The TROOT object is either created as a global object (outside the main() program), or it is one of the first objects created in main(). Make sure that the TROOT object stays in scope for as long as ROOT related actions are performed. TROOT is a so called singleton so only one instance of it can be created. The single TROOT object can always be accessed via the global pointer gROOT. The name and title arguments can be used to identify the running application. The initfunc argument can contain an array of function pointers (last element must be 0). These functions are executed at the end of the constructor. This way one can easily extend the ROOT system without adding permanent dependencies (e.g. the graphics system is initialized via such a function).

Definition at line 804 of file TROOT.cxx.

◆ ~TROOT()

TROOT::~TROOT ( )
virtual

Clean up and free resources used by ROOT (files, network sockets, shared memory segments, etc.).

Definition at line 1017 of file TROOT.cxx.

Member Function Documentation

◆ _R__DEPRECATED_() [1/2]

void TDirectory::_R__DEPRECATED_ ( "will be removed in ROOT v" "7" "." "00" ": " "This function has no effect on ROOT" )
staticinherited

◆ _R__DEPRECATED_() [2/2]

Bool_t TDirectory::_R__DEPRECATED_ ( "will be removed in ROOT v" "7" "." "00" ": " "This function has no effect on ROOT" )
staticinherited

◆ AbstractMethod()

void TObject::AbstractMethod ( const char * method) const
inherited

Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning
This interface is a legacy function that is no longer recommended to be used by new development code.
Note
The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

◆ Add()

virtual void TDirectory::Add ( TObject * obj,
Bool_t replace = kFALSE )
inlinevirtualinherited

Append object to this directory.

See also
Append(TObject*, Bool_t)

Reimplemented in RooWorkspace::WSDir, and TDirectoryFile.

Definition at line 184 of file TDirectory.h.

◆ AddClass()

void TROOT::AddClass ( TClass * cl)

Add a class to the list and map of classes.

This routine is deprecated, use TClass::AddClass directly.

Definition at line 1172 of file TROOT.cxx.

◆ AddClassGenerator()

void TROOT::AddClassGenerator ( TClassGenerator * generator)

Add a class generator.

This generator will be called by TClass::GetClass in case its does not find a loaded rootcint dictionary to request the creation of a TClass object.

Definition at line 1182 of file TROOT.cxx.

◆ AddExtraInterpreterArgs()

const std::vector< std::string > & TROOT::AddExtraInterpreterArgs ( const std::vector< std::string > & args)
static

Provide command line arguments to the interpreter construction.

These arguments are added to the existing flags (e.g. -DNDEBUG). They are evaluated once per process, at the time where TROOT (and thus TInterpreter) is constructed. Returns the new flags.

Definition at line 3113 of file TROOT.cxx.

◆ AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op)
staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

◆ Append()

void TROOT::Append ( TObject * obj,
Bool_t replace = kFALSE )
overridevirtual

Append object to this directory.

If replace is true: remove any existing objects with the same same (if the name is not "")

Reimplemented from TDirectory.

Definition at line 1194 of file TROOT.cxx.

◆ AppendKey()

virtual Int_t TDirectory::AppendKey ( TKey * )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 185 of file TDirectory.h.

◆ AppendPad()

void TObject::AppendPad ( Option_t * option = "")
virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

◆ Browse()

void TROOT::Browse ( TBrowser * b)
overridevirtual

Add browsable objects to TBrowser.

Reimplemented from TDirectory.

Definition at line 1203 of file TROOT.cxx.

◆ Build()

virtual void TDirectory::Build ( TFile * motherFile = nullptr,
TDirectory * motherDir = nullptr )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 187 of file TDirectory.h.

◆ BuildDirectory()

void TDirectory::BuildDirectory ( TFile * motherFile,
TDirectory * motherDir )
protectedinherited

Initialise directory to defaults.

If directory is created via default ctor (when dir is read from file) don't add it here to the directory since its name is not yet known. It will be added to the directory in TKey::ReadObj().

Definition at line 255 of file TDirectory.cxx.

◆ Cd()

Bool_t TDirectory::Cd ( const char * path)
staticinherited

◆ cd() [1/2]

Bool_t TDirectory::cd ( )
virtualinherited

Change current directory to "this" directory.

Returns kTRUE (it's guaranteed to succeed).

Reimplemented in TDirectoryFile.

Definition at line 544 of file TDirectory.cxx.

◆ cd() [2/2]

Bool_t TDirectory::cd ( const char * path)
virtualinherited

Change current directory to "this" directory or to the directory described by the path if given one.

Using path one can change the current directory to "path". The absolute path syntax is: file.root:/dir1/dir2 where file.root is the file and /dir1/dir2 the desired subdirectory in the file.

Relative syntax is relative to "this" directory. E.g: ../aa.

Returns kTRUE in case of success.

Reimplemented in TDirectoryFile.

Definition at line 568 of file TDirectory.cxx.

◆ Cd1()

Bool_t TDirectory::Cd1 ( const char * apath)
staticprotectedinherited

Change current directory to "path".

The absolute path syntax is: file.root:/dir1/dir2 where file.root is the file and /dir1/dir2 the desired subdirectory in the file. Relative syntax is relative to the current directory gDirectory, e.g.: ../aa`.

Returns kTRUE in case of success. */

Bool_t TDirectory::Cd(const char *path) { return Cd1(path); }

/** Change current directory to "path". The path syntax is: file.root:/dir1/dir2 where file.root is the file and /dir1/dir2 the desired subdirectory in the file. Relative syntax is relative to the current directory gDirectory, e.g.: ../aa.

Returns kFALSE in case path does not exist.

Definition at line 623 of file TDirectory.cxx.

◆ cd1()

Bool_t TDirectory::cd1 ( const char * apath)
protectedinherited

Change current directory to "this" directory or to the directory described by the path if given one.

Using path one can change the current directory to "path". The absolute path syntax is: file.root:/dir1/dir2 where file.root is the file and /dir1/dir2 the desired subdirectory in the file.

Relative syntax is relative to "this" directory. E.g: ../aa.

Returns kFALSE in case path does not exist.

Definition at line 587 of file TDirectory.cxx.

◆ CheckedHash()

ULong_t TObject::CheckedHash ( )
inlineinherited

Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

◆ Class()

TClass * TDirectory::Class ( )
staticinherited
Returns
TClass describing this class

◆ Class_Name()

const char * TDirectory::Class_Name ( )
staticinherited
Returns
Name of this class

◆ Class_Version()

constexpr Version_t TDirectory::Class_Version ( )
inlinestaticconstexprinherited
Returns
Version of this class

Definition at line 309 of file TDirectory.h.

◆ ClassName()

const char * TObject::ClassName ( ) const
virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

◆ ClassSaved()

Bool_t TROOT::ClassSaved ( TClass * cl)

return class status 'ClassSaved' for class cl This function is called by the SavePrimitive functions writing the C++ code for an object.

Definition at line 1230 of file TROOT.cxx.

◆ CleanTargets()

void TDirectory::CleanTargets ( )
protectedinherited

Clean the pointers to this object (gDirectory, TContext, etc.).

Definition at line 270 of file TDirectory.cxx.

◆ Clear()

void TDirectory::Clear ( Option_t * option = "")
overridevirtualinherited

Delete all objects from a Directory list.

Reimplemented from TObject.

Definition at line 640 of file TDirectory.cxx.

◆ Clone()

TObject * TNamed::Clone ( const char * newname = "") const
overridevirtualinherited

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TObject.

Reimplemented in TStreamerInfo, and TTreeIndex.

Definition at line 73 of file TNamed.cxx.

◆ CloneObject()

TObject * TDirectory::CloneObject ( const TObject * obj,
Bool_t autoadd = kTRUE )
virtualinherited

Clone an object.

This function is called when the directory is not a TDirectoryFile. This version has to load the I/O package, hence via Cling.

If autoadd is true and if the object class has a DirectoryAutoAdd function, it will be called at the end of the function with the parameter gDirectory. This usually means that the object will be appended to the current ROOT directory.

Reimplemented in TDirectoryFile.

Definition at line 370 of file TDirectory.cxx.

◆ Close()

void TDirectory::Close ( Option_t * option = "")
virtualinherited

Delete all objects from memory and directory structure itself.

if option is "slow", iterate through the containers in a way to can handle 'external' modification (induced by recursions) if option is "nodelete", write the TDirectory but do not delete the contained objects.

Reimplemented in TDirectoryFile, TFile, TParallelMergingFile, TSQLFile, and TXMLFile.

Definition at line 651 of file TDirectory.cxx.

◆ CloseFiles()

void TROOT::CloseFiles ( )

Close any files and sockets that gROOT knows about.

This can be used to insures that the files and sockets are closed before any library is unloaded!

Definition at line 1315 of file TROOT.cxx.

◆ Compare()

Int_t TNamed::Compare ( const TObject * obj) const
overridevirtualinherited

Compare two TNamed objects.

Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp).

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 84 of file TNamed.cxx.

◆ ConvertVersionCode2Int()

Int_t TROOT::ConvertVersionCode2Int ( Int_t code)
static

Convert version code to an integer, i.e. 331527 -> 51507.

Definition at line 3083 of file TROOT.cxx.

◆ ConvertVersionInt2Code()

Int_t TROOT::ConvertVersionInt2Code ( Int_t v)
static

Convert version as an integer to version code as used in RVersion.h.

Definition at line 3091 of file TROOT.cxx.

◆ Copy()

void TDirectory::Copy ( TObject & object) const
inlineoverridevirtualinherited

Copy this to obj.

Reimplemented from TObject.

Reimplemented in TDirectoryFile, and TFile.

Definition at line 192 of file TDirectory.h.

◆ CurrentDirectory()

std::atomic< TDirectory * > & TDirectory::CurrentDirectory ( )
staticinherited

Return the current directory for the current thread.

Definition at line 438 of file TDirectory.cxx.

◆ DeclFileName()

const char * TDirectory::DeclFileName ( )
inlinestaticinherited
Returns
Name of the file containing the class declaration

Definition at line 309 of file TDirectory.h.

◆ DecodeNameCycle()

size_t TDirectory::DecodeNameCycle ( const char * namecycle,
char * name,
Short_t & cycle,
const size_t namesize = 0 )
staticinherited

◆ DecreaseDirLevel()

Int_t TROOT::DecreaseDirLevel ( )
static

Decrease the indentation level for ls().

Definition at line 2901 of file TROOT.cxx.

◆ Delete()

void TDirectory::Delete ( const char * namecycle = "")
overridevirtualinherited

Delete Objects or/and keys in a directory.

  • namecycle has the format name;cycle
  • namecycle = "" same as namecycle ="T*"
  • name = * means all
  • cycle = * means all cycles (memory and keys)
  • cycle = "" or cycle = 9999 ==> apply to a memory object When name=* use T* to delete subdirectories also

To delete one directory, you must specify the directory cycle, eg. file.Delete("dir1;1");

examples:

  • foo : delete object named foo in memory
  • foo* : delete all objects with a name starting with foo
  • foo;1 : delete cycle 1 of foo on file
  • foo;* : delete all cycles of foo on file and also from memory
  • ;2 : delete all objects on file having the cycle 2
  • *; : delete all objects from memory and file
  • T*;* : delete all objects from memory and file and all subdirectories

Reimplemented from TObject.

Reimplemented in TDirectoryFile, and TFile.

Definition at line 718 of file TDirectory.cxx.

◆ DeleteAll()

void TDirectory::DeleteAll ( Option_t * option = "")
virtualinherited

Delete all objects from memory.

Definition at line 691 of file TDirectory.cxx.

◆ DistancetoPrimitive()

◆ DoError()

void TObject::DoError ( int level,
const char * location,
const char * fmt,
va_list va ) const
protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

◆ Draw()

void TDirectory::Draw ( Option_t * option = "")
overridevirtualinherited

Fill Graphics Structure and Paint.

Loop on all objects (memory or file) and all subdirectories

Reimplemented from TObject.

Reimplemented in TFile.

Definition at line 774 of file TDirectory.cxx.

◆ DrawClass()

void TObject::DrawClass ( ) const
virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 308 of file TObject.cxx.

◆ DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "") const
virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note
For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 319 of file TObject.cxx.

◆ Dump()

void TObject::Dump ( ) const
virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle 0 Arrow opening angle (degrees)
fArrowSize 0.2 Arrow Size
fOption.*fData
fX1 0.1 X of 1st point
fY1 0.15 Y of 1st point
fX2 0.67 X of 2nd point
fY2 0.83 Y of 2nd point
fUniqueID 0 object unique identifier
fBits 50331648 bit field status word
fLineColor 1 line color
fLineStyle 1 line style
fLineWidth 1 line width
fFillColor 19 fill area color
fFillStyle 1001 fill area style
#define X(type, name)
UInt_t fUniqueID
object unique identifier
Definition TObject.h:46
UInt_t fBits
bit field status word
Definition TObject.h:47
TLine * line
TCanvas * style()
Definition style.C:1

Reimplemented in TClass, TCollection, TGFrame, TGPack, and TSystemFile.

Definition at line 367 of file TObject.cxx.

◆ EndOfProcessCleanups()

void TROOT::EndOfProcessCleanups ( )

Execute the cleanups necessary at the end of the process, in particular those that must be executed before the library start being unloaded.

Definition at line 1395 of file TROOT.cxx.

◆ Error()

void TObject::Error ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

◆ Execute() [1/2]

void TObject::Execute ( const char * method,
const char * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 378 of file TObject.cxx.

◆ Execute() [2/2]

void TObject::Execute ( TMethod * method,
TObjArray * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters
Collectable string class.
Definition TObjString.h:28
const Int_t n
Definition legend1.C:16

Reimplemented in ROOT::R::TRInterface, TCling, TContextMenu, TInterpreter, and TMethodCall.

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

◆ Fatal()

void TObject::Fatal ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

◆ FillBuffer()

void TNamed::FillBuffer ( char *& buffer)
virtualinherited

Encode TNamed into output buffer.

Reimplemented in TDirectoryFile, TFile, TKey, TKeySQL, TKeyXML, TSQLFile, and TXMLFile.

Definition at line 103 of file TNamed.cxx.

◆ FillFullPath()

void TDirectory::FillFullPath ( TString & buf) const
protectedinherited

Recursive method to fill full path for directory.

Definition at line 1067 of file TDirectory.cxx.

◆ FindKey()

virtual TKey * TDirectory::FindKey ( const char * ) const
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 198 of file TDirectory.h.

◆ FindKeyAny()

virtual TKey * TDirectory::FindKeyAny ( const char * ) const
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 199 of file TDirectory.h.

◆ FindObject() [1/2]

TObject * TROOT::FindObject ( const char * name) const
overridevirtual

Returns address of a ROOT object if it exists.

If name contains at least one "/" the function calls FindObjectany else This function looks in the following order in the ROOT lists:

  • List of files
  • List of memory mapped files
  • List of functions
  • List of geometries
  • List of canvases
  • List of styles
  • List of specials
  • List of materials in current geometry
  • List of shapes in current geometry
  • List of matrices in current geometry
  • List of Nodes in current geometry
  • Current Directory in memory
  • Current Directory on file

Reimplemented from TDirectory.

Definition at line 1460 of file TROOT.cxx.

◆ FindObject() [2/2]

TObject * TROOT::FindObject ( const TObject * obj) const
overridevirtual

Find an object in one Root folder.

Reimplemented from TDirectory.

Definition at line 1434 of file TROOT.cxx.

◆ FindObjectAny()

TObject * TROOT::FindObjectAny ( const char * name) const
overridevirtual

Return a pointer to the first object with name starting at //root.

This function scans the list of all folders. if no object found in folders, it scans the memory list of all files.

Reimplemented from TDirectory.

Definition at line 1573 of file TROOT.cxx.

◆ FindObjectAnyFile()

TObject * TROOT::FindObjectAnyFile ( const char * name) const
overridevirtual

Scan the memory lists of all files for an object with name.

Reimplemented from TDirectory.

Definition at line 1583 of file TROOT.cxx.

◆ FindObjectClassName()

const char * TROOT::FindObjectClassName ( const char * name) const

Returns class name of a ROOT object including CINT globals.

Definition at line 1600 of file TROOT.cxx.

◆ FindObjectPathName()

const char * TROOT::FindObjectPathName ( const TObject * obj) const

Return path name of obj somewhere in the //root/... path.

The function returns the first occurrence of the object in the list of folders. The returned string points to a static char array in TROOT. If this function is called in a loop or recursively, it is the user's responsibility to copy this string in their area.

Definition at line 1620 of file TROOT.cxx.

◆ FindSpecialObject()

TObject * TROOT::FindSpecialObject ( const char * name,
void *& where )

Returns address and folder of a ROOT object if it exists.

This function looks in the following order in the ROOT lists:

  • List of files
  • List of memory mapped files
  • List of functions
  • List of geometries
  • List of canvases
  • List of styles
  • List of specials
  • List of materials in current geometry
  • List of shapes in current geometry
  • List of matrices in current geometry
  • List of Nodes in current geometry
  • Current Directory in memory
  • Current Directory on file

Definition at line 1514 of file TROOT.cxx.

◆ FindSTLClass()

TClass * TROOT::FindSTLClass ( const char * name,
Bool_t load,
Bool_t silent = kFALSE ) const

return a TClass object corresponding to 'name' assuming it is an STL container.

In particular we looking for possible alternative name (default template parameter, typedefs template arguments, typedefed name).

Definition at line 1631 of file TROOT.cxx.

◆ ForceStyle()

void TROOT::ForceStyle ( Bool_t force = kTRUE)
inline

Definition at line 217 of file TROOT.h.

◆ FromPopUp()

Bool_t TROOT::FromPopUp ( ) const
inline

Definition at line 218 of file TROOT.h.

◆ Get() [1/2]

template<class T>
T * TDirectory::Get ( const char * namecycle)
inlineinherited

See documentation of TDirectoryFile::Get(const char *namecycle).

Definition at line 206 of file TDirectory.h.

◆ Get() [2/2]

TObject * TDirectory::Get ( const char * namecycle)
virtualinherited

Return pointer to object identified by namecycle.

namecycle has the format name;cycle

  • name = * is illegal, cycle = * is illegal
  • cycle = "" or cycle = 9999 ==> apply to a memory object

examples:

  • foo : get object named foo in memory if object is not in memory, try with highest cycle from file
  • foo;1 : get cycle 1 of foo on file

The retrieved object should in principle derive from TObject. If not, the function TDirectory::GetObject should be called. However, this function will still work for a non-TObject, providing that the calling application cast the return type to the correct type (which is the actual type of the object).

NOTE:

The method GetObject offer better protection and avoid the need for any cast:

MyClass *obj;
directory->GetObject("some object",obj);
if (obj) { ... the object exist and inherits from MyClass ... }

VERY IMPORTANT NOTE:

In case the class of this object derives from TObject but not as a first inheritance, one must use dynamic_cast<>().

Example 1: Normal case:

class MyClass : public TObject, public AnotherClass
TObject()
TObject constructor.
Definition TObject.h:259

then on return, one can do:

MyClass *obj = (MyClass*)directory->Get("some object of MyClass");

Example 2: Special case:

class MyClass : public AnotherClass, public TObject

then on return, one must do:

MyClass *obj = dynamic_cast<MyClass*>(directory->Get("some object of MyClass"));

Of course, dynamic_cast<> can also be used in the example 1.

Reimplemented in TDirectoryFile, and TDirectoryFile.

Definition at line 872 of file TDirectory.cxx.

◆ GetApplication()

TApplication * TROOT::GetApplication ( ) const
inline

Definition at line 220 of file TROOT.h.

◆ GetBinDir()

const TString & TROOT::GetBinDir ( )
static

Get the binary directory in the installation. Static utility function.

Definition at line 3150 of file TROOT.cxx.

◆ GetBufferSize()

virtual Int_t TDirectory::GetBufferSize ( ) const
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 220 of file TDirectory.h.

◆ GetBuiltDate()

Int_t TROOT::GetBuiltDate ( ) const
inline

Definition at line 232 of file TROOT.h.

◆ GetBuiltTime()

Int_t TROOT::GetBuiltTime ( ) const
inline

Definition at line 233 of file TROOT.h.

◆ GetClass() [1/2]

TClass * TROOT::GetClass ( const char * name,
Bool_t load = kTRUE,
Bool_t silent = kFALSE ) const

Return pointer to class with name. Obsolete, use TClass::GetClass directly.

Definition at line 1665 of file TROOT.cxx.

◆ GetClass() [2/2]

TClass * TROOT::GetClass ( const std::type_info & typeinfo,
Bool_t load = kTRUE,
Bool_t silent = kFALSE ) const

Return pointer to class from its name.

Obsolete, use TClass::GetClass directly See TClass::GetClass

Definition at line 1675 of file TROOT.cxx.

◆ GetClipboard()

TSeqCollection * TROOT::GetClipboard ( ) const
inline

Definition at line 263 of file TROOT.h.

◆ GetColor()

TColor * TROOT::GetColor ( Int_t color) const

Return address of color with index color.

Definition at line 1683 of file TROOT.cxx.

◆ GetConfigFeatures()

const char * TROOT::GetConfigFeatures ( ) const
inline

Definition at line 226 of file TROOT.h.

◆ GetConfigOptions()

const char * TROOT::GetConfigOptions ( ) const
inline

Definition at line 225 of file TROOT.h.

◆ GetCutClassName()

const char * TROOT::GetCutClassName ( ) const
inline

Definition at line 227 of file TROOT.h.

◆ GetDataDir()

const TString & TROOT::GetDataDir ( )
static

Get the data directory in the installation. Static utility function.

Definition at line 3391 of file TROOT.cxx.

◆ GetDefCanvasName()

const char * TROOT::GetDefCanvasName ( ) const
inline

Definition at line 228 of file TROOT.h.

◆ GetDirectory()

TDirectory * TDirectory::GetDirectory ( const char * apath,
Bool_t printError = false,
const char * funcname = "GetDirectory" )
virtualinherited

Find a directory using apath.

It apath is null or empty, returns "this" directory. Otherwise use apath to find a directory. The absolute path syntax is: file.root:/dir1/dir2

where file.root is the file and /dir1/dir2 the desired subdirectory in the file. Relative syntax is relative to "this" directory. E.g: ../aa. Returns 0 in case path does not exist. If printError is true, use Error with 'funcname' to issue an error message.

Reimplemented in TDirectoryFile.

Definition at line 454 of file TDirectory.cxx.

◆ GetDirLevel()

Int_t TROOT::GetDirLevel ( )
static

return directory level

Definition at line 2909 of file TROOT.cxx.

◆ GetDocDir()

const TString & TROOT::GetDocDir ( )
static

Get the documentation directory in the installation. Static utility function.

Definition at line 3407 of file TROOT.cxx.

◆ GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const
virtualinherited

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

◆ GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )
staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

◆ GetEditHistograms()

Bool_t TROOT::GetEditHistograms ( ) const
inline

Definition at line 229 of file TROOT.h.

◆ GetEditorMode()

Int_t TROOT::GetEditorMode ( ) const
inline

Definition at line 230 of file TROOT.h.

◆ GetEtcDir()

const TString & TROOT::GetEtcDir ( )
static

Get the sysconfig directory in the installation. Static utility function.

Definition at line 3381 of file TROOT.cxx.

◆ GetExtraInterpreterArgs()

const char **& TROOT::GetExtraInterpreterArgs ( )
static

INTERNAL function!

Used by rootcling to inject interpreter arguments through a C-interface layer.

Definition at line 3123 of file TROOT.cxx.

◆ GetFile() [1/2]

TFile * TROOT::GetFile ( ) const
inlineoverridevirtual

Reimplemented from TDirectory.

Definition at line 269 of file TROOT.h.

◆ GetFile() [2/2]

TFile * TROOT::GetFile ( const char * name) const

Return pointer to file with name.

Definition at line 1717 of file TROOT.cxx.

◆ GetForceStyle()

Bool_t TROOT::GetForceStyle ( ) const
inline

Definition at line 231 of file TROOT.h.

◆ GetFunction()

TObject * TROOT::GetFunction ( const char * name) const

Return pointer to function with name.

Definition at line 1734 of file TROOT.cxx.

◆ GetFunctionTemplate()

TFunctionTemplate * TROOT::GetFunctionTemplate ( const char * name)

Definition at line 1765 of file TROOT.cxx.

◆ GetGeometry()

TObject * TROOT::GetGeometry ( const char * name) const

Return pointer to Geometry with name.

Definition at line 1894 of file TROOT.cxx.

◆ GetGitBranch()

const char * TROOT::GetGitBranch ( ) const
inline

Definition at line 235 of file TROOT.h.

◆ GetGitCommit()

const char * TROOT::GetGitCommit ( ) const
inline

Definition at line 234 of file TROOT.h.

◆ GetGitDate()

const char * TROOT::GetGitDate ( )

Return date/time make was run.

Definition at line 2627 of file TROOT.cxx.

◆ GetGlobal() [1/2]

TGlobal * TROOT::GetGlobal ( const char * name,
Bool_t load = kFALSE ) const

Return pointer to global variable by name.

If load is true force reading of all currently defined globals from CINT (more expensive).

Definition at line 1778 of file TROOT.cxx.

◆ GetGlobal() [2/2]

TGlobal * TROOT::GetGlobal ( const TObject * obj,
Bool_t load = kFALSE ) const

Return pointer to global variable with address addr.

Definition at line 1786 of file TROOT.cxx.

◆ GetGlobalFunction()

TFunction * TROOT::GetGlobalFunction ( const char * function,
const char * params = nullptr,
Bool_t load = kFALSE )

Return pointer to global function by name.

If params != 0 it will also resolve overloading other it returns the first name match. If params == 0 and load is true force reading of all currently defined global functions from Cling. The param string must be of the form: "3189,\"aap\",1.3".

Definition at line 1832 of file TROOT.cxx.

◆ GetGlobalFunctions()

TListOfFunctions * TROOT::GetGlobalFunctions ( )
protected

Internal routine returning, and creating if necessary, the list of global function.

Definition at line 1810 of file TROOT.cxx.

◆ GetGlobalFunctionWithPrototype()

TFunction * TROOT::GetGlobalFunctionWithPrototype ( const char * function,
const char * proto = nullptr,
Bool_t load = kFALSE )

Return pointer to global function by name.

If proto != 0 it will also resolve overloading. If load is true force reading of all currently defined global functions from CINT (more expensive). The proto string must be of the form: "int, char*, float".

Definition at line 1865 of file TROOT.cxx.

◆ GetIconName()

const char * TObject::GetIconName ( ) const
virtualinherited

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TASImage, TBranch, TBranchElement, TGeoVolume, TGMainFrame, TKey, TMethodBrowsable, TSystemFile, and TVirtualBranchBrowsable.

Definition at line 472 of file TObject.cxx.

◆ GetIncludeDir()

const TString & TROOT::GetIncludeDir ( )
static

Get the include directory in the installation. Static utility function.

Definition at line 3347 of file TROOT.cxx.

◆ GetInterpreter()

TInterpreter * TROOT::GetInterpreter ( ) const
inline

Definition at line 221 of file TROOT.h.

◆ GetKey()

virtual TKey * TDirectory::GetKey ( const char * ,
Short_t = 9999 ) const
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 222 of file TDirectory.h.

◆ GetLibDir()

const TString & TROOT::GetLibDir ( )
static

Get the library directory in the installation.

Static utility function.

By default, this is just an alias for TROOT::GetSharedLibDir(), which returns the directory containing the ROOT shared libraries.

On Windows, the behavior is different. In that case, this function doesn't return the directory of the shared libraries (like libCore.dll), but the import libraries, which are used at link time (like libCore.lib).

Definition at line 3178 of file TROOT.cxx.

◆ GetList()

virtual TList * TDirectory::GetList ( ) const
inlinevirtualinherited

Definition at line 223 of file TDirectory.h.

◆ GetListOfBrowsables()

TList * TROOT::GetListOfBrowsables ( ) const
inline

Definition at line 267 of file TROOT.h.

◆ GetListOfBrowsers()

TSeqCollection * TROOT::GetListOfBrowsers ( ) const
inline

Definition at line 256 of file TROOT.h.

◆ GetListOfCanvases()

TSeqCollection * TROOT::GetListOfCanvases ( ) const
inline

Definition at line 251 of file TROOT.h.

◆ GetListOfClasses()

TCollection * TROOT::GetListOfClasses ( ) const
inline

Definition at line 242 of file TROOT.h.

◆ GetListOfClassGenerators()

TCollection * TROOT::GetListOfClassGenerators ( ) const
inline

Definition at line 262 of file TROOT.h.

◆ GetListOfCleanups()

TSeqCollection * TROOT::GetListOfCleanups ( ) const
inline

Definition at line 259 of file TROOT.h.

◆ GetListOfClosedObjects()

TSeqCollection * TROOT::GetListOfClosedObjects ( ) const
inline

Definition at line 247 of file TROOT.h.

◆ GetListOfColors()

TSeqCollection * TROOT::GetListOfColors ( ) const
inline

Definition at line 243 of file TROOT.h.

◆ GetListOfDataSets()

TSeqCollection * TROOT::GetListOfDataSets ( ) const
inline

Definition at line 264 of file TROOT.h.

◆ GetListOfEnums()

TCollection * TROOT::GetListOfEnums ( Bool_t load = kFALSE)

Definition at line 1901 of file TROOT.cxx.

◆ GetListOfFiles()

TSeqCollection * TROOT::GetListOfFiles ( ) const
inline

Definition at line 248 of file TROOT.h.

◆ GetListOfFunctionOverloads()

TCollection * TROOT::GetListOfFunctionOverloads ( const char * name) const

Return the collection of functions named "name".

Definition at line 1819 of file TROOT.cxx.

◆ GetListOfFunctions()

TCollection * TROOT::GetListOfFunctions ( ) const
inline

Definition at line 253 of file TROOT.h.

◆ GetListOfFunctionTemplates()

TCollection * TROOT::GetListOfFunctionTemplates ( )

Definition at line 1918 of file TROOT.cxx.

◆ GetListOfGeometries()

TSeqCollection * TROOT::GetListOfGeometries ( ) const
inline

Definition at line 255 of file TROOT.h.

◆ GetListOfGlobalFunctions()

TCollection * TROOT::GetListOfGlobalFunctions ( Bool_t load = kFALSE)

Return list containing the TFunctions currently defined.

Since functions are created and deleted during execution of the program, we need to update the list of functions every time we execute this method. However, when calling this function in a (tight) loop where no interpreter symbols will be created you can set load=kFALSE (default).

Definition at line 1973 of file TROOT.cxx.

◆ GetListOfGlobals()

TCollection * TROOT::GetListOfGlobals ( Bool_t load = kFALSE)

Return list containing the TGlobals currently defined.

Since globals are created and deleted during execution of the program, we need to update the list of globals every time we execute this method. However, when calling this function in a (tight) loop where no interpreter symbols will be created you can set load=kFALSE (default).

Definition at line 1935 of file TROOT.cxx.

◆ GetListOfKeys()

virtual TList * TDirectory::GetListOfKeys ( ) const
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 224 of file TDirectory.h.

◆ GetListOfMappedFiles()

TSeqCollection * TROOT::GetListOfMappedFiles ( ) const
inline

Definition at line 249 of file TROOT.h.

◆ GetListOfMessageHandlers()

TSeqCollection * TROOT::GetListOfMessageHandlers ( ) const
inline

Definition at line 261 of file TROOT.h.

◆ GetListOfSockets()

TSeqCollection * TROOT::GetListOfSockets ( ) const
inline

Definition at line 250 of file TROOT.h.

◆ GetListOfSpecials()

TSeqCollection * TROOT::GetListOfSpecials ( ) const
inline

Definition at line 257 of file TROOT.h.

◆ GetListOfStreamerInfo()

TSeqCollection * TROOT::GetListOfStreamerInfo ( ) const
inline

Definition at line 260 of file TROOT.h.

◆ GetListOfStyles()

TSeqCollection * TROOT::GetListOfStyles ( ) const
inline

Definition at line 252 of file TROOT.h.

◆ GetListOfTasks()

TSeqCollection * TROOT::GetListOfTasks ( ) const
inline

Definition at line 258 of file TROOT.h.

◆ GetListOfTypes()

TCollection * TROOT::GetListOfTypes ( Bool_t load = kFALSE)

Return a dynamic list giving access to all TDataTypes (typedefs) currently defined.

The list is populated on demand. Calling

gROOT->GetListOfTypes()->FindObject(nameoftype);

will return the TDataType corresponding to 'nameoftype'. If the TDataType is not already in the list itself and the type does exist, a new TDataType will be created and added to the list.

Calling

gROOT->GetListOfTypes()->ls(); // or Print()

list only the typedefs that have been previously accessed through the list (plus the builtins types).

Definition at line 2012 of file TROOT.cxx.

◆ GetMacroDir()

const TString & TROOT::GetMacroDir ( )
static

Get the macro directory in the installation. Static utility function.

Definition at line 3423 of file TROOT.cxx.

◆ GetMacroPath()

const char * TROOT::GetMacroPath ( )
static

Get macro search path. Static utility function.

Definition at line 2917 of file TROOT.cxx.

◆ GetMother()

TObject * TDirectory::GetMother ( ) const
inlineinherited

Definition at line 225 of file TDirectory.h.

◆ GetMotherDir()

TDirectory * TDirectory::GetMotherDir ( ) const
inlineinherited

Definition at line 226 of file TDirectory.h.

◆ GetName()

const char * TNamed::GetName ( ) const
inlineoverridevirtualinherited

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 49 of file TNamed.h.

◆ GetNbytesKeys()

virtual Int_t TDirectory::GetNbytesKeys ( ) const
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 227 of file TDirectory.h.

◆ GetNclasses()

Int_t TROOT::GetNclasses ( ) const

Get number of classes.

Definition at line 2023 of file TROOT.cxx.

◆ GetNkeys()

virtual Int_t TDirectory::GetNkeys ( ) const
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 228 of file TDirectory.h.

◆ GetNtypes()

Int_t TROOT::GetNtypes ( ) const

Get number of types.

Definition at line 2031 of file TROOT.cxx.

◆ GetObject()

template<class T>
void TDirectory::GetObject ( const char * namecycle,
T *& ptr )
inlineinherited

Get an object with proper type checking.

If the object doesn't exist in the file or if the type doesn't match, a nullptr is returned. Also see TDirectory::Get().

Definition at line 213 of file TDirectory.h.

◆ GetObjectChecked() [1/2]

void * TDirectory::GetObjectChecked ( const char * namecycle,
const char * classname )
virtualinherited

See documentation of TDirectory::GetObjectCheck(const char *namecycle, const TClass *cl).

Reimplemented in TDirectoryFile.

Definition at line 935 of file TDirectory.cxx.

◆ GetObjectChecked() [2/2]

void * TDirectory::GetObjectChecked ( const char * namecycle,
const TClass * expectedClass )
virtualinherited

Return pointer to object identified by namecycle if and only if the actual object is a type suitable to be stored as a pointer to a "expectedClass" If expectedClass is null, no check is performed.

namecycle has the format name;cycle

  • name = * is illegal, cycle = * is illegal
  • cycle = "" or cycle = 9999 ==> apply to a memory object

VERY IMPORTANT NOTE:

The calling application must cast the returned pointer to the type described by the 2 arguments (i.e. cl):

MyClass *obj = (MyClass*)directory->GetObjectChecked("some object of MyClass","MyClass"));

Note: We recommend using the method TDirectory::GetObject:

MyClass *obj = nullptr;
directory->GetObject("some object inheriting from MyClass",obj);
if (obj) { ... we found what we are looking for ... }
static const char * what
Definition stlLoader.cc:5

Reimplemented in TDirectoryFile.

Definition at line 964 of file TDirectory.cxx.

◆ GetObjectInfo()

char * TObject::GetObjectInfo ( Int_t px,
Int_t py ) const
virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )
staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

◆ GetObjectUnchecked()

void * TDirectory::GetObjectUnchecked ( const char * namecycle)
virtualinherited

Return pointer to object identified by namecycle.

The returned object may or may not derive from TObject.

  • namecycle has the format name;cycle
  • name = * is illegal, cycle = * is illegal
  • cycle = "" or cycle = 9999 ==> apply to a memory object

VERY IMPORTANT NOTE:

The calling application must cast the returned object to the final type, e.g.

MyClass *obj = (MyClass*)directory->GetObject("some object of MyClass");

Reimplemented in TDirectoryFile.

Definition at line 927 of file TDirectory.cxx.

◆ GetOption()

virtual Option_t * TObject::GetOption ( ) const
inlinevirtualinherited

◆ GetPath()

const char * TDirectory::GetPath ( ) const
virtualinherited

Returns the full path of the directory.

E.g. file:/dir1/dir2. The returned path will be re-used by the next call to GetPath().

Definition at line 1054 of file TDirectory.cxx.

◆ GetPathStatic()

const char * TDirectory::GetPathStatic ( ) const
virtualinherited

Returns the full path of the directory.

E.g. file:/dir1/dir2. The returned path will be re-used by the next call to GetPath().

Definition at line 1016 of file TDirectory.cxx.

◆ GetPluginManager()

TPluginManager * TROOT::GetPluginManager ( ) const
inline

Definition at line 219 of file TROOT.h.

◆ GetRootFolder()

TFolder * TROOT::GetRootFolder ( ) const
inline

Definition at line 283 of file TROOT.h.

◆ GetRootSys()

const TString & TROOT::GetRootSys ( )
static

Get the rootsys directory in the installation. Static utility function.

Definition at line 3140 of file TROOT.cxx.

◆ GetSeekDir()

virtual Long64_t TDirectory::GetSeekDir ( ) const
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 229 of file TDirectory.h.

◆ GetSeekKeys()

virtual Long64_t TDirectory::GetSeekKeys ( ) const
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 231 of file TDirectory.h.

◆ GetSeekParent()

virtual Long64_t TDirectory::GetSeekParent ( ) const
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 230 of file TDirectory.h.

◆ GetSelectedPad()

TVirtualPad * TROOT::GetSelectedPad ( ) const
inline

Definition at line 280 of file TROOT.h.

◆ GetSelectedPrimitive()

const TObject * TROOT::GetSelectedPrimitive ( ) const
inline

Definition at line 279 of file TROOT.h.

◆ GetSharedLibDir()

const TString & TROOT::GetSharedLibDir ( )
static

Get the shared libraries directory in the installation.

Static utility function.

This function inspects the libraries currently loaded in the process to locate the ROOT Core library. Once found, it extracts and returns the directory containing that library. If the ROOT Core library was not found, it will return an empty string.

The result is cached in a static variable so the lookup is only performed once per process, and the implementation is platform-specific.

Returns
The directory path (as a TString) containing the ROOT shared libraries.

Definition at line 3208 of file TROOT.cxx.

◆ GetSharedLocalCurrentDirectory()

TDirectory::SharedGDirectory_t & TDirectory::GetSharedLocalCurrentDirectory ( )
staticprotectedinherited

Return the (address of) a shared pointer to the struct holding the actual thread local gDirectory pointer and the atomic_flag for its lock.

Definition at line 422 of file TDirectory.cxx.

◆ GetStyle()

TStyle * TROOT::GetStyle ( const char * name) const

Return pointer to style with name.

Definition at line 1726 of file TROOT.cxx.

◆ GetTitle()

const char * TNamed::GetTitle ( ) const
inlineoverridevirtualinherited

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented from TObject.

Definition at line 50 of file TNamed.h.

◆ GetTutorialDir()

const TString & TROOT::GetTutorialDir ( )
static

Get the tutorials directory in the installation. Static utility function.

Definition at line 3444 of file TROOT.cxx.

◆ GetType()

TDataType * TROOT::GetType ( const char * name,
Bool_t load = kFALSE ) const

Return pointer to type with name.

Definition at line 1709 of file TROOT.cxx.

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const
virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ GetUUID()

TUUID TDirectory::GetUUID ( ) const
inlineinherited

Definition at line 234 of file TDirectory.h.

◆ GetUUIDs()

TProcessUUID * TROOT::GetUUIDs ( ) const
inline

Definition at line 284 of file TROOT.h.

◆ GetVersion()

const char * TROOT::GetVersion ( ) const
inline

Definition at line 241 of file TROOT.h.

◆ GetVersionCode()

Int_t TROOT::GetVersionCode ( ) const
inline

Definition at line 240 of file TROOT.h.

◆ GetVersionDate()

Int_t TROOT::GetVersionDate ( ) const
inline

Definition at line 237 of file TROOT.h.

◆ GetVersionInt()

Int_t TROOT::GetVersionInt ( ) const
inline

Definition at line 239 of file TROOT.h.

◆ GetVersionTime()

Int_t TROOT::GetVersionTime ( ) const
inline

Definition at line 238 of file TROOT.h.

◆ GetWebDisplay()

const TString & TROOT::GetWebDisplay ( ) const
inline

Definition at line 285 of file TROOT.h.

◆ HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer)
virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

◆ Hash()

ULong_t TNamed::Hash ( ) const
inlineoverridevirtualinherited

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:406

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 TNamed.h:51
virtual void Error(const char *method, const char *msgfmt,...) const
Issue error message.
Definition TObject.cxx:1098
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2651

Reimplemented from TObject.

Definition at line 51 of file TNamed.h.

◆ HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const
inlineinherited

Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

◆ Idle()

void TROOT::Idle ( UInt_t idleTimeInSec,
const char * command = nullptr )

Execute command when system has been idle for idleTimeInSec seconds.

Definition at line 2039 of file TROOT.cxx.

◆ IgnoreInclude()

Int_t TROOT::IgnoreInclude ( const char * fname,
const char * expandedfname )

Return 1 if the name of the given include file corresponds to a class that is known to ROOT, e.g.

"TLorentzVector.h" versus TLorentzVector.

Definition at line 2075 of file TROOT.cxx.

◆ IncreaseDirLevel()

Int_t TROOT::IncreaseDirLevel ( )
static

Increase the indentation level for ls().

Definition at line 3044 of file TROOT.cxx.

◆ IndentLevel()

void TROOT::IndentLevel ( )
static

Functions used by ls() to indent an object hierarchy.

Definition at line 3052 of file TROOT.cxx.

◆ Info()

void TObject::Info ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

◆ InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname) const
virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

◆ InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl) const
virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

◆ Initialize()

void TROOT::Initialize ( )
static

Initialize ROOT explicitly.

Definition at line 3060 of file TROOT.cxx.

◆ Initialized()

Bool_t TROOT::Initialized ( )
static

Return kTRUE if the TROOT object has been initialized.

Definition at line 3067 of file TROOT.cxx.

◆ InitInterpreter()

void TROOT::InitInterpreter ( )
protected

Initialize interpreter (cling).

Initialize the interpreter.

Should be called only after main(), to make sure LLVM/Clang is fully initialized. This function must be called in a single thread context (static initialization)

Definition at line 2214 of file TROOT.cxx.

◆ InitSystem()

void TROOT::InitSystem ( )
protected

Operating System interface.

Initialize operating system interface.

Definition at line 2125 of file TROOT.cxx.

◆ InitThreads()

void TROOT::InitThreads ( )
protected

Initialize threads library.

Load and initialize thread library.

Definition at line 2202 of file TROOT.cxx.

◆ Inspect()

void TObject::Inspect ( ) const
virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.

Definition at line 570 of file TObject.cxx.

◆ InvertBit()

void TObject::InvertBit ( UInt_t f)
inlineinherited

Definition at line 206 of file TObject.h.

◆ IsA()

TClass * TDirectory::IsA ( ) const
inlineoverridevirtualinherited
Returns
TClass describing current object

Reimplemented from TObject.

Reimplemented in RooWorkspace::WSDir, TDirectoryFile, TFile, TMemFile, TNetXNGFile, TParallelMergingFile, TSQLFile, and TXMLFile.

Definition at line 309 of file TDirectory.h.

◆ IsBatch()

Bool_t TROOT::IsBatch ( ) const
inline

Definition at line 288 of file TROOT.h.

◆ IsBuilt()

Bool_t TDirectory::IsBuilt ( ) const
inlineinherited

Definition at line 235 of file TDirectory.h.

◆ IsDestructed()

Bool_t TObject::IsDestructed ( ) const
inlineinherited

IsDestructed.

Note
This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).
Returns
true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

◆ IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj) const
virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

◆ IsEscaped()

Bool_t TROOT::IsEscaped ( ) const
inline

Definition at line 292 of file TROOT.h.

◆ IsExecutingMacro()

Bool_t TROOT::IsExecutingMacro ( ) const
inline

Definition at line 289 of file TROOT.h.

◆ IsFolder()

Bool_t TROOT::IsFolder ( ) const
inlineoverridevirtual

Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

Reimplemented from TDirectory.

Definition at line 290 of file TROOT.h.

◆ IsInterrupted()

Bool_t TROOT::IsInterrupted ( ) const
inline

Definition at line 291 of file TROOT.h.

◆ IsLineProcessing()

Bool_t TROOT::IsLineProcessing ( ) const
inline

Definition at line 293 of file TROOT.h.

◆ IsModified()

virtual Bool_t TDirectory::IsModified ( ) const
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 237 of file TDirectory.h.

◆ IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const
inlineinherited

Definition at line 160 of file TObject.h.

◆ IsRootFile()

Bool_t TROOT::IsRootFile ( const char * filename) const

Return true if the file is local and is (likely) to be a ROOT file.

Definition at line 2383 of file TROOT.cxx.

◆ IsSortable()

Bool_t TNamed::IsSortable ( ) const
inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

◆ IsWebDisplay()

Bool_t TROOT::IsWebDisplay ( ) const
inline

Definition at line 295 of file TROOT.h.

◆ IsWebDisplayBatch()

Bool_t TROOT::IsWebDisplayBatch ( ) const
inline

Definition at line 296 of file TROOT.h.

◆ IsWritable()

virtual Bool_t TDirectory::IsWritable ( ) const
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 238 of file TDirectory.h.

◆ IsZombie()

Bool_t TObject::IsZombie ( ) const
inlineinherited

Definition at line 161 of file TObject.h.

◆ LoadClass() [1/2]

Int_t TROOT::LoadClass ( const char * classname,
const char * libname,
Bool_t check = kFALSE )

Check if class "classname" is known to the interpreter (in fact, this check is not needed anymore, so classname is ignored).

If not it will load library "libname". If the library couldn't be found with original libname and if the name was not prefixed with lib, try to prefix with "lib" and search again. If DynamicPathName still couldn't find the library, return -1. If check is true it will only check if libname exists and is readable. Returns 0 on successful loading, -1 in case libname does not exist or in case of error and -2 in case of version mismatch.

Definition at line 2333 of file TROOT.cxx.

◆ LoadClass() [2/2]

TClass * TROOT::LoadClass ( const char * requestedname,
Bool_t silent = kFALSE ) const

Helper function used by TClass::GetClass().

This function attempts to load the dictionary for 'classname' either from the TClassTable or from the list of generator. If silent is 'true', do not warn about missing dictionary for the class. (typically used for class that are used only for transient members)

The 'requestedname' is expected to be already normalized.

Definition at line 2317 of file TROOT.cxx.

◆ LoadMacro()

Int_t TROOT::LoadMacro ( const char * filename,
Int_t * error = nullptr,
Bool_t check = kFALSE )

Load a macro in the interpreter's memory.

Equivalent to the command line command ".L filename". If the filename has "+" or "++" appended the macro will be compiled by ACLiC. The filename must have the format: [path/]macro.C[+|++[g|O]]. The possible error codes are defined by TInterpreter::EErrorCode. If check is true it will only check if filename exists and is readable. Returns 0 on successful loading and -1 in case filename does not exist or in case of error.

Definition at line 2421 of file TROOT.cxx.

◆ ls()

void TROOT::ls ( Option_t * option = "") const
overridevirtual

To list all objects of the application.

Loop on all objects created in the ROOT linked lists. Objects may be files and windows or any other object directly attached to the ROOT linked list.

Reimplemented from TDirectory.

Definition at line 2403 of file TROOT.cxx.

◆ Macro()

Longptr_t TROOT::Macro ( const char * filename,
Int_t * error = nullptr,
Bool_t padUpdate = kTRUE )

Execute a macro in the interpreter.

Equivalent to the command line command ".x filename". If the filename has "+" or "++" appended the macro will be compiled by ACLiC. The filename must have the format: [path/]macro.C[+|++[g|O]][(args)]. The possible error codes are defined by TInterpreter::EErrorCode. If padUpdate is true (default) update the current pad. Returns the macro return value.

Definition at line 2469 of file TROOT.cxx.

◆ MakeDefCanvas()

TCanvas * TROOT::MakeDefCanvas ( ) const

Return a default canvas.

Definition at line 1701 of file TROOT.cxx.

◆ MakeZombie()

void TObject::MakeZombie ( )
inlineprotectedinherited

Definition at line 55 of file TObject.h.

◆ MayNotUse()

void TObject::MayNotUse ( const char * method) const
inherited

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).

Definition at line 1160 of file TObject.cxx.

◆ Message()

void TROOT::Message ( Int_t id,
const TObject * obj )

Process message id called by obj.

Definition at line 2503 of file TROOT.cxx.

◆ mkdir()

TDirectory * TDirectory::mkdir ( const char * name,
const char * title = "",
Bool_t returnExistingDirectory = kFALSE )
virtualinherited

Create a sub-directory "a" or a hierarchy of sub-directories "a/b/c/...".

Parameters
namethe name or hierarchy of the subdirectory ("a" or "a/b/c")
titlethe title
returnExistingDirectoryif key-name is already existing, the returned value points to preexisting sub-directory if true and to nullptr if false.
Returns
a pointer to the created sub-directory, not to the top sub-directory of the hierarchy (in the above example, the returned TDirectory * points to "c"). In case of an error, it returns nullptr. In case of a preexisting sub-directory (hierarchy) with the requested name, the return value depends on the parameter returnExistingDirectory.

In particular, the steps to create first a/b/c and then a/b/d without receiving errors are:

TFile * file = new TFile("afile","RECREATE");
file->mkdir("a");
file->cd("a");
gDirectory->mkdir("b/c");
gDirectory->cd("b");
gDirectory->mkdir("d");
#define gDirectory
Definition TDirectory.h:385
Bool_t cd() override
Change current directory to "this" directory.
TDirectory * mkdir(const char *name, const char *title="", Bool_t returnExistingDirectory=kFALSE) override
Create a sub-directory "a" or a hierarchy of sub-directories "a/b/c/...".
A file, usually with extension .root, that stores data and code in the form of serialized objects in ...
Definition TFile.h:130

or

TFile * file = new TFile("afile","RECREATE");
file->mkdir("a");
file->cd("a");
gDirectory->mkdir("b/c");
gDirectory->mkdir("b/d", "", true);

Reimplemented in TDirectoryFile.

Definition at line 1112 of file TDirectory.cxx.

◆ MustClean()

Bool_t TROOT::MustClean ( ) const
inline

Definition at line 304 of file TROOT.h.

◆ Notify()

Bool_t TObject::Notify ( )
virtualinherited

This method must be overridden to handle object notification (the base implementation is no-op).

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented in h1analysis, h1analysisTreeReader, TARInterruptHandler, TASInputHandler, TASInterruptHandler, TASLogHandler, TASSigPipeHandler, TBlinkTimer, TBranchElement, TBranchRef, TBreakLineCom, TBrowserTimer, TCollection, TDelCharCom, TDelTextCom, TFileHandler, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TGLRedrawTimer, TGTextEditHist, TGuiBldDragManagerRepeatTimer, TIdleTimer, TInsCharCom, TInsTextCom, TInterruptHandler, TLeafObject, TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TPopupDelayTimer, TProcessEventTimer, TRefTable, TRepeatTimer, TSBRepeatTimer, TSelector, TSelectorDraw, TSelectorEntries, TSignalHandler, TSingleShotCleaner, TSocketHandler, TStdExceptionHandler, TSysEvtHandler, TTermInputHandler, TThreadTimer, TTimeOutTimer, TTimer, TTipDelayTimer, TTree, TTreeFormula, TTreeFormulaManager, TTreeReader, TViewTimer, and TViewUpdateTimer.

Definition at line 618 of file TObject.cxx.

◆ Obsolete()

void TObject::Obsolete ( const char * method,
const char * asOfVers,
const char * removedFromVers ) const
inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

◆ OpenFile()

virtual TFile * TDirectory::OpenFile ( const char * ,
Option_t * = "",
const char * = "",
Int_t = 1,
Int_t = 0 )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 241 of file TDirectory.h.

◆ operator delete() [1/3]

void TObject::operator delete ( void * ptr,
size_t size )
inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

◆ operator delete() [2/3]

void TObject::operator delete ( void * ptr)
inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

◆ operator delete() [3/3]

void TObject::operator delete ( void * ptr,
void * vp )
inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

◆ operator delete[]() [1/3]

void TObject::operator delete[] ( void * ptr,
size_t size )
inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

◆ operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr)
inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

◆ operator delete[]() [3/3]

void TObject::operator delete[] ( void * ptr,
void * vp )
inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

◆ operator new() [1/2]

void * TROOT::operator new ( size_t l)
inlineprotected

Definition at line 189 of file TROOT.h.

◆ operator new() [2/2]

void * TROOT::operator new ( size_t l,
void * ptr )
inlineprotected

Definition at line 190 of file TROOT.h.

◆ operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz)
inlineinherited

Definition at line 190 of file TObject.h.

◆ operator new[]() [2/2]

void * TObject::operator new[] ( size_t sz,
void * vp )
inlineinherited

Definition at line 192 of file TObject.h.

◆ operator=()

TROOT & TROOT::operator= ( const TROOT & )
privatedelete

◆ Paint()

void TDirectory::Paint ( Option_t * option = "")
overridevirtualinherited

Paint all objects in the directory.

Reimplemented from TObject.

Reimplemented in TFile, TSQLFile, and TXMLFile.

Definition at line 1189 of file TDirectory.cxx.

◆ Pop()

void TObject::Pop ( )
virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

◆ Print()

void TDirectory::Print ( Option_t * option = "") const
overridevirtualinherited

Print all objects in the directory.

Reimplemented from TObject.

Reimplemented in TFile, TMemFile, TSQLFile, and TXMLFile.

Definition at line 1197 of file TDirectory.cxx.

◆ ProcessLine()

Longptr_t TROOT::ProcessLine ( const char * line,
Int_t * error = nullptr )

Process interpreter command via TApplication::ProcessLine().

On Win32 the line will be processed asynchronously by sending it to the CINT interpreter thread. For explicit synchronous processing use ProcessLineSync(). On non-Win32 platforms there is no difference between ProcessLine() and ProcessLineSync(). The possible error codes are defined by TInterpreter::EErrorCode. In particular, error will equal to TInterpreter::kProcessing until the CINT interpreted thread has finished executing the line. Returns the result of the command, cast to a Longptr_t.

Definition at line 2523 of file TROOT.cxx.

◆ ProcessLineFast()

Longptr_t TROOT::ProcessLineFast ( const char * line,
Int_t * error = nullptr )

Process interpreter command directly via CINT interpreter.

Only executable statements are allowed (no variable declarations), In all other cases use TROOT::ProcessLine(). The possible error codes are defined by TInterpreter::EErrorCode.

Definition at line 2560 of file TROOT.cxx.

◆ ProcessLineSync()

Longptr_t TROOT::ProcessLineSync ( const char * line,
Int_t * error = nullptr )

Process interpreter command via TApplication::ProcessLine().

On Win32 the line will be processed synchronously (i.e. it will only return when the CINT interpreter thread has finished executing the line). On non-Win32 platforms there is no difference between ProcessLine() and ProcessLineSync(). The possible error codes are defined by TInterpreter::EErrorCode. Returns the result of the command, cast to a Longptr_t.

Definition at line 2543 of file TROOT.cxx.

◆ Purge()

virtual void TDirectory::Purge ( Short_t = 1)
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 246 of file TDirectory.h.

◆ pwd()

void TDirectory::pwd ( ) const
virtualinherited

Print the path of the directory.

Definition at line 1205 of file TDirectory.cxx.

◆ Read()

Int_t TObject::Read ( const char * name)
virtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented in TBuffer, TKey, TKeySQL, and TKeyXML.

Definition at line 673 of file TObject.cxx.

◆ ReadAll()

virtual void TDirectory::ReadAll ( Option_t * = "")
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 248 of file TDirectory.h.

◆ ReadGitInfo()

void TROOT::ReadGitInfo ( )
protected

Read Git commit SHA1 and branch name.

Read Git commit information and branch name from the etc/gitinfo.txt file.

Definition at line 2582 of file TROOT.cxx.

◆ ReadingObject()

Bool_t TROOT::ReadingObject ( ) const

Deprecated (will be removed in next release).

Definition at line 2613 of file TROOT.cxx.

◆ ReadKeys()

virtual Int_t TDirectory::ReadKeys ( Bool_t = kTRUE)
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 249 of file TDirectory.h.

◆ ReadTObject()

virtual Int_t TDirectory::ReadTObject ( TObject * ,
const char *  )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 250 of file TDirectory.h.

◆ RecursiveRemove()

void TROOT::RecursiveRemove ( TObject * obj)
overridevirtual

Recursively remove this object from the list of Cleanups.

Typically RecursiveRemove is implemented by classes that can contain mulitple references to a same object or shared ownership of the object with others.

Reimplemented from TDirectory.

Definition at line 2651 of file TROOT.cxx.

◆ RefreshBrowsers()

void TROOT::RefreshBrowsers ( )

Refresh all browsers.

Call this method when some command line command or script has changed the browser contents. Not needed for objects that have the kMustCleanup bit set. Most useful to update browsers that show the file system or other objects external to the running ROOT session.

Definition at line 2665 of file TROOT.cxx.

◆ RegisterContext()

void TDirectory::RegisterContext ( TContext * ctxt)
protectedinherited

◆ RegisterGDirectory()

void TDirectory::RegisterGDirectory ( SharedGDirectory_t & ptr)
protectedinherited

◆ RegisterModule()

void TROOT::RegisterModule ( const char * modulename,
const char ** headers,
const char ** includePaths,
const char * payloadCode,
const char * fwdDeclCode,
void(* triggerFunc )(),
const FwdDeclArgsToKeepCollection_t & fwdDeclsArgToSkip,
const char ** classesHeaders,
bool hasCxxModule = false )
static

Called by static dictionary initialization to register clang modules for headers.

Calls TCling::RegisterModule() unless gCling is NULL, i.e. during startup, where the information is buffered in the static GetModuleHeaderInfoBuffer(). The caller of this function should be holding the ROOT Write lock or be single threaded (dlopen)

Definition at line 2690 of file TROOT.cxx.

◆ Remove()

TObject * TROOT::Remove ( TObject * obj)
overridevirtual

Remove an object from the in-memory list.

Since TROOT is global resource, this is lock protected.

Reimplemented from TDirectory.

Definition at line 2773 of file TROOT.cxx.

◆ RemoveClass()

void TROOT::RemoveClass ( TClass * oldcl)

Remove a class from the list and map of classes.

This routine is deprecated, use TClass::RemoveClass directly.

Definition at line 2783 of file TROOT.cxx.

◆ Reset()

void TROOT::Reset ( Option_t * option = "")

Delete all global interpreter objects created since the last call to Reset.

If option="a" is set reset to startup context (i.e. unload also all loaded files, classes, structs, typedefs, etc.).

This function is typically used at the beginning (or end) of an unnamed macro to clean the environment.

IMPORTANT WARNING: Do not use this call from within any function (neither compiled nor interpreted. This should only be used from a unnamed macro (which starts with a { (curly braces) ). For example, using TROOT::Reset from within an interpreted function will lead to the unloading of the dictionary and source file, including the one defining the function being executed.

Definition at line 2806 of file TROOT.cxx.

◆ ResetBit()

void TObject::ResetBit ( UInt_t f)
inlineinherited

Definition at line 203 of file TObject.h.

◆ ResetClassSaved()

void TROOT::ResetClassSaved ( )

Reset the ClassSaved status of all classes.

Definition at line 1243 of file TROOT.cxx.

◆ rmdir()

void TDirectory::rmdir ( const char * name)
virtualinherited

Removes subdirectory from the directory When directory is deleted, all keys in all subdirectories will be read first and deleted from file (if exists) Equivalent call is Delete("name;*");.

Reimplemented in TDirectoryFile.

Definition at line 1237 of file TDirectory.cxx.

◆ RootVersionCode()

Int_t TROOT::RootVersionCode ( )
static

Return ROOT version code as defined in RVersion.h.

Definition at line 3102 of file TROOT.cxx.

◆ Save()

virtual void TDirectory::Save ( )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 254 of file TDirectory.h.

◆ SaveAs()

void TObject::SaveAs ( const char * filename = "",
Option_t * option = "" ) const
virtualinherited

Save this object in the file specified by filename.

  • if "filename" contains ".root" the object is saved in filename as root binary file.
  • if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
  • if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().
  • otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

    The function is available via the object context menu.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.

Definition at line 708 of file TObject.cxx.

◆ SaveContext()

void TROOT::SaveContext ( )

Save the current interpreter context.

Definition at line 2826 of file TROOT.cxx.

◆ SaveObjectAs()

Int_t TDirectory::SaveObjectAs ( const TObject * obj,
const char * filename = "",
Option_t * option = "" ) const
virtualinherited

Save object in filename, if filename is nullptr or "", a file with "<objectname>.root" is created.

The name of the key is the object name. By default new file will be created. Using option "a", one can append object to the existing ROOT file. If the operation is successful, it returns the number of bytes written to the file otherwise it returns 0. By default a message is printed. Use option "q" to not print the message. If filename contains ".json" extension, JSON representation of the object will be created and saved in the text file. Such file can be used in JavaScript ROOT (https://root.cern/js/) to display object in web browser When creating JSON file, option string may contain compression level from 0 to 3 (default 0)

Reimplemented in TDirectoryFile.

Definition at line 1260 of file TDirectory.cxx.

◆ SavePrimitive()

void TObject::SavePrimitive ( std::ostream & out,
Option_t * option = "" )
virtualinherited

Save a primitive as a C++ statement(s) on output stream "out".

Reimplemented in TAnnotation, TArc, TArrow, TASImage, TAxis3D, TBox, TButton, TCanvas, TChain, TCrown, TCurlyArc, TCurlyLine, TCutG, TDiamond, TEfficiency, TEllipse, TExec, TF12, TF1, TF2, TF3, TFrame, TGaxis, TGButton, TGButtonGroup, TGCanvas, TGCheckButton, TGColorSelect, TGColumnLayout, TGComboBox, TGCompositeFrame, TGContainer, TGDockableFrame, TGDoubleHSlider, TGDoubleVSlider, TGedMarkerSelect, TGedPatternSelect, TGeoArb8, TGeoBBox, TGeoBoolNode, TGeoCombiTrans, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoCtub, TGeoDecayChannel, TGeoElementRN, TGeoEltu, TGeoGtra, TGeoHalfSpace, TGeoHMatrix, TGeoHype, TGeoIdentity, TGeoIntersection, TGeoMaterial, TGeoMedium, TGeoMixture, TGeoPara, TGeoParaboloid, TGeoPatternCylPhi, TGeoPatternCylR, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternSphPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternTrapZ, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPcon, TGeoPgon, TGeoRotation, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoSubtraction, TGeoTessellated, TGeoTorus, TGeoTranslation, TGeoTrap, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoUnion, TGeoVolume, TGeoXtru, TGFileContainer, TGFont, TGFrame, TGFSComboBox, TGGC, TGGroupFrame, TGHButtonGroup, TGHorizontal3DLine, TGHorizontalFrame, TGHorizontalLayout, TGHProgressBar, TGHScrollBar, TGHSlider, TGHSplitter, TGHtml, TGIcon, TGLabel, TGLayoutHints, TGLineStyleComboBox, TGLineWidthComboBox, TGListBox, TGListDetailsLayout, TGListLayout, TGListTree, TGListView, TGLVContainer, TGMainFrame, TGMatrixLayout, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGMenuBar, TGMenuTitle, TGNumberEntry, TGNumberEntryField, TGPictureButton, TGPopupMenu, TGProgressBar, TGRadioButton, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphEdge, TGraphErrors, TGraphMultiErrors, TGraphNode, TGraphPolar, TGraphPolargram, TGraphStruct, TGroupButton, TGRowLayout, TGShapedFrame, TGShutter, TGShutterItem, TGSplitFrame, TGStatusBar, TGTab, TGTabLayout, TGTableLayout, TGTableLayoutHints, TGTextButton, TGTextEdit, TGTextEntry, TGTextLBEntry, TGTextView, TGTileLayout, TGToolBar, TGTransientFrame, TGTripleHSlider, TGTripleVSlider, TGVButtonGroup, TGVertical3DLine, TGVerticalFrame, TGVerticalLayout, TGVFileSplitter, TGVProgressBar, TGVScrollBar, TGVSlider, TGVSplitter, TGXYLayout, TGXYLayoutHints, TH1, TH2Poly, THelix, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TPad, TPaletteAxis, TParallelCoord, TParallelCoordVar, TPave, TPaveClass, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TRootContainer, TRootEmbeddedCanvas, TScatter2D, TScatter, TSlider, TSliderBox, TSpline3, TSpline5, TStyle, TText, TTreePerfStats, and TWbox.

Definition at line 858 of file TObject.cxx.

◆ SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor ( std::ostream & out,
TClass * cl,
const char * variable_name,
const char * constructor_agrs = "",
Bool_t empty_line = kTRUE )
staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

◆ SavePrimitiveDraw()

void TObject::SavePrimitiveDraw ( std::ostream & out,
const char * variable_name,
Option_t * option = nullptr )
staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

◆ SavePrimitiveNameTitle()

void TNamed::SavePrimitiveNameTitle ( std::ostream & out,
const char * variable_name )
protectedinherited

Save object name and title into the output stream "out".

Definition at line 135 of file TNamed.cxx.

◆ SavePrimitiveVector()

TString TObject::SavePrimitiveVector ( std::ostream & out,
const char * prefix,
Int_t len,
Double_t * arr,
Int_t flag = 0 )
staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

◆ SaveSelf()

virtual void TDirectory::SaveSelf ( Bool_t = kFALSE)
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 256 of file TDirectory.h.

◆ SetApplication()

void TROOT::SetApplication ( TApplication * app)
inline

Definition at line 325 of file TROOT.h.

◆ SetBatch()

void TROOT::SetBatch ( Bool_t batch = kTRUE)

Set batch mode for ROOT If the argument evaluates to true, the session does not use interactive graphics.

Batch mode can also be enabled by setting the ROOT_BATCH environment variable. If web graphics runs in server mode, the web widgets are still available via URL.

Definition at line 2959 of file TROOT.cxx.

◆ SetBit() [1/2]

void TObject::SetBit ( UInt_t f)
inlineinherited

Definition at line 202 of file TObject.h.

◆ SetBit() [2/2]

void TObject::SetBit ( UInt_t f,
Bool_t set )
inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.cxx.

◆ SetBufferSize()

virtual void TDirectory::SetBufferSize ( Int_t )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 257 of file TDirectory.h.

◆ SetCutClassName()

void TROOT::SetCutClassName ( const char * name = "TCutG")

Set the default graphical cut class name for the graphics editor By default the graphics editor creates an instance of a class TCutG.

This function may be called to specify a different class that MUST derive from TCutG

Definition at line 2838 of file TROOT.cxx.

◆ SetDefCanvasName()

void TROOT::SetDefCanvasName ( const char * name = "c1")
inline

Definition at line 329 of file TROOT.h.

◆ SetDirLevel()

void TROOT::SetDirLevel ( Int_t level = 0)
static

Return Indentation level for ls().

Definition at line 3075 of file TROOT.cxx.

◆ SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "")
virtualinherited

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented in RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.

Definition at line 871 of file TObject.cxx.

◆ SetDtorOnly()

void TObject::SetDtorOnly ( void * obj)
staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

◆ SetEditHistograms()

void TROOT::SetEditHistograms ( Bool_t flag = kTRUE)
inline

Definition at line 330 of file TROOT.h.

◆ SetEditorMode()

void TROOT::SetEditorMode ( const char * mode = "")

Set editor mode.

Definition at line 2859 of file TROOT.cxx.

◆ SetEscape()

void TROOT::SetEscape ( Bool_t flag = kTRUE)
inline

Definition at line 335 of file TROOT.h.

◆ SetExecutingMacro()

void TROOT::SetExecutingMacro ( Bool_t flag = kTRUE)
inline

Definition at line 332 of file TROOT.h.

◆ SetFromPopUp()

void TROOT::SetFromPopUp ( Bool_t flag = kTRUE)
inline

Definition at line 333 of file TROOT.h.

◆ SetInterrupt()

void TROOT::SetInterrupt ( Bool_t flag = kTRUE)
inline

Definition at line 334 of file TROOT.h.

◆ SetLineHasBeenProcessed()

void TROOT::SetLineHasBeenProcessed ( )
inline

Definition at line 337 of file TROOT.h.

◆ SetLineIsProcessing()

void TROOT::SetLineIsProcessing ( )
inline

Definition at line 336 of file TROOT.h.

◆ SetMacroPath()

void TROOT::SetMacroPath ( const char * newpath)
static

Set or extend the macro search path.

Static utility function. If newpath=0 or "" reset to value specified in the rootrc file.

Definition at line 2943 of file TROOT.cxx.

◆ SetModified()

virtual void TDirectory::SetModified ( )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 258 of file TDirectory.h.

◆ SetMother()

virtual void TDirectory::SetMother ( TObject * mother)
inlinevirtualinherited

Definition at line 259 of file TDirectory.h.

◆ SetMustClean()

void TROOT::SetMustClean ( Bool_t flag = kTRUE)
inline

Definition at line 339 of file TROOT.h.

◆ SetName()

void TDirectory::SetName ( const char * newname)
overridevirtualinherited

Set the name for directory If the directory name is changed after the directory was written once, ROOT currently would NOT change the name of correspondent key in the mother directory.

DO NOT use this method to 'rename a directory'. Renaming a directory is currently NOT supported.

Reimplemented from TNamed.

Definition at line 1297 of file TDirectory.cxx.

◆ SetNameTitle()

void TNamed::SetNameTitle ( const char * name,
const char * title )
virtualinherited

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, TContextMenu, TGraph2D, TGraph, TH1, and TNode.

Definition at line 163 of file TNamed.cxx.

◆ SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat)
staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

◆ SetReadingObject()

void TROOT::SetReadingObject ( Bool_t flag = kTRUE)

Definition at line 2618 of file TROOT.cxx.

◆ SetSeekDir()

virtual void TDirectory::SetSeekDir ( Long64_t )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 262 of file TDirectory.h.

◆ SetSelectedPad()

void TROOT::SetSelectedPad ( TVirtualPad * pad)
inline

Definition at line 341 of file TROOT.h.

◆ SetSelectedPrimitive()

void TROOT::SetSelectedPrimitive ( const TObject * obj)
inline

Definition at line 340 of file TROOT.h.

◆ SetStyle()

void TROOT::SetStyle ( const char * stylename = "Default")

Change current style to style with name stylename.

Definition at line 2885 of file TROOT.cxx.

◆ SetTitle()

void TNamed::SetTitle ( const char * title = "")
virtualinherited

◆ SetTRefAction()

virtual void TDirectory::SetTRefAction ( TObject * ,
TObject *  )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 261 of file TDirectory.h.

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid)
virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ SetWebDisplay()

void TROOT::SetWebDisplay ( const char * webdisplay = "")

Specify where web graphics shall be rendered.

The input parameter webdisplay defines where web graphics is rendered. webdisplay parameter may contain:

  • "firefox": select Mozilla Firefox browser for interactive web display
  • "chrome": select Google Chrome browser for interactive web display. Can also be set to "chromium"
  • "edge": select Microsoft Edge browser for interactive web display
  • "native": select one of the natively-supported web browsers firefox/chrome/edge for interactive web display
  • "qt6": uses QWebEngine from Qt6, no real http server started (requires qt6web component build for ROOT)
  • "cef": uses Chromium Embeded Framework, no real http server started (requires cefweb component build for ROOT)
  • "local": select one of available local (without http server) engines like qt6/cef
  • "default": system default web browser, invoked with xdg-open on Linux, start on Mac or open on Windows
  • "on": try "local", then "native", then "default" option
  • "off": turns off the web display and comes back to normal graphics in interactive mode.
  • "server:port": turns the web display into server mode with specified port. Web widgets will not be displayed, only text message with window URL will be printed on standard output
Note
See more details related to webdisplay on RWebWindowsManager::ShowWindow

Definition at line 2988 of file TROOT.cxx.

◆ SetWritable()

virtual void TDirectory::SetWritable ( Bool_t )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 263 of file TDirectory.h.

◆ Sizeof()

Int_t TDirectory::Sizeof ( ) const
inlineoverridevirtualinherited

Return size of the TNamed part of the TObject.

Reimplemented from TNamed.

Reimplemented in TDirectoryFile, TFile, TSQLFile, and TXMLFile.

Definition at line 264 of file TDirectory.h.

◆ Streamer()

void TDirectory::Streamer ( TBuffer & R__b)
overridevirtualinherited

TDirectory Streamer.

Reimplemented from TObject.

Reimplemented in RooWorkspace::WSDir, TDirectoryFile, TFile, TMemFile, TNetXNGFile, TParallelMergingFile, TSQLFile, and TXMLFile.

Definition at line 1466 of file TDirectory.cxx.

◆ StreamerNVirtual()

void TDirectory::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inlineinherited

Definition at line 309 of file TDirectory.h.

◆ SysError()

void TObject::SysError ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

◆ TestBit()

Bool_t TObject::TestBit ( UInt_t f) const
inlineinherited

Definition at line 204 of file TObject.h.

◆ TestBits()

Int_t TObject::TestBits ( UInt_t f) const
inlineinherited

Definition at line 205 of file TObject.h.

◆ Time()

void TROOT::Time ( Int_t casetime = 1)
inline

Definition at line 343 of file TROOT.h.

◆ Timer()

Int_t TROOT::Timer ( ) const
inline

Definition at line 344 of file TROOT.h.

◆ UnregisterContext()

void TDirectory::UnregisterContext ( TContext * ctxt)
protectedinherited

UnRegister a TContext pointing to this TDirectory object.

Definition at line 1444 of file TDirectory.cxx.

◆ UseCurrentStyle()

void TObject::UseCurrentStyle ( )
virtualinherited

Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

Reimplemented in TAxis3D, TCanvas, TFrame, TGraph, TH1, TPad, TPaveStats, TPaveText, and TTree.

Definition at line 909 of file TObject.cxx.

◆ Warning()

void TObject::Warning ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

◆ Write() [1/2]

virtual Int_t TDirectory::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 ) const
inlineoverridevirtualinherited

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

  • Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
  • The TBuffer object is filled via the class::Streamer function.
  • If the file is compressed (default) a second buffer is created to hold the compressed buffer.
  • Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
  • The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented from TObject.

Reimplemented in TDirectoryFile, TFile, TParallelMergingFile, TSQLFile, and TXMLFile.

Definition at line 266 of file TDirectory.h.

◆ Write() [2/2]

virtual Int_t TDirectory::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 )
inlineoverridevirtualinherited

Write this object to the current directory.

For more see the const version of this method.

Reimplemented from TObject.

Reimplemented in ROOT::TBufferMergerFile, TDirectoryFile, TFile, TParallelMergingFile, TSQLFile, and TXMLFile.

Definition at line 265 of file TDirectory.h.

◆ WriteDirHeader()

virtual void TDirectory::WriteDirHeader ( )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 303 of file TDirectory.h.

◆ WriteKeys()

virtual void TDirectory::WriteKeys ( )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 304 of file TDirectory.h.

◆ WriteObject() [1/2]

template<typename T>
std::enable_if_t< std::is_base_of< TObject, T >::value, Int_t > TDirectory::WriteObject ( const T * obj,
const char * name,
Option_t * option = "",
Int_t bufsize = 0 )
inlineinherited

Write an object with proper type checking.

Parameters
[in]objPointer to an object to be written.
[in]nameName of the object in the file.
[in]optionOptions. See TDirectoryFile::WriteTObject.
[in]bufsizeBuffer size. See TDirectoryFile::WriteTObject.

This overload takes care of instances of classes that are derived from TObject. The method redirects to TDirectory::WriteTObject.

Definition at line 297 of file TDirectory.h.

◆ WriteObject() [2/2]

template<typename T>
std::enable_if_t<!std::is_base_of< TObject, T >::value, Int_t > TDirectory::WriteObject ( const T * obj,
const char * name,
Option_t * option = "",
Int_t bufsize = 0 )
inlineinherited

Write an object with proper type checking.

Parameters
[in]objPointer to an object to be written.
[in]nameName of the object in the file.
[in]optionOptions. See TDirectoryFile::WriteTObject.
[in]bufsizeBuffer size. See TDirectoryFile::WriteTObject.

This overload takes care of instances of classes that are not derived from TObject. The method redirects to TDirectory::WriteObjectAny.

Definition at line 283 of file TDirectory.h.

◆ WriteObjectAny() [1/2]

virtual Int_t TDirectory::WriteObjectAny ( const void * ,
const char * ,
const char * ,
Option_t * = "",
Int_t = 0 )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 301 of file TDirectory.h.

◆ WriteObjectAny() [2/2]

virtual Int_t TDirectory::WriteObjectAny ( const void * ,
const TClass * ,
const char * ,
Option_t * = "",
Int_t = 0 )
inlinevirtualinherited

Reimplemented in TDirectoryFile.

Definition at line 302 of file TDirectory.h.

◆ WriteTObject()

virtual Int_t TDirectory::WriteTObject ( const TObject * obj,
const char * name = nullptr,
Option_t * = "",
Int_t = 0 )
virtualinherited

Reimplemented in TDirectoryFile.

◆ ::ROOT::Internal::TROOTAllocator

friend class ::ROOT::Internal::TROOTAllocator
friend

Definition at line 192 of file TROOT.h.

◆ ROOT::Internal::GetROOT2

◆ TCling

friend class TCling
friend

Definition at line 109 of file TROOT.h.

Member Data Documentation

◆ fApplication

std::atomic<TApplication*> TROOT::fApplication = nullptr
protected

Pointer to current application.

Definition at line 137 of file TROOT.h.

◆ fBatch

Bool_t TROOT::fBatch = true
protected

True if session without graphics.

Definition at line 139 of file TROOT.h.

◆ fBits

UInt_t TObject::fBits
privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fBrowsables

TList* TROOT::fBrowsables = nullptr
protected

List of browsables.

Definition at line 179 of file TROOT.h.

◆ fBrowsers

TSeqCollection* TROOT::fBrowsers = nullptr
protected

List of browsers.

Definition at line 168 of file TROOT.h.

◆ fBuiltDate

Int_t TROOT::fBuiltDate = 0
protected

Date of ROOT built.

Definition at line 131 of file TROOT.h.

◆ fBuiltTime

Int_t TROOT::fBuiltTime = 0
protected

Time of ROOT built.

Definition at line 132 of file TROOT.h.

◆ fCanvases

TSeqCollection* TROOT::fCanvases = nullptr
protected

List of canvases.

Definition at line 162 of file TROOT.h.

◆ fClasses

TCollection* TROOT::fClasses = nullptr
protected

List of classes definition.

Definition at line 153 of file TROOT.h.

◆ fClassGenerators

TCollection* TROOT::fClassGenerators = nullptr
protected

List of user defined class generators;.

Definition at line 173 of file TROOT.h.

◆ fCleanups

TSeqCollection* TROOT::fCleanups = nullptr
protected

List of recursiveRemove collections.

Definition at line 170 of file TROOT.h.

◆ fClipboard

TSeqCollection* TROOT::fClipboard = nullptr
protected

List of clipboard objects.

Definition at line 174 of file TROOT.h.

◆ fClosedObjects

TSeqCollection* TROOT::fClosedObjects = nullptr
protected

List of closed objects from the list of files and sockets, so we can delete them if neededCl.

Definition at line 158 of file TROOT.h.

◆ fColors

TSeqCollection* TROOT::fColors = nullptr
protected

List of colors.

Definition at line 166 of file TROOT.h.

◆ fConfigFeatures

TString TROOT::fConfigFeatures
protected

ROOT ./configure detected build features.

Definition at line 125 of file TROOT.h.

◆ fConfigOptions

TString TROOT::fConfigOptions
protected

ROOT ./configure set build options.

Definition at line 124 of file TROOT.h.

◆ fContext

TContext* TDirectory::fContext {nullptr}
protectedinherited

! Pointer to a list of TContext object pointing to this TDirectory

Definition at line 145 of file TDirectory.h.

◆ fContextPeg

std::atomic<size_t> TDirectory::fContextPeg {0}
protectedinherited

! Counter delaying the TDirectory destructor from finishing.

Definition at line 153 of file TDirectory.h.

◆ fCutClassName

TString TROOT::fCutClassName
protected

Name of default CutG class in graphics editor.

Definition at line 181 of file TROOT.h.

◆ fDataSets

TSeqCollection* TROOT::fDataSets = nullptr
protected

List of data sets (TDSet or TChain).

Definition at line 175 of file TROOT.h.

◆ fDefCanvasName

TString TROOT::fDefCanvasName
protected

Name of default canvas.

Definition at line 182 of file TROOT.h.

◆ fEditHistograms

Bool_t TROOT::fEditHistograms = true
protected

True if histograms can be edited with the mouse.

Definition at line 143 of file TROOT.h.

◆ fEditorMode

Int_t TROOT::fEditorMode = 0
protected

Current Editor mode.

Definition at line 150 of file TROOT.h.

◆ fEnums

AListOfEnums_t TROOT::fEnums = nullptr
protected

List of enum types.

Definition at line 176 of file TROOT.h.

◆ fEscape

Bool_t TROOT::fEscape = false
protected

True if ESC has been pressed.

Definition at line 148 of file TROOT.h.

◆ fExecutingMacro

Bool_t TROOT::fExecutingMacro = false
protected

True while executing a TMacro.

Definition at line 149 of file TROOT.h.

◆ fFiles

TSeqCollection* TROOT::fFiles = nullptr
protected

List of files.

Definition at line 159 of file TROOT.h.

◆ fForceStyle

Bool_t TROOT::fForceStyle = false
protected

Force setting of current style when reading objects.

Definition at line 146 of file TROOT.h.

◆ fFromPopUp

Bool_t TROOT::fFromPopUp = true
protected

True if command executed from a popup menu.

Definition at line 144 of file TROOT.h.

◆ fFuncTemplate

TListOfFunctionTemplates* TROOT::fFuncTemplate = nullptr
protected

List of global function templates.

Definition at line 155 of file TROOT.h.

◆ fFunctions

TCollection* TROOT::fFunctions = nullptr
protected

List of analytic functions.

Definition at line 164 of file TROOT.h.

◆ fgAddDirectory

Bool_t TDirectory::fgAddDirectory = false
inlinestaticprotectedinherited

!

Deprecated
This flag has no effect in ROOT.

Definition at line 157 of file TDirectory.h.

◆ fGDirectories

std::vector<SharedGDirectory_t> TDirectory::fGDirectories
protectedinherited

! thread local gDirectory pointing to this object.

Definition at line 151 of file TDirectory.h.

◆ fgDirLevel

Int_t TROOT::fgDirLevel = 0
staticprivate

Indentation level for ls().

Definition at line 115 of file TROOT.h.

◆ fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0
staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.h.

◆ fGeometries

TSeqCollection* TROOT::fGeometries = nullptr
protected

List of geometries.

Definition at line 167 of file TROOT.h.

◆ fGitBranch

TString TROOT::fGitBranch
protected

Git branch.

Definition at line 134 of file TROOT.h.

◆ fGitCommit

TString TROOT::fGitCommit
protected

Git commit SHA1 of built.

Definition at line 133 of file TROOT.h.

◆ fGitDate

TString TROOT::fGitDate
protected

Date and time when make was run.

Definition at line 135 of file TROOT.h.

◆ fGlobalFunctions

TListOfFunctions* TROOT::fGlobalFunctions = nullptr
protected

List of global functions.

Definition at line 157 of file TROOT.h.

◆ fGlobals

TListOfDataMembers* TROOT::fGlobals = nullptr
protected

List of global variables.

Definition at line 156 of file TROOT.h.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE
staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

◆ fgRootInit

Bool_t TROOT::fgRootInit = kFALSE
staticprivate

Singleton initialization flag.

Definition at line 116 of file TROOT.h.

◆ fInterpreter

TInterpreter* TROOT::fInterpreter = nullptr
protected

Command interpreter.

Definition at line 138 of file TROOT.h.

◆ fInterrupt

Bool_t TROOT::fInterrupt = false
protected

True if macro should be interrupted.

Definition at line 147 of file TROOT.h.

◆ fIsWebDisplay

Bool_t TROOT::fIsWebDisplay = false
protected

True if session uses web widgets.

Definition at line 141 of file TROOT.h.

◆ fIsWebDisplayBatch

Bool_t TROOT::fIsWebDisplayBatch = false
protected

True if web widgets are not displayed.

Definition at line 142 of file TROOT.h.

◆ fLineIsProcessing

Int_t TROOT::fLineIsProcessing = 0
private

To synchronize multi-threads.

Definition at line 113 of file TROOT.h.

◆ fList

TList* TDirectory::fList {nullptr}
protectedinherited

List of objects in memory.

Definition at line 142 of file TDirectory.h.

◆ fMappedFiles

TSeqCollection* TROOT::fMappedFiles = nullptr
protected

List of memory mapped files.

Definition at line 160 of file TROOT.h.

◆ fMessageHandlers

TSeqCollection* TROOT::fMessageHandlers = nullptr
protected

List of message handlers.

Definition at line 171 of file TROOT.h.

◆ fMother

TObject* TDirectory::fMother {nullptr}
protectedinherited

pointer to mother of the directory

Definition at line 141 of file TDirectory.h.

◆ fMustClean

Bool_t TROOT::fMustClean = true
protected

True if object destructor scans canvases.

Definition at line 145 of file TROOT.h.

◆ fName

TString TNamed::fName
protectedinherited

Definition at line 32 of file TNamed.h.

◆ fPathBuffer

TString TDirectory::fPathBuffer
mutableprotectedinherited

! Buffer for GetPath() function

Definition at line 144 of file TDirectory.h.

◆ fPluginManager

TPluginManager* TROOT::fPluginManager = nullptr
protected

Keeps track of plugin library handlers.

Definition at line 180 of file TROOT.h.

◆ fPrimitive

const TObject* TROOT::fPrimitive = nullptr
protected

Currently selected primitive.

Definition at line 151 of file TROOT.h.

◆ fRootFolder

TFolder* TROOT::fRootFolder = nullptr
protected

top level folder //root

Definition at line 178 of file TROOT.h.

◆ fSelectPad

TVirtualPad* TROOT::fSelectPad = nullptr
protected

Currently selected pad.

Definition at line 152 of file TROOT.h.

◆ fSockets

TSeqCollection* TROOT::fSockets = nullptr
protected

List of network sockets.

Definition at line 161 of file TROOT.h.

◆ fSpecials

TSeqCollection* TROOT::fSpecials = nullptr
protected

List of special objects.

Definition at line 169 of file TROOT.h.

◆ fSpinLock

std::atomic_flag TDirectory::fSpinLock
mutableprotectedinherited

! MSVC doesn't support = ATOMIC_FLAG_INIT;

Definition at line 154 of file TDirectory.h.

◆ fStreamerInfo

TSeqCollection* TROOT::fStreamerInfo = nullptr
protected

List of active StreamerInfo classes.

Definition at line 172 of file TROOT.h.

◆ fStyles

TSeqCollection* TROOT::fStyles = nullptr
protected

List of styles.

Definition at line 163 of file TROOT.h.

◆ fTasks

TSeqCollection* TROOT::fTasks = nullptr
protected

List of tasks.

Definition at line 165 of file TROOT.h.

◆ fTimer

Int_t TROOT::fTimer = 0
protected

Timer flag.

Definition at line 136 of file TROOT.h.

◆ fTitle

TString TNamed::fTitle
protectedinherited

Definition at line 33 of file TNamed.h.

◆ fTypes

TCollection* TROOT::fTypes = nullptr
protected

List of data types definition.

Definition at line 154 of file TROOT.h.

◆ fUniqueID

UInt_t TObject::fUniqueID
privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

◆ fUUID

TUUID TDirectory::fUUID {TUUID::UUIDv4()}
protectedinherited

Unique identifier.

Definition at line 143 of file TDirectory.h.

◆ fUUIDs

TProcessUUID* TROOT::fUUIDs = nullptr
protected

Pointer to TProcessID managing TUUIDs.

Definition at line 177 of file TROOT.h.

◆ fVersion

TString TROOT::fVersion
protected

ROOT version as TString, example: 0.05.01.

Definition at line 126 of file TROOT.h.

◆ fVersionCode

Int_t TROOT::fVersionCode = 0
protected

ROOT version code as used in RVersion.h.

Definition at line 128 of file TROOT.h.

◆ fVersionDate

Int_t TROOT::fVersionDate = 0
protected

Date of ROOT version (ex 951226).

Definition at line 129 of file TROOT.h.

◆ fVersionInt

Int_t TROOT::fVersionInt = 0
protected

ROOT version in integer format (501).

Definition at line 127 of file TROOT.h.

◆ fVersionTime

Int_t TROOT::fVersionTime = 0
protected

Time of ROOT version (ex 1152).

Definition at line 130 of file TROOT.h.

◆ fWebDisplay

TString TROOT::fWebDisplay
protected

If not empty it defines where web graphics should be rendered (cef, qt6, browser...).

Definition at line 140 of file TROOT.h.


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