TDirectory Class Reference

Describe directory structure in memory.

Python interface

It is possible to retrieve the content of a TDirectory object just like getting items from a Python dictionary. Moreover, once a subdirectory or object is accessed for the first time, it is cached for later use. For example, assuming d is a TDirectory instance:

# Access a subdirectory
d["subdir"]
 
# We can go further down in the hierarchy of directories
d["subdir"]["subsubdir"]
 
# Access an object (e.g. a histogram) in the directory
d["obj"]
 
# ... or in a subdirectory
d["subdir"]["obj"]
 
# Wrong key: raises KeyError
d["wrongAttr"]

Furthermore, TDirectory implements a WriteObject Python method which relies on TDirectory::WriteObjectAny. This method is a no-op for TDirectory objects, but it is useful for objects of TDirectory subclasses such as TDirectoryFile and TFile, which inherit it. Please refer to the documentation of those classes for more information.

Definition at line 45 of file TDirectory.h.

Classes
class	TContext
	TDirectory::TContext keeps track and restore the current directory. More...

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

Public Member Functions
	TDirectory ()
	Directory default constructor.
	TDirectory (const char *name, const char *title, Option_t *option="", TDirectory *motherDir=nullptr)
	Create a new Directory.
virtual	~TDirectory ()
	Destructor.
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.
virtual void	Append (TObject *obj, Bool_t replace=kFALSE)
	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
	Browse the content of the directory.
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.
void	Clear (Option_t *option="") override
	Delete all objects from a Directory list.
TObject *	Clone (const char *newname="") const override
	Make a clone of an object using the Streamer facility.
virtual TObject *	CloneObject (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.
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 TObject *	DrawClone (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 void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.
virtual TKey *	FindKey (const char *) const
virtual TKey *	FindKeyAny (const char *) const
TObject *	FindObject (const char *name) const override
	Find object by name in the list of memory objects.
TObject *	FindObject (const TObject *obj) const override
	Find object in the list of memory objects.
virtual TObject *	FindObjectAny (const char *name) const
	Find object by name in the list of memory objects of the current directory or its sub-directories.
virtual TObject *	FindObjectAnyFile (const char *) const
template<class T>
T *	Get (const char *namecycle)
	See documentation of TDirectoryFile::Get(const char *namecycle).
virtual TObject *	Get (const char *namecycle)
	Return pointer to object identified by namecycle.
virtual Int_t	GetBufferSize () const
virtual TDirectory *	GetDirectory (const char *namecycle, Bool_t printError=false, const char *funcname="GetDirectory")
	Find a directory using apath.
virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.
virtual TFile *	GetFile () const
virtual const char *	GetIconName () const
	Returns mime type name of object.
virtual TKey *	GetKey (const char *, Short_t=9999) const
virtual TList *	GetList () const
virtual TList *	GetListOfKeys () const
TObject *	GetMother () const
TDirectory *	GetMotherDir () const
const char *	GetName () const override
	Returns name of object.
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 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_t *	GetOption () 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.
virtual Long64_t	GetSeekDir () const
virtual Long64_t	GetSeekKeys () const
virtual Long64_t	GetSeekParent () const
const char *	GetTitle () const override
	Returns title of object.
virtual UInt_t	GetUniqueID () const
	Return the unique object id.
TUUID	GetUUID () 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.
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)
TClass *	IsA () const override
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	IsFolder () const override
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
virtual Bool_t	IsModified () const
Bool_t	IsOnHeap () const
Bool_t	IsSortable () const override
virtual Bool_t	IsWritable () const
Bool_t	IsZombie () const
void	ls (Option_t *option="") const override
	List Directory contents.
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 TDirectory *	mkdir (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 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 TFile *	OpenFile (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 *	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.
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 *="")
virtual Int_t	ReadKeys (Bool_t=kTRUE)
virtual Int_t	ReadTObject (TObject *, const char *)
void	RecursiveRemove (TObject *obj) override
	Recursively remove object from a Directory.
virtual TObject *	Remove (TObject *)
	Remove an object from the in-memory list.
void	ResetBit (UInt_t f)
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.
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	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)
virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.
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	SetNameTitle (const char *name, const char *title)
	Set all the TNamed parameters (name and title).
virtual void	SetSeekDir (Long64_t)
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.
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
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_t >	WriteObject (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_t >	WriteObject (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 Bool_t	Cd (const char *path)
static TClass *	Class ()
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 size_t	DecodeNameCycle (const char *namecycle, char *name, Short_t &cycle, const size_t namesize=0)
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
enum	{ kOnlyPrepStep = (1ULL << (3)) }
using	SharedGDirectory_t = std::shared_ptr<std::atomic<TDirectory *>>

Protected Member Functions
	TDirectory (const TDirectory &directory)=delete
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.
void	MakeZombie ()
void	operator= (const TDirectory &)=delete
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_t &	GetSharedLocalCurrentDirectory ()
	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
TContext *	fContext {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.
std::vector< SharedGDirectory_t >	fGDirectories
	! thread local gDirectory pointing to this object.
TList *	fList {nullptr}
	List of objects in memory.
TObject *	fMother {nullptr}
	pointer to mother of the directory
TString	fName
TString	fPathBuffer
	! Buffer for GetPath() function
std::atomic_flag	fSpinLock
	! MSVC doesn't support = ATOMIC_FLAG_INIT;
TString	fTitle
TUUID	fUUID {TUUID::UUIDv4()}
	Unique identifier.

Static Protected Attributes
static Bool_t	fgAddDirectory = false
	!

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
UInt_t	fUniqueID
	object unique identifier

Static Private Attributes
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

Friends
struct	ROOT::Internal::TDirectoryAtomicAdapter
class	TContext

#include <TDirectory.h>

Inheritance diagram for TDirectory:

Member Typedef Documentation

SharedGDirectory_t

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

protected

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

enum TObject::EDeprecatedStatusBits

inherited

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

TDirectory() [1/3]

TDirectory::TDirectory ( const TDirectory & directory )

protecteddelete

TDirectory() [2/3]

TDirectory::TDirectory

(

)

Directory default constructor.

Definition at line 53 of file TDirectory.cxx.

TDirectory() [3/3]

TDirectory::TDirectory	(	const char *	name,
		const char *	title,
		Option_t *	option = "",
		TDirectory *	initMotherDir = nullptr )

Create a new Directory.

A new directory with name,title is created in the current directory The directory header information is immediately saved in the file A new key is added in the parent directory

When this constructor is called from a class directly derived from TDirectory, the third argument classname MUST be specified. In this case, classname must be the name of the derived class.

Note that the directory name cannot contain slashes.

Definition at line 72 of file TDirectory.cxx.

~TDirectory()

TDirectory::~TDirectory ( )

virtual

Destructor.

Definition at line 97 of file TDirectory.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" )

static

_R__DEPRECATED_() [2/2]

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

static

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 )

inlinevirtual

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.

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 TDirectory::Append ( TObject * obj, Bool_t replace = kFALSE )

virtual

Append object to this directory.

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

Reimplemented in RooWorkspace::WSDir, TDirectoryFile, and TROOT.

Definition at line 203 of file TDirectory.cxx.

AppendKey()

virtual Int_t TDirectory::AppendKey ( TKey * )

inlinevirtual

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 TDirectory::Browse ( TBrowser * b )

overridevirtual

Browse the content of the directory.

Reimplemented from TObject.

Reimplemented in TDirectoryFile, and TROOT.

Definition at line 233 of file TDirectory.cxx.

Build()

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

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 187 of file TDirectory.h.

BuildDirectory()

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

protected

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 )

static

cd() [1/2]

Bool_t TDirectory::cd ( )

virtual

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 )

virtual

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 )

staticprotected

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 )

protected

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

static

Returns

TClass describing this class

Class_Name()

const char * TDirectory::Class_Name ( )

static

Returns

Name of this class

Class_Version()

constexpr Version_t TDirectory::Class_Version ( )

inlinestaticconstexpr

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.

CleanTargets()

void TDirectory::CleanTargets ( )

protected

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

Definition at line 270 of file TDirectory.cxx.

Clear()

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

overridevirtual

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 )

virtual

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 = "" )

virtual

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.

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.

Copy()

void TDirectory::Copy ( TObject & object ) const

inlineoverridevirtual

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

static

Return the current directory for the current thread.

Definition at line 438 of file TDirectory.cxx.

DeclFileName()

const char * TDirectory::DeclFileName ( )

inlinestatic

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 )

static

Delete()

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

overridevirtual

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 = "" )

virtual

Delete all objects from memory.

Definition at line 691 of file TDirectory.cxx.

DistancetoPrimitive()

Int_t TObject::DistancetoPrimitive ( Int_t px, Int_t py )

virtualinherited

Computes distance from point (px,py) to the object.

This member function must be implemented for each graphics primitive. This default function returns a big number (999999).

Reimplemented in TASImage, TAxis3D, TAxis, TBox, TBRIK, TColorWheel, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFileDrawMap, TGenerator, TGeoBBox, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoEltu, TGeoHalfSpace, TGeoHype, TGeoNode, TGeoOverlap, TGeoParaboloid, TGeoPcon, TGeoPgon, TGeoScaledShape, TGeoShape, TGeoShapeAssembly, TGeoSphere, TGeoTessellated, TGeoTorus, TGeoTrack, TGeoTube, TGeoTubeSeg, TGeoVGShape, TGeoVolume, TGeoXtru, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TH1, THistPainter, THStack, TLine, TMarker3DBox, TMarker, TMultiGraph, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPCON, TPie, TPieSlice, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSPHE, TSpider, TSpline, TStyle, TText, TTreePerfStats, TTUBE, TTUBS, TVirtualHistPainter, and TXTRU.

Definition at line 284 of file TObject.cxx.

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 = "" )

overridevirtual

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

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

Definition at line 367 of file TObject.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

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

Definition at line 398 of file TObject.cxx.

ExecuteEvent()

void TObject::ExecuteEvent ( Int_t event, Int_t px, Int_t py )

virtualinherited

Execute action corresponding to an event at (px,py).

This method must be overridden if an object can react to graphics events.

Reimplemented in TASImage, TASPaletteEditor::LimitLine, TAxis3D, TAxis, TBox, TButton, TCanvas, TCrown, TCurlyArc, TCurlyLine, TDiamond, TEfficiency, TEllipse, TF1, TF2, TF3, TFrame, TGenerator, TGeoManager, TGeoNode, TGeoOverlap, TGeoShape, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLEventHandler, TGLHistPainter, TGLParametricEquation, TGLScenePad, TGLTH3Composition, TGLViewer, TGraph2D, TGraph, TGraphEdge, TGraphNode, TGraphPolargram, TGroupButton, TH1, THistPainter, TLine, TLink, TMarker3DBox, TMarker, TNode, TPad, TPaletteAxis, TParallelCoord, TParallelCoordRange, TParallelCoordVar, TParticle, TPave, TPie, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPrimary, TScatter2D, TScatter, TSliderBox, TSpider, TSpline, TText, TTreePerfStats, TView3D, TView, TVirtualHistPainter, and TWbox.

Definition at line 415 of file TObject.cxx.

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

protected

Recursive method to fill full path for directory.

Definition at line 1067 of file TDirectory.cxx.

FindKey()

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

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 198 of file TDirectory.h.

FindKeyAny()

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

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 199 of file TDirectory.h.

FindObject() [1/2]

TObject * TDirectory::FindObject ( const char * name ) const

overridevirtual

Find object by name in the list of memory objects.

Reimplemented from TObject.

Reimplemented in TROOT.

Definition at line 790 of file TDirectory.cxx.

FindObject() [2/2]

TObject * TDirectory::FindObject ( const TObject * obj ) const

overridevirtual

Find object in the list of memory objects.

Reimplemented from TObject.

Reimplemented in TROOT.

Definition at line 782 of file TDirectory.cxx.

FindObjectAny()

TObject * TDirectory::FindObjectAny ( const char * aname ) const

virtual

Find object by name in the list of memory objects of the current directory or its sub-directories.

After this call the current directory is not changed. To automatically set the current directory where the object is found, use FindKeyAny(aname)->ReadObj().

Reimplemented in TDirectoryFile, and TROOT.

Definition at line 802 of file TDirectory.cxx.

FindObjectAnyFile()

virtual TObject * TDirectory::FindObjectAnyFile ( const char * ) const

inlinevirtual

Reimplemented in TDirectoryFile, and TROOT.

Definition at line 203 of file TDirectory.h.

Get() [1/2]

template<class T>

T * TDirectory::Get ( const char * namecycle )

inline

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 )

virtual

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

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.

GetBufferSize()

virtual Int_t TDirectory::GetBufferSize ( ) const

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 220 of file TDirectory.h.

GetDirectory()

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

virtual

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.

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.

GetFile()

virtual TFile * TDirectory::GetFile ( ) const

inlinevirtual

Reimplemented in TDirectoryFile, and TROOT.

Definition at line 221 of file TDirectory.h.

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.

GetKey()

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

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 222 of file TDirectory.h.

GetList()

virtual TList * TDirectory::GetList ( ) const

inlinevirtual

Definition at line 223 of file TDirectory.h.

GetListOfKeys()

virtual TList * TDirectory::GetListOfKeys ( ) const

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 224 of file TDirectory.h.

GetMother()

TObject * TDirectory::GetMother ( ) const

inline

Definition at line 225 of file TDirectory.h.

GetMotherDir()

TDirectory * TDirectory::GetMotherDir ( ) const

inline

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

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 227 of file TDirectory.h.

GetNkeys()

virtual Int_t TDirectory::GetNkeys ( ) const

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 228 of file TDirectory.h.

GetObject()

template<class T>

void TDirectory::GetObject ( const char * namecycle, T *& ptr )

inline

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 )

virtual

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 )

virtual

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

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 )

virtual

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

Reimplemented in TArrow, TAxis3D, TFile, TGaxis, TGeoVolume, TH1, THelix, TLegendEntry, TMapFile, TNode, TPave, TPoints3DABC, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TPSocket, TSelector, TSocket, and TUDPSocket.

Definition at line 147 of file TObject.h.

GetPath()

const char * TDirectory::GetPath ( ) const

virtual

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

virtual

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.

GetSeekDir()

virtual Long64_t TDirectory::GetSeekDir ( ) const

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 229 of file TDirectory.h.

GetSeekKeys()

virtual Long64_t TDirectory::GetSeekKeys ( ) const

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 231 of file TDirectory.h.

GetSeekParent()

virtual Long64_t TDirectory::GetSeekParent ( ) const

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 230 of file TDirectory.h.

GetSharedLocalCurrentDirectory()

TDirectory::SharedGDirectory_t & TDirectory::GetSharedLocalCurrentDirectory ( )

staticprotected

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.

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.

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

inline

Definition at line 234 of file TDirectory.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

ROOT::CallRecursiveRemoveIfNeeded(*this)

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.

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.

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.

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

inlineoverridevirtual

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.

IsBuilt()

Bool_t TDirectory::IsBuilt ( ) const

inline

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.

IsFolder()

Bool_t TDirectory::IsFolder ( ) const

inlineoverridevirtual

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

Reimplemented from TObject.

Reimplemented in TROOT.

Definition at line 236 of file TDirectory.h.

IsModified()

virtual Bool_t TDirectory::IsModified ( ) const

inlinevirtual

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.

IsSortable()

Bool_t TNamed::IsSortable ( ) const

inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

IsWritable()

virtual Bool_t TDirectory::IsWritable ( ) const

inlinevirtual

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.

ls()

void TDirectory::ls ( Option_t * option = "" ) const

overridevirtual

List Directory contents.

Indentation is used to identify the directory tree Subdirectories are listed first, then objects in memory.

The option can has the following format:

 [<regexp>]

The <regexp> will be used to match the name of the objects. By default memory and disk objects are listed.

Reimplemented from TObject.

Reimplemented in TDirectoryFile, TFile, and TROOT.

Definition at line 1153 of file TDirectory.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.

mkdir()

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

virtual

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

Parameters

name	the name or hierarchy of the subdirectory ("a" or "a/b/c")
title	the title
returnExistingDirectory	if 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");

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.

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 )

inlinevirtual

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 * TObject::operator new ( size_t sz )

inlineinherited

Definition at line 189 of file TObject.h.

operator new() [2/2]

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

inlineinherited

Definition at line 191 of file TObject.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=()

void TDirectory::operator= ( const TDirectory & )

protecteddelete

Paint()

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

overridevirtual

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

overridevirtual

Print all objects in the directory.

Reimplemented from TObject.

Reimplemented in TFile, TMemFile, TSQLFile, and TXMLFile.

Definition at line 1197 of file TDirectory.cxx.

Purge()

virtual void TDirectory::Purge ( Short_t = 1 )

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 246 of file TDirectory.h.

pwd()

void TDirectory::pwd ( ) const

virtual

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 * = "" )

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 248 of file TDirectory.h.

ReadKeys()

virtual Int_t TDirectory::ReadKeys ( Bool_t = kTRUE )

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 249 of file TDirectory.h.

ReadTObject()

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

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 250 of file TDirectory.h.

RecursiveRemove()

void TDirectory::RecursiveRemove ( TObject * obj )

overridevirtual

Recursively remove object from a Directory.

Reimplemented from TObject.

Reimplemented in TROOT.

Definition at line 1213 of file TDirectory.cxx.

RegisterContext()

void TDirectory::RegisterContext ( TContext * ctxt )

protected

RegisterGDirectory()

void TDirectory::RegisterGDirectory ( SharedGDirectory_t & ptr )

protected

Remove()

TObject * TDirectory::Remove ( TObject * obj )

virtual

Remove an object from the in-memory list.

Reimplemented in TROOT.

Definition at line 1222 of file TDirectory.cxx.

ResetBit()

void TObject::ResetBit ( UInt_t f )

inlineinherited

Definition at line 203 of file TObject.h.

rmdir()

void TDirectory::rmdir ( const char * name )

virtual

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.

Save()

virtual void TDirectory::Save ( )

inlinevirtual

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.

SaveObjectAs()

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

virtual

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 )

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 256 of file TDirectory.h.

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 )

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 257 of file TDirectory.h.

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.

SetModified()

virtual void TDirectory::SetModified ( )

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 258 of file TDirectory.h.

SetMother()

virtual void TDirectory::SetMother ( TObject * mother )

inlinevirtual

Definition at line 259 of file TDirectory.h.

SetName()

void TDirectory::SetName ( const char * newname )

overridevirtual

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.

SetSeekDir()

virtual void TDirectory::SetSeekDir ( Long64_t )

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 262 of file TDirectory.h.

SetTitle()

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

virtualinherited

Set the title of the TNamed.

Reimplemented in Axis2, RooPlot, ROOT::Experimental::XRooFit::xRooNode, ROOT::TSchemaRule::TSources, TASImage, TEfficiency, TF1, TGraph2D, TGraph, TH1, THnBase, TParallelCoordVar, TSystemDirectory, and TSystemFile.

Definition at line 173 of file TNamed.cxx.

SetTRefAction()

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

inlinevirtual

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.

SetWritable()

virtual void TDirectory::SetWritable ( Bool_t )

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 263 of file TDirectory.h.

Sizeof()

Int_t TDirectory::Sizeof ( ) const

inlineoverridevirtual

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 )

overridevirtual

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 )

inline

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.

UnregisterContext()

void TDirectory::UnregisterContext ( TContext * ctxt )

protected

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

inlineoverridevirtual

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 )

inlineoverridevirtual

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

inlinevirtual

Reimplemented in TDirectoryFile.

Definition at line 303 of file TDirectory.h.

WriteKeys()

virtual void TDirectory::WriteKeys ( )

inlinevirtual

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 )

inline

Write an object with proper type checking.

Parameters

[in]	obj	Pointer to an object to be written.
[in]	name	Name of the object in the file.
[in]	option	Options. See TDirectoryFile::WriteTObject.
[in]	bufsize	Buffer 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 )

inline

Write an object with proper type checking.

Parameters

[in]	obj	Pointer to an object to be written.
[in]	name	Name of the object in the file.
[in]	option	Options. See TDirectoryFile::WriteTObject.
[in]	bufsize	Buffer 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 )

inlinevirtual

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 )

inlinevirtual

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 )

virtual

Reimplemented in TDirectoryFile.

Friends And Related Symbol Documentation

ROOT::Internal::TDirectoryAtomicAdapter

friend struct ROOT::Internal::TDirectoryAtomicAdapter

friend

Definition at line 170 of file TDirectory.h.

TContext

friend class TContext

friend

Definition at line 169 of file TDirectory.h.

Member Data Documentation

fBits

UInt_t TObject::fBits

privateinherited

bit field status word

Definition at line 47 of file TObject.h.

fContext

TContext* TDirectory::fContext {nullptr}

protected

! 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}

protected

! Counter delaying the TDirectory destructor from finishing.

Definition at line 153 of file TDirectory.h.

fgAddDirectory

Bool_t TDirectory::fgAddDirectory = false

inlinestaticprotected

!

Deprecated

This flag has no effect in ROOT.

Definition at line 157 of file TDirectory.h.

fGDirectories

std::vector<SharedGDirectory_t> TDirectory::fGDirectories

protected

! thread local gDirectory pointing to this object.

Definition at line 151 of file TDirectory.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.

fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE

staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

fList

TList* TDirectory::fList {nullptr}

protected

List of objects in memory.

Definition at line 142 of file TDirectory.h.

fMother

TObject* TDirectory::fMother {nullptr}

protected

pointer to mother of the directory

Definition at line 141 of file TDirectory.h.

fName

TString TNamed::fName

protectedinherited

Definition at line 32 of file TNamed.h.

fPathBuffer

TString TDirectory::fPathBuffer

mutableprotected

! Buffer for GetPath() function

Definition at line 144 of file TDirectory.h.

fSpinLock

std::atomic_flag TDirectory::fSpinLock

mutableprotected

! MSVC doesn't support = ATOMIC_FLAG_INIT;

Definition at line 154 of file TDirectory.h.

fTitle

TString TNamed::fTitle

protectedinherited

Definition at line 33 of file TNamed.h.

fUniqueID

UInt_t TObject::fUniqueID

privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

fUUID

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

protected

Unique identifier.

Definition at line 143 of file TDirectory.h.

---

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

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