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

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

Definition at line 94 of file TROOT.h.

Public Types

typedef std::vector< std::pair< std::string, int > > FwdDeclArgsToKeepCollection_t
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 

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 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.
 
void Browse (TBrowser *b) override
 Add browsable objects to TBrowser.
 
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 CloseFiles ()
 Close any files and sockets that gROOT knows about.
 
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.
 
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
 
TApplicationGetApplication () 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
 
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.
 
TInterpreterGetInterpreter () 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.
 
TSeqCollectionGetListOfMappedFiles () const
 
TSeqCollectionGetListOfMessageHandlers () const
 
TSeqCollectionGetListOfProofs () const
 
TSeqCollectionGetListOfSecContexts () 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.
 
Int_t GetNclasses () const
 Get number of classes.
 
Int_t GetNtypes () const
 Get number of types.
 
TPluginManagerGetPluginManager () const
 
TFolderGetRootFolder () const
 
TVirtualPadGetSelectedPad () const
 
const TObjectGetSelectedPrimitive () const
 
TStyleGetStyle (const char *name) const
 Return pointer to style with name.
 
TDataTypeGetType (const char *name, Bool_t load=kFALSE) const
 Return pointer to type with name.
 
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
 
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.
 
TClassIsA () const override
 
Bool_t IsBatch () const
 
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
 
Bool_t IsProofServ () 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 IsWebDisplay () const
 
Bool_t IsWebDisplayBatch () 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 Message (Int_t id, const TObject *obj)
 Process message id called by obj.
 
Bool_t MustClean () const
 
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().
 
Bool_t ReadingObject () const
 Deprecated (will be removed in next release).
 
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 ResetClassSaved ()
 Reset the ClassSaved status of all classes.
 
void SaveContext ()
 Save the current interpreter context.
 
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 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")
 
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 ()
 
void SetMustClean (Bool_t flag=kTRUE)
 
void SetReadingObject (Bool_t flag=kTRUE)
 
void SetSelectedPad (TVirtualPad *pad)
 
void SetSelectedPrimitive (const TObject *obj)
 
void SetStyle (const char *stylename="Default")
 Change current style to style with name stylename.
 
void SetWebDisplay (const char *webdisplay="")
 Specify where web graphics shall be rendered.
 
void Streamer (TBuffer &) override
 TDirectory Streamer.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
void Time (Int_t casetime=1)
 
Int_t Timer () const
 
- Public Member Functions inherited from TDirectory
 TDirectory ()
 Directory default constructor.
 
 TDirectory (const char *name, const char *title, Option_t *option="", TDirectory *motherDir=nullptr)
 Create a new Directory.
 
virtual ~TDirectory ()
 Destructor.
 
virtual void Add (TObject *obj, Bool_t replace=kFALSE)
 
virtual Int_t AppendKey (TKey *)
 
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.
 
void Clear (Option_t *option="") override
 Delete all objects from a Directory list.
 
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 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.
 
void Draw (Option_t *option="") override
 Fill Graphics Structure and Paint.
 
virtual TKeyFindKey (const char *) const
 
virtual TKeyFindKeyAny (const char *) const
 
virtual TObjectGet (const char *namecycle)
 Return pointer to object identified by namecycle.
 
template<class T >
T * Get (const char *namecycle)
 See documentation of TDirectoryFile::Get(const char *namecycle)
 
virtual Int_t GetBufferSize () const
 
virtual TDirectoryGetDirectory (const char *namecycle, Bool_t printError=false, const char *funcname="GetDirectory")
 Find a directory using apath.
 
virtual TKeyGetKey (const char *, Short_t=9999) const
 
virtual TListGetList () const
 
virtual TListGetListOfKeys () const
 
TObjectGetMother () const
 
TDirectoryGetMotherDir () const
 
virtual Int_t GetNbytesKeys () const
 
virtual Int_t GetNkeys () const
 
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 void * GetObjectUnchecked (const char *namecycle)
 Return pointer to object identified by namecycle.
 
virtual const char * GetPath () const
 Returns the full path of the directory.
 
virtual const char * GetPathStatic () const
 Returns the full path of the directory.
 
virtual Long64_t GetSeekDir () const
 
virtual Long64_t GetSeekKeys () const
 
virtual Long64_t GetSeekParent () const
 
TUUID GetUUID () const
 
Bool_t IsBuilt () const
 
virtual Bool_t IsModified () const
 
virtual Bool_t IsWritable () const
 
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/...".
 
virtual TFileOpenFile (const char *, Option_t *="", const char *="", Int_t=1, Int_t=0)
 
void Paint (Option_t *option="") override
 Paint all objects in the directory.
 
void Print (Option_t *option="") const override
 Print all objects in the directory.
 
virtual void Purge (Short_t=1)
 
virtual void pwd () const
 Print the path of the directory.
 
virtual void ReadAll (Option_t *="")
 
virtual Int_t ReadKeys (Bool_t=kTRUE)
 
virtual Int_t ReadTObject (TObject *, const char *)
 
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 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 SaveSelf (Bool_t=kFALSE)
 
virtual void SetBufferSize (Int_t)
 
virtual void SetModified ()
 
virtual void SetMother (TObject *mother)
 
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 SetSeekDir (Long64_t)
 
virtual void SetTRefAction (TObject *, TObject *)
 
virtual void SetWritable (Bool_t)
 
Int_t Sizeof () const override
 Return size of the TNamed part of the TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
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)
 Write an object with proper type checking.
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TObject &named) const override
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
Bool_t IsSortable () const override
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 Print TNamed name and title.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 

Static Public Member Functions

static const std::vector< std::string > & AddExtraInterpreterArgs (const std::vector< std::string > &args)
 Provide command line arguments to the interpreter construction.
 
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 const char * DeclFileName ()
 
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 const TStringGetEtcDir ()
 Get the sysconfig directory in the installation. Static utility function.
 
static const char **& GetExtraInterpreterArgs ()
 INTERNAL function! Used by rootcling to inject interpreter arguments through a C-interface layer.
 
static const TStringGetIconPath ()
 Get the icon path in the installation. Static utility 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 utility function.
 
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 const TStringGetRootSys ()
 Get the rootsys directory in the installation. Static utility function.
 
static const TStringGetSharedLibDir ()
 Get the shared libraries directory in the installation. Static utility function.
 
static const TStringGetSourceDir ()
 Get the source directory in the installation. Static utility function.
 
static const TStringGetTTFFontDir ()
 Get the fonts directory in the installation. Static utility function.
 
static const TStringGetTutorialDir ()
 Get the tutorials directory in the installation. Static utility function.
 
static const char * GetTutorialsDir ()
 Get the tutorials directory in the installation.
 
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 SetMacroPath (const char *newpath)
 Set or extend the macro search path.
 
static void ShutDown ()
 Shut down ROOT.
 
- Static Public Member Functions inherited from TDirectory
static void AddDirectory (Bool_t add=kTRUE)
 Sets the flag controlling the automatic add objects like histograms, TGraph2D, etc in memory.
 
static Bool_t AddDirectoryStatus ()
 Static function: see TDirectory::AddDirectory for more comments.
 
static Bool_t Cd (const char *path)
 Change current directory to "path".
 
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static std::atomic< TDirectory * > & CurrentDirectory ()
 Return the current directory for the current thread.
 
static const char * DeclFileName ()
 
static void DecodeNameCycle (const char *namecycle, char *name, Short_t &cycle, const size_t namesize=0)
 Decode a namecycle "aap;2" into name "aap" and cycle "2".
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Protected Types

typedef std::atomic< TListOfEnums * > AListOfEnums_t
 
- Protected Types inherited from TDirectory
using SharedGDirectory_t = std::shared_ptr< std::atomic< TDirectory * > >
 Pointer to a list of TContext object pointing to this TDirectory.
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 

Protected Member Functions

 TROOT ()
 Only used by Dictionary.
 
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 * operator new (size_t l)
 
void * operator new (size_t l, void *ptr)
 
void ReadGitInfo ()
 Read Git commit SHA1 and branch name.
 
- Protected Member Functions inherited from TDirectory
 TDirectory (const TDirectory &directory)=delete
 
void BuildDirectory (TFile *motherFile, TDirectory *motherDir)
 Initialise directory to defaults.
 
Bool_t cd1 (const char *path)
 flag to add histograms, graphs,etc to the directory
 
void CleanTargets ()
 Clean the pointers to this object (gDirectory, TContext, etc.).
 
void FillFullPath (TString &buf) const
 Recursive method to fill full path for directory.
 
void operator= (const TDirectory &)=delete
 
void RegisterContext (TContext *ctxt)
 Register a TContext pointing to this TDirectory object.
 
void RegisterGDirectory (SharedGDirectory_t &ptr)
 Register a std::atomic<TDirectory*> that will soon be pointing to this TDirectory object.
 
void UnregisterContext (TContext *ctxt)
 UnRegister a TContext pointing to this TDirectory object.
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 

Protected Attributes

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

Private Member Functions

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

Private Attributes

Int_t fLineIsProcessing
 To synchronize multi-threads.
 

Static Private Attributes

static Int_t fgDirLevel = 0
 Indentation level for ls()
 
static Bool_t fgRootInit = kFALSE
 Singleton initialization flag.
 

Friends

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

Additional Inherited Members

- Static Protected Member Functions inherited from TDirectory
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 Protected Attributes inherited from TDirectory
static Bool_t fgAddDirectory = kTRUE
 MSVC doesn't support = ATOMIC_FLAG_INIT;.
 

#include <TROOT.h>

Inheritance diagram for TROOT:
[legend]

Member Typedef Documentation

◆ AListOfEnums_t

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

Definition at line 109 of file TROOT.h.

◆ FwdDeclArgsToKeepCollection_t

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

Definition at line 187 of file TROOT.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 605 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 639 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 867 of file TROOT.cxx.

Member Function Documentation

◆ 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 1025 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 1035 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 2952 of file TROOT.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 1047 of file TROOT.cxx.

◆ Browse()

void TROOT::Browse ( TBrowser b)
overridevirtual

Add browsable objects to TBrowser.

Reimplemented from TDirectory.

Definition at line 1056 of file TROOT.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 372 of file TROOT.h.

◆ 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 1083 of file TROOT.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 1168 of file TROOT.cxx.

◆ ConvertVersionCode2Int()

Int_t TROOT::ConvertVersionCode2Int ( Int_t  code)
static

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

Definition at line 2922 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 2930 of file TROOT.cxx.

◆ DeclFileName()

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

Definition at line 372 of file TROOT.h.

◆ DecreaseDirLevel()

Int_t TROOT::DecreaseDirLevel ( )
static

Decrease the indentation level for ls().

Definition at line 2746 of file TROOT.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 1248 of file TROOT.cxx.

◆ 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 1313 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 1287 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 1426 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 1436 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 1453 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 occurence 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 1473 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 1367 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 1484 of file TROOT.cxx.

◆ ForceStyle()

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

Definition at line 206 of file TROOT.h.

◆ FromPopUp()

Bool_t TROOT::FromPopUp ( ) const
inline

Definition at line 207 of file TROOT.h.

◆ GetApplication()

TApplication * TROOT::GetApplication ( ) const
inline

Definition at line 209 of file TROOT.h.

◆ GetBinDir()

const TString & TROOT::GetBinDir ( )
static

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

Definition at line 2989 of file TROOT.cxx.

◆ GetBuiltDate()

Int_t TROOT::GetBuiltDate ( ) const
inline

Definition at line 221 of file TROOT.h.

◆ GetBuiltTime()

Int_t TROOT::GetBuiltTime ( ) const
inline

Definition at line 222 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 1518 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 1528 of file TROOT.cxx.

◆ GetClipboard()

TSeqCollection * TROOT::GetClipboard ( ) const
inline

Definition at line 254 of file TROOT.h.

◆ GetColor()

TColor * TROOT::GetColor ( Int_t  color) const

Return address of color with index color.

Definition at line 1536 of file TROOT.cxx.

◆ GetConfigFeatures()

const char * TROOT::GetConfigFeatures ( ) const
inline

Definition at line 215 of file TROOT.h.

◆ GetConfigOptions()

const char * TROOT::GetConfigOptions ( ) const
inline

Definition at line 214 of file TROOT.h.

◆ GetCutClassName()

const char * TROOT::GetCutClassName ( ) const
inline

Definition at line 216 of file TROOT.h.

◆ GetDataDir()

const TString & TROOT::GetDataDir ( )
static

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

Definition at line 3062 of file TROOT.cxx.

◆ GetDefCanvasName()

const char * TROOT::GetDefCanvasName ( ) const
inline

Definition at line 217 of file TROOT.h.

◆ GetDirLevel()

Int_t TROOT::GetDirLevel ( )
static

return directory level

Definition at line 2754 of file TROOT.cxx.

◆ GetDocDir()

const TString & TROOT::GetDocDir ( )
static

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

Definition at line 3078 of file TROOT.cxx.

◆ GetEditHistograms()

Bool_t TROOT::GetEditHistograms ( ) const
inline

Definition at line 218 of file TROOT.h.

◆ GetEditorMode()

Int_t TROOT::GetEditorMode ( ) const
inline

Definition at line 219 of file TROOT.h.

◆ GetEtcDir()

const TString & TROOT::GetEtcDir ( )
static

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

Definition at line 3052 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 2962 of file TROOT.cxx.

◆ GetFile() [1/2]

TFile * TROOT::GetFile ( ) const
inlineoverridevirtual

Reimplemented from TDirectory.

Definition at line 260 of file TROOT.h.

◆ GetFile() [2/2]

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

Return pointer to file with name.

Definition at line 1570 of file TROOT.cxx.

◆ GetForceStyle()

Bool_t TROOT::GetForceStyle ( ) const
inline

Definition at line 220 of file TROOT.h.

◆ GetFunction()

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

Return pointer to function with name.

Definition at line 1587 of file TROOT.cxx.

◆ GetFunctionTemplate()

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

Definition at line 1618 of file TROOT.cxx.

◆ GetGeometry()

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

Return pointer to Geometry with name.

Definition at line 1747 of file TROOT.cxx.

◆ GetGitBranch()

const char * TROOT::GetGitBranch ( ) const
inline

Definition at line 224 of file TROOT.h.

◆ GetGitCommit()

const char * TROOT::GetGitCommit ( ) const
inline

Definition at line 223 of file TROOT.h.

◆ GetGitDate()

const char * TROOT::GetGitDate ( )

Return date/time make was run.

Definition at line 2474 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 1631 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 1639 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 1685 of file TROOT.cxx.

◆ GetGlobalFunctions()

TListOfFunctions * TROOT::GetGlobalFunctions ( )
protected

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

Definition at line 1663 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 1718 of file TROOT.cxx.

◆ GetIconPath()

const TString & TROOT::GetIconPath ( )
static

Get the icon path in the installation. Static utility function.

Definition at line 3168 of file TROOT.cxx.

◆ GetIncludeDir()

const TString & TROOT::GetIncludeDir ( )
static

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

Definition at line 3042 of file TROOT.cxx.

◆ GetInterpreter()

TInterpreter * TROOT::GetInterpreter ( ) const
inline

Definition at line 210 of file TROOT.h.

◆ GetLibDir()

const TString & TROOT::GetLibDir ( )
static

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

Definition at line 3010 of file TROOT.cxx.

◆ GetListOfBrowsables()

TList * TROOT::GetListOfBrowsables ( ) const
inline

Definition at line 258 of file TROOT.h.

◆ GetListOfBrowsers()

TSeqCollection * TROOT::GetListOfBrowsers ( ) const
inline

Definition at line 245 of file TROOT.h.

◆ GetListOfCanvases()

TSeqCollection * TROOT::GetListOfCanvases ( ) const
inline

Definition at line 240 of file TROOT.h.

◆ GetListOfClasses()

TCollection * TROOT::GetListOfClasses ( ) const
inline

Definition at line 231 of file TROOT.h.

◆ GetListOfClassGenerators()

TCollection * TROOT::GetListOfClassGenerators ( ) const
inline

Definition at line 251 of file TROOT.h.

◆ GetListOfCleanups()

TSeqCollection * TROOT::GetListOfCleanups ( ) const
inline

Definition at line 248 of file TROOT.h.

◆ GetListOfClosedObjects()

TSeqCollection * TROOT::GetListOfClosedObjects ( ) const
inline

Definition at line 236 of file TROOT.h.

◆ GetListOfColors()

TSeqCollection * TROOT::GetListOfColors ( ) const
inline

Definition at line 232 of file TROOT.h.

◆ GetListOfDataSets()

TSeqCollection * TROOT::GetListOfDataSets ( ) const
inline

Definition at line 255 of file TROOT.h.

◆ GetListOfEnums()

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

Definition at line 1754 of file TROOT.cxx.

◆ GetListOfFiles()

TSeqCollection * TROOT::GetListOfFiles ( ) const
inline

Definition at line 237 of file TROOT.h.

◆ GetListOfFunctionOverloads()

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

Return the collection of functions named "name".

Definition at line 1672 of file TROOT.cxx.

◆ GetListOfFunctions()

TCollection * TROOT::GetListOfFunctions ( ) const
inline

Definition at line 242 of file TROOT.h.

◆ GetListOfFunctionTemplates()

TCollection * TROOT::GetListOfFunctionTemplates ( )

Definition at line 1771 of file TROOT.cxx.

◆ GetListOfGeometries()

TSeqCollection * TROOT::GetListOfGeometries ( ) const
inline

Definition at line 244 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 1826 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 1788 of file TROOT.cxx.

◆ GetListOfMappedFiles()

TSeqCollection * TROOT::GetListOfMappedFiles ( ) const
inline

Definition at line 238 of file TROOT.h.

◆ GetListOfMessageHandlers()

TSeqCollection * TROOT::GetListOfMessageHandlers ( ) const
inline

Definition at line 250 of file TROOT.h.

◆ GetListOfProofs()

TSeqCollection * TROOT::GetListOfProofs ( ) const
inline

Definition at line 253 of file TROOT.h.

◆ GetListOfSecContexts()

TSeqCollection * TROOT::GetListOfSecContexts ( ) const
inline

Definition at line 252 of file TROOT.h.

◆ GetListOfSockets()

TSeqCollection * TROOT::GetListOfSockets ( ) const
inline

Definition at line 239 of file TROOT.h.

◆ GetListOfSpecials()

TSeqCollection * TROOT::GetListOfSpecials ( ) const
inline

Definition at line 246 of file TROOT.h.

◆ GetListOfStreamerInfo()

TSeqCollection * TROOT::GetListOfStreamerInfo ( ) const
inline

Definition at line 249 of file TROOT.h.

◆ GetListOfStyles()

TSeqCollection * TROOT::GetListOfStyles ( ) const
inline

Definition at line 241 of file TROOT.h.

◆ GetListOfTasks()

TSeqCollection * TROOT::GetListOfTasks ( ) const
inline

Definition at line 247 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 1865 of file TROOT.cxx.

◆ GetMacroDir()

const TString & TROOT::GetMacroDir ( )
static

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

Definition at line 3094 of file TROOT.cxx.

◆ GetMacroPath()

const char * TROOT::GetMacroPath ( )
static

Get macro search path. Static utility function.

Definition at line 2762 of file TROOT.cxx.

◆ GetNclasses()

Int_t TROOT::GetNclasses ( ) const

Get number of classes.

Definition at line 1876 of file TROOT.cxx.

◆ GetNtypes()

Int_t TROOT::GetNtypes ( ) const

Get number of types.

Definition at line 1884 of file TROOT.cxx.

◆ GetPluginManager()

TPluginManager * TROOT::GetPluginManager ( ) const
inline

Definition at line 208 of file TROOT.h.

◆ GetRootFolder()

TFolder * TROOT::GetRootFolder ( ) const
inline

Definition at line 274 of file TROOT.h.

◆ GetRootSys()

const TString & TROOT::GetRootSys ( )
static

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

Definition at line 2979 of file TROOT.cxx.

◆ GetSelectedPad()

TVirtualPad * TROOT::GetSelectedPad ( ) const
inline

Definition at line 271 of file TROOT.h.

◆ GetSelectedPrimitive()

const TObject * TROOT::GetSelectedPrimitive ( ) const
inline

Definition at line 270 of file TROOT.h.

◆ GetSharedLibDir()

const TString & TROOT::GetSharedLibDir ( )
static

Get the shared libraries directory in the installation. Static utility function.

Definition at line 3031 of file TROOT.cxx.

◆ GetSourceDir()

const TString & TROOT::GetSourceDir ( )
static

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

Definition at line 3147 of file TROOT.cxx.

◆ GetStyle()

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

Return pointer to style with name.

Definition at line 1579 of file TROOT.cxx.

◆ GetTTFFontDir()

const TString & TROOT::GetTTFFontDir ( )
static

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

Definition at line 3189 of file TROOT.cxx.

◆ GetTutorialDir()

const TString & TROOT::GetTutorialDir ( )
static

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

Definition at line 3115 of file TROOT.cxx.

◆ GetTutorialsDir()

const char * TROOT::GetTutorialsDir ( )
static

Get the tutorials directory in the installation.

Static utility function. Backward compatibility function - do not use for new code

Definition at line 3211 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 1562 of file TROOT.cxx.

◆ GetUUIDs()

TProcessUUID * TROOT::GetUUIDs ( ) const
inline

Definition at line 275 of file TROOT.h.

◆ GetVersion()

const char * TROOT::GetVersion ( ) const
inline

Definition at line 230 of file TROOT.h.

◆ GetVersionCode()

Int_t TROOT::GetVersionCode ( ) const
inline

Definition at line 229 of file TROOT.h.

◆ GetVersionDate()

Int_t TROOT::GetVersionDate ( ) const
inline

Definition at line 226 of file TROOT.h.

◆ GetVersionInt()

Int_t TROOT::GetVersionInt ( ) const
inline

Definition at line 228 of file TROOT.h.

◆ GetVersionTime()

Int_t TROOT::GetVersionTime ( ) const
inline

Definition at line 227 of file TROOT.h.

◆ GetWebDisplay()

const TString & TROOT::GetWebDisplay ( ) const
inline

Definition at line 276 of file TROOT.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 1892 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 1928 of file TROOT.cxx.

◆ IncreaseDirLevel()

Int_t TROOT::IncreaseDirLevel ( )
static

Increase the indentation level for ls().

Definition at line 2883 of file TROOT.cxx.

◆ IndentLevel()

void TROOT::IndentLevel ( )
static

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

Definition at line 2891 of file TROOT.cxx.

◆ Initialize()

void TROOT::Initialize ( )
static

Initialize ROOT explicitly.

Definition at line 2899 of file TROOT.cxx.

◆ Initialized()

Bool_t TROOT::Initialized ( )
static

Return kTRUE if the TROOT object has been initialized.

Definition at line 2906 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.

Definition at line 2064 of file TROOT.cxx.

◆ InitSystem()

void TROOT::InitSystem ( )
protected

Operating System interface.

Initialize operating system interface.

Definition at line 1978 of file TROOT.cxx.

◆ InitThreads()

void TROOT::InitThreads ( )
protected

Initialize threads library.

Load and initialize thread library.

Definition at line 2053 of file TROOT.cxx.

◆ IsA()

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

Reimplemented from TDirectory.

Definition at line 372 of file TROOT.h.

◆ IsBatch()

Bool_t TROOT::IsBatch ( ) const
inline

Definition at line 279 of file TROOT.h.

◆ IsEscaped()

Bool_t TROOT::IsEscaped ( ) const
inline

Definition at line 283 of file TROOT.h.

◆ IsExecutingMacro()

Bool_t TROOT::IsExecutingMacro ( ) const
inline

Definition at line 280 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 281 of file TROOT.h.

◆ IsInterrupted()

Bool_t TROOT::IsInterrupted ( ) const
inline

Definition at line 282 of file TROOT.h.

◆ IsLineProcessing()

Bool_t TROOT::IsLineProcessing ( ) const
inline

Definition at line 284 of file TROOT.h.

◆ IsProofServ()

Bool_t TROOT::IsProofServ ( ) const
inline

Definition at line 285 of file TROOT.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 2230 of file TROOT.cxx.

◆ IsWebDisplay()

Bool_t TROOT::IsWebDisplay ( ) const
inline

Definition at line 287 of file TROOT.h.

◆ IsWebDisplayBatch()

Bool_t TROOT::IsWebDisplayBatch ( ) const
inline

Definition at line 288 of file TROOT.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 2183 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 2167 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 2268 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 2250 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 2316 of file TROOT.cxx.

◆ MakeDefCanvas()

TCanvas * TROOT::MakeDefCanvas ( ) const

Return a default canvas.

Definition at line 1554 of file TROOT.cxx.

◆ Message()

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

Process message id called by obj.

Definition at line 2350 of file TROOT.cxx.

◆ MustClean()

Bool_t TROOT::MustClean ( ) const
inline

Definition at line 296 of file TROOT.h.

◆ operator new() [1/2]

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

Definition at line 178 of file TROOT.h.

◆ operator new() [2/2]

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

Definition at line 179 of file TROOT.h.

◆ operator=()

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

◆ 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 2370 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 2407 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 2390 of file TROOT.cxx.

◆ 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 2429 of file TROOT.cxx.

◆ ReadingObject()

Bool_t TROOT::ReadingObject ( ) const

Deprecated (will be removed in next release).

Definition at line 2460 of file TROOT.cxx.

◆ 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 2498 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 2512 of file TROOT.cxx.

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

Definition at line 2535 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 2618 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 2628 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 2651 of file TROOT.cxx.

◆ ResetClassSaved()

void TROOT::ResetClassSaved ( )

Reset the ClassSaved status of all classes.

Definition at line 1096 of file TROOT.cxx.

◆ RootVersionCode()

Int_t TROOT::RootVersionCode ( )
static

Return ROOT version code as defined in RVersion.h.

Definition at line 2941 of file TROOT.cxx.

◆ SaveContext()

void TROOT::SaveContext ( )

Save the current interpreter context.

Definition at line 2671 of file TROOT.cxx.

◆ SetApplication()

void TROOT::SetApplication ( TApplication app)
inline

Definition at line 317 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.

If web graphics runs in server mode, the web widgets are still available via URL

Definition at line 2803 of file TROOT.cxx.

◆ 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 2683 of file TROOT.cxx.

◆ SetDefCanvasName()

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

Definition at line 321 of file TROOT.h.

◆ SetDirLevel()

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

Return Indentation level for ls().

Definition at line 2914 of file TROOT.cxx.

◆ SetEditHistograms()

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

Definition at line 322 of file TROOT.h.

◆ SetEditorMode()

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

Set editor mode.

Definition at line 2704 of file TROOT.cxx.

◆ SetEscape()

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

Definition at line 327 of file TROOT.h.

◆ SetExecutingMacro()

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

Definition at line 324 of file TROOT.h.

◆ SetFromPopUp()

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

Definition at line 325 of file TROOT.h.

◆ SetInterrupt()

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

Definition at line 326 of file TROOT.h.

◆ SetLineHasBeenProcessed()

void TROOT::SetLineHasBeenProcessed ( )
inline

Definition at line 329 of file TROOT.h.

◆ SetLineIsProcessing()

void TROOT::SetLineIsProcessing ( )
inline

Definition at line 328 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 2788 of file TROOT.cxx.

◆ SetMustClean()

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

Definition at line 331 of file TROOT.h.

◆ SetReadingObject()

void TROOT::SetReadingObject ( Bool_t  flag = kTRUE)

Definition at line 2465 of file TROOT.cxx.

◆ SetSelectedPad()

void TROOT::SetSelectedPad ( TVirtualPad pad)
inline

Definition at line 333 of file TROOT.h.

◆ SetSelectedPrimitive()

void TROOT::SetSelectedPrimitive ( const TObject obj)
inline

Definition at line 332 of file TROOT.h.

◆ SetStyle()

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

Change current style to style with name stylename.

Definition at line 2730 of file TROOT.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
  • "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
  • "qt5": uses QWebEngine from Qt5, no real http server started (requires qt5web component build for ROOT)
  • "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 on of available local (without http server) engines like qt5/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

Definition at line 2831 of file TROOT.cxx.

◆ ShutDown()

void TROOT::ShutDown ( )
static

Shut down ROOT.

Definition at line 3136 of file TROOT.cxx.

◆ Streamer()

void TROOT::Streamer ( TBuffer R__b)
overridevirtual

TDirectory Streamer.

Reimplemented from TDirectory.

◆ StreamerNVirtual()

void TROOT::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 372 of file TROOT.h.

◆ Time()

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

Definition at line 335 of file TROOT.h.

◆ Timer()

Int_t TROOT::Timer ( ) const
inline

Definition at line 336 of file TROOT.h.

Friends And Related Symbol Documentation

◆ ::ROOT::Internal::TROOTAllocator

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

Definition at line 181 of file TROOT.h.

◆ ROOT::Internal::GetROOT2

◆ TCling

friend class TCling
friend

Definition at line 96 of file TROOT.h.

Member Data Documentation

◆ fApplication

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

Pointer to current application.

Definition at line 124 of file TROOT.h.

◆ fBatch

Bool_t TROOT::fBatch
protected

True if session without graphics.

Definition at line 126 of file TROOT.h.

◆ fBrowsables

TList* TROOT::fBrowsables
protected

List of browsables.

Definition at line 168 of file TROOT.h.

◆ fBrowsers

TSeqCollection* TROOT::fBrowsers
protected

List of browsers.

Definition at line 155 of file TROOT.h.

◆ fBuiltDate

Int_t TROOT::fBuiltDate
protected

Date of ROOT built.

Definition at line 118 of file TROOT.h.

◆ fBuiltTime

Int_t TROOT::fBuiltTime
protected

Time of ROOT built.

Definition at line 119 of file TROOT.h.

◆ fCanvases

TSeqCollection* TROOT::fCanvases
protected

List of canvases.

Definition at line 149 of file TROOT.h.

◆ fClasses

TCollection* TROOT::fClasses
protected

List of classes definition.

Definition at line 140 of file TROOT.h.

◆ fClassGenerators

TCollection* TROOT::fClassGenerators
protected

List of user defined class generators;.

Definition at line 160 of file TROOT.h.

◆ fCleanups

TSeqCollection* TROOT::fCleanups
protected

List of recursiveRemove collections.

Definition at line 157 of file TROOT.h.

◆ fClipboard

TSeqCollection* TROOT::fClipboard
protected

List of clipboard objects.

Definition at line 163 of file TROOT.h.

◆ fClosedObjects

TSeqCollection* TROOT::fClosedObjects
protected

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

Definition at line 145 of file TROOT.h.

◆ fColors

TSeqCollection* TROOT::fColors
protected

List of colors.

Definition at line 153 of file TROOT.h.

◆ fConfigFeatures

TString TROOT::fConfigFeatures
protected

ROOT ./configure detected build features.

Definition at line 112 of file TROOT.h.

◆ fConfigOptions

TString TROOT::fConfigOptions
protected

ROOT ./configure set build options.

Definition at line 111 of file TROOT.h.

◆ fCutClassName

TString TROOT::fCutClassName
protected

Name of default CutG class in graphics editor.

Definition at line 170 of file TROOT.h.

◆ fDataSets

TSeqCollection* TROOT::fDataSets
protected

List of data sets (TDSet or TChain)

Definition at line 164 of file TROOT.h.

◆ fDefCanvasName

TString TROOT::fDefCanvasName
protected

Name of default canvas.

Definition at line 171 of file TROOT.h.

◆ fEditHistograms

Bool_t TROOT::fEditHistograms
protected

True if histograms can be edited with the mouse.

Definition at line 130 of file TROOT.h.

◆ fEditorMode

Int_t TROOT::fEditorMode
protected

Current Editor mode.

Definition at line 137 of file TROOT.h.

◆ fEnums

AListOfEnums_t TROOT::fEnums
protected

List of enum types.

Definition at line 165 of file TROOT.h.

◆ fEscape

Bool_t TROOT::fEscape
protected

True if ESC has been pressed.

Definition at line 135 of file TROOT.h.

◆ fExecutingMacro

Bool_t TROOT::fExecutingMacro
protected

True while executing a TMacro.

Definition at line 136 of file TROOT.h.

◆ fFiles

TSeqCollection* TROOT::fFiles
protected

List of files.

Definition at line 146 of file TROOT.h.

◆ fForceStyle

Bool_t TROOT::fForceStyle
protected

Force setting of current style when reading objects.

Definition at line 133 of file TROOT.h.

◆ fFromPopUp

Bool_t TROOT::fFromPopUp
protected

True if command executed from a popup menu.

Definition at line 131 of file TROOT.h.

◆ fFuncTemplate

TListOfFunctionTemplates* TROOT::fFuncTemplate
protected

List of global function templates.

Definition at line 142 of file TROOT.h.

◆ fFunctions

TCollection* TROOT::fFunctions
protected

List of analytic functions.

Definition at line 151 of file TROOT.h.

◆ fgDirLevel

Int_t TROOT::fgDirLevel = 0
staticprivate

Indentation level for ls()

Definition at line 102 of file TROOT.h.

◆ fGeometries

TSeqCollection* TROOT::fGeometries
protected

List of geometries.

Definition at line 154 of file TROOT.h.

◆ fGitBranch

TString TROOT::fGitBranch
protected

Git branch.

Definition at line 121 of file TROOT.h.

◆ fGitCommit

TString TROOT::fGitCommit
protected

Git commit SHA1 of built.

Definition at line 120 of file TROOT.h.

◆ fGitDate

TString TROOT::fGitDate
protected

Date and time when make was run.

Definition at line 122 of file TROOT.h.

◆ fGlobalFunctions

TListOfFunctions* TROOT::fGlobalFunctions
protected

List of global functions.

Definition at line 144 of file TROOT.h.

◆ fGlobals

TListOfDataMembers* TROOT::fGlobals
protected

List of global variables.

Definition at line 143 of file TROOT.h.

◆ fgRootInit

Bool_t TROOT::fgRootInit = kFALSE
staticprivate

Singleton initialization flag.

Definition at line 103 of file TROOT.h.

◆ fInterpreter

TInterpreter* TROOT::fInterpreter
protected

Command interpreter.

Definition at line 125 of file TROOT.h.

◆ fInterrupt

Bool_t TROOT::fInterrupt
protected

True if macro should be interrupted.

Definition at line 134 of file TROOT.h.

◆ fIsWebDisplay

Bool_t TROOT::fIsWebDisplay
protected

True if session uses web widgets.

Definition at line 128 of file TROOT.h.

◆ fIsWebDisplayBatch

Bool_t TROOT::fIsWebDisplayBatch
protected

True if web widgets are not displayed.

Definition at line 129 of file TROOT.h.

◆ fLineIsProcessing

Int_t TROOT::fLineIsProcessing
private

To synchronize multi-threads.

Definition at line 100 of file TROOT.h.

◆ fMappedFiles

TSeqCollection* TROOT::fMappedFiles
protected

List of memory mapped files.

Definition at line 147 of file TROOT.h.

◆ fMessageHandlers

TSeqCollection* TROOT::fMessageHandlers
protected

List of message handlers.

Definition at line 158 of file TROOT.h.

◆ fMustClean

Bool_t TROOT::fMustClean
protected

True if object destructor scans canvases.

Definition at line 132 of file TROOT.h.

◆ fPluginManager

TPluginManager* TROOT::fPluginManager
protected

Keeps track of plugin library handlers.

Definition at line 169 of file TROOT.h.

◆ fPrimitive

const TObject* TROOT::fPrimitive
protected

Currently selected primitive.

Definition at line 138 of file TROOT.h.

◆ fProofs

TSeqCollection* TROOT::fProofs
protected

List of proof sessions.

Definition at line 162 of file TROOT.h.

◆ fRootFolder

TFolder* TROOT::fRootFolder
protected

top level folder //root

Definition at line 167 of file TROOT.h.

◆ fSecContexts

TSeqCollection* TROOT::fSecContexts
protected

List of security contexts (TSecContext)

Definition at line 161 of file TROOT.h.

◆ fSelectPad

TVirtualPad* TROOT::fSelectPad
protected

Currently selected pad.

Definition at line 139 of file TROOT.h.

◆ fSockets

TSeqCollection* TROOT::fSockets
protected

List of network sockets.

Definition at line 148 of file TROOT.h.

◆ fSpecials

TSeqCollection* TROOT::fSpecials
protected

List of special objects.

Definition at line 156 of file TROOT.h.

◆ fStreamerInfo

TSeqCollection* TROOT::fStreamerInfo
protected

List of active StreamerInfo classes.

Definition at line 159 of file TROOT.h.

◆ fStyles

TSeqCollection* TROOT::fStyles
protected

List of styles.

Definition at line 150 of file TROOT.h.

◆ fTasks

TSeqCollection* TROOT::fTasks
protected

List of tasks.

Definition at line 152 of file TROOT.h.

◆ fTimer

Int_t TROOT::fTimer
protected

Timer flag.

Definition at line 123 of file TROOT.h.

◆ fTypes

TCollection* TROOT::fTypes
protected

List of data types definition.

Definition at line 141 of file TROOT.h.

◆ fUUIDs

TProcessUUID* TROOT::fUUIDs
protected

Pointer to TProcessID managing TUUIDs.

Definition at line 166 of file TROOT.h.

◆ fVersion

TString TROOT::fVersion
protected

ROOT version (from CMZ VERSQQ) ex 0.05/01.

Definition at line 113 of file TROOT.h.

◆ fVersionCode

Int_t TROOT::fVersionCode
protected

ROOT version code as used in RVersion.h.

Definition at line 115 of file TROOT.h.

◆ fVersionDate

Int_t TROOT::fVersionDate
protected

Date of ROOT version (ex 951226)

Definition at line 116 of file TROOT.h.

◆ fVersionInt

Int_t TROOT::fVersionInt
protected

ROOT version in integer format (501)

Definition at line 114 of file TROOT.h.

◆ fVersionTime

Int_t TROOT::fVersionTime
protected

Time of ROOT version (ex 1152)

Definition at line 117 of file TROOT.h.

◆ fWebDisplay

TString TROOT::fWebDisplay
protected

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

Definition at line 127 of file TROOT.h.

  • core/base/inc/TROOT.h
  • core/base/src/TROOT.cxx