Describe directory structure in memory.
From Python, it is possible to inspect the content of a TDirectory object as if the subdirectories and objects it contains were its attributes. 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:
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 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. | |
virtual void | Add (TObject *obj, Bool_t replace=kFALSE) |
virtual void | Append (TObject *obj, Bool_t replace=kFALSE) |
Append object to this directory. | |
virtual Int_t | AppendKey (TKey *) |
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. | |
void | Clear (Option_t *option="") override |
Delete all objects from a Directory list. | |
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. | |
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 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 |
virtual TObject * | Get (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 TDirectory * | GetDirectory (const char *namecycle, Bool_t printError=false, const char *funcname="GetDirectory") |
Find a directory using apath. | |
virtual TFile * | GetFile () const |
virtual TKey * | GetKey (const char *, Short_t=9999) const |
virtual TList * | GetList () const |
virtual TList * | GetListOfKeys () const |
TObject * | GetMother () const |
TDirectory * | GetMotherDir () 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 |
TClass * | IsA () const override |
Bool_t | IsBuilt () const |
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 |
virtual Bool_t | IsWritable () const |
void | ls (Option_t *option="") const override |
List Directory contents. | |
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 TFile * | OpenFile (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 *) |
void | RecursiveRemove (TObject *obj) override |
Recursively remove object from a Directory. | |
virtual TObject * | Remove (TObject *) |
Remove an object from the in-memory list. | |
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 | Streamer (TBuffer &) override |
TDirectory Streamer. | |
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_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) |
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 (""). | |
TObject * | Clone (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. | |
TClass * | IsA () const override |
Bool_t | IsSortable () const override |
void | ls (Option_t *option="") const override |
List TNamed name and title. | |
TNamed & | operator= (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 | Streamer (TBuffer &) override |
Stream an object of class TObject. | |
void | StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b) |
Public Member Functions inherited from TObject | |
TObject () | |
TObject constructor. | |
TObject (const TObject &object) | |
TObject copy ctor. | |
virtual | ~TObject () |
TObject destructor. | |
void | AbstractMethod (const char *method) const |
Use this method to implement an "abstract" method that you don't want to leave purely abstract. | |
virtual void | AppendPad (Option_t *option="") |
Append graphics object to current pad. | |
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 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 Option_t * | GetDrawOption () 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_t * | GetOption () 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) |
TObject & | operator= (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 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 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 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 TClass * | Class () |
static const char * | Class_Name () |
static constexpr Version_t | Class_Version () |
static const char * | DeclFileName () |
Static Public Member Functions inherited from TObject | |
static TClass * | Class () |
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 | |
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 | |
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 () |
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. | |
Protected Attributes | |
TContext * | fContext {nullptr} |
Buffer for GetPath() function. | |
std::atomic< size_t > | fContextPeg {0} |
thread local gDirectory pointing to this object. | |
std::vector< SharedGDirectory_t > | fGDirectories |
TList * | fList {nullptr} |
TObject * | fMother {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 |
Static Protected Attributes | |
static Bool_t | fgAddDirectory = kTRUE |
MSVC doesn't support = ATOMIC_FLAG_INIT;. | |
Friends | |
struct | ROOT::Internal::TDirectoryAtomicAdapter |
class | TContext |
Additional Inherited Members | |
Public Types inherited from TObject | |
enum | { kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff } |
enum | { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) } |
enum | EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) } |
enum | EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) } |
#include <TDirectory.h>
|
protected |
Pointer to a list of TContext object pointing to this TDirectory.
Definition at line 147 of file TDirectory.h.
|
protecteddelete |
TDirectory::TDirectory | ( | ) |
Directory default constructor.
Definition at line 53 of file TDirectory.cxx.
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.
|
virtual |
Destructor.
Definition at line 97 of file TDirectory.cxx.
Reimplemented in RooWorkspace::WSDir, and TDirectoryFile.
Definition at line 183 of file TDirectory.h.
Sets the flag controlling the automatic add objects like histograms, TGraph2D, etc in memory.
By default (fAddDirectory = kTRUE), these objects are automatically added to the list of objects in memory. Note that in the classes like TH1, TGraph2D supporting this facility, one object can be removed from its support directory by calling object->SetDirectory(nullptr) or object->SetDirectory(dir) to add it to the list of objects in the directory dir.
NOTE that this is a static function. To call it, use:
Definition at line 180 of file TDirectory.cxx.
|
static |
Static function: see TDirectory::AddDirectory for more comments.
Definition at line 188 of file TDirectory.cxx.
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, TROOT, and TDirectoryFile.
Definition at line 199 of file TDirectory.cxx.
Reimplemented in TDirectoryFile.
Definition at line 184 of file TDirectory.h.
|
overridevirtual |
Browse the content of the directory.
Reimplemented from TObject.
Reimplemented in TROOT, and TDirectoryFile.
Definition at line 227 of file TDirectory.cxx.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 186 of file TDirectory.h.
|
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 249 of file TDirectory.cxx.
|
virtual |
Change current directory to "this" directory.
Returns kTRUE (it's guaranteed to succeed).
Reimplemented in TDirectoryFile.
Definition at line 538 of file TDirectory.cxx.
|
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 562 of file TDirectory.cxx.
|
static |
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.
Definition at line 603 of file TDirectory.cxx.
|
protected |
flag to add histograms, graphs,etc to the directory
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 581 of file TDirectory.cxx.
|
staticprotected |
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 617 of file TDirectory.cxx.
|
static |
|
inlinestaticconstexpr |
Definition at line 308 of file TDirectory.h.
|
protected |
Clean the pointers to this object (gDirectory, TContext, etc.).
Definition at line 264 of file TDirectory.cxx.
|
overridevirtual |
Delete all objects from a Directory list.
Reimplemented from TObject.
Definition at line 634 of file TDirectory.cxx.
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 gDirector. This usually means that the object will be appended to the current ROOT directory.
Reimplemented in TDirectoryFile.
Definition at line 364 of file TDirectory.cxx.
|
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 TSQLFile, TXMLFile, TDirectoryFile, TFile, TNetFile, TParallelMergingFile, and TWebFile.
Definition at line 645 of file TDirectory.cxx.
|
inlineoverridevirtual |
Copy this to obj.
Reimplemented from TObject.
Reimplemented in TDirectoryFile, and TFile.
Definition at line 191 of file TDirectory.h.
|
static |
Return the current directory for the current thread.
Definition at line 432 of file TDirectory.cxx.
|
inlinestatic |
Definition at line 308 of file TDirectory.h.
|
static |
Decode a namecycle "aap;2" into name "aap" and cycle "2".
Destination buffer size for name (including string terminator) should be specified in namesize.
;
is larger than SHORT_MAX
, cycle is set to 0
.;*
, cycle is set to 10000.
In all other cases, i.e. when number is not a digit or buffer is a nullptr, cycle is set to
9999`. Definition at line 1301 of file TDirectory.cxx.
|
overridevirtual |
Delete Objects or/and keys in a directory.
To delete one directory, you must specify the directory cycle, eg. file.Delete("dir1;1");
examples:
Reimplemented from TObject.
Reimplemented in TDirectoryFile, and TFile.
Definition at line 712 of file TDirectory.cxx.
|
virtual |
Delete all objects from memory.
Definition at line 685 of file TDirectory.cxx.
|
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 768 of file TDirectory.cxx.
|
protected |
Recursive method to fill full path for directory.
Definition at line 1061 of file TDirectory.cxx.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 197 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 198 of file TDirectory.h.
|
overridevirtual |
Find object by name in the list of memory objects.
Reimplemented from TObject.
Reimplemented in TROOT.
Definition at line 784 of file TDirectory.cxx.
Find object in the list of memory objects.
Reimplemented from TObject.
Reimplemented in TROOT.
Definition at line 776 of file TDirectory.cxx.
|
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 TROOT, and TDirectoryFile.
Definition at line 796 of file TDirectory.cxx.
|
inlinevirtual |
Reimplemented in TROOT, and TDirectoryFile.
Definition at line 202 of file TDirectory.h.
|
virtual |
Return pointer to object identified by namecycle.
namecycle has the format name;cycle
examples:
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:
VERY IMPORTANT NOTE:
In case the class of this object derives from TObject but not as a first inheritance, one must use dynamic_cast<>().
then on return, one can do:
then on return, one must do:
Of course, dynamic_cast<> can also be used in the example 1.
Reimplemented in TDirectoryFile, and TDirectoryFile.
Definition at line 866 of file TDirectory.cxx.
|
inline |
See documentation of TDirectoryFile::Get(const char *namecycle)
Definition at line 205 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 219 of file TDirectory.h.
|
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 448 of file TDirectory.cxx.
|
inlinevirtual |
Reimplemented in TROOT, and TDirectoryFile.
Definition at line 220 of file TDirectory.h.
Reimplemented in TDirectoryFile.
Definition at line 221 of file TDirectory.h.
|
inlinevirtual |
Definition at line 222 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 223 of file TDirectory.h.
|
inline |
Definition at line 224 of file TDirectory.h.
|
inline |
Definition at line 225 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 226 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 227 of file TDirectory.h.
|
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 212 of file TDirectory.h.
|
virtual |
See documentation of TDirectory::GetObjectCheck(const char *namecycle, const TClass *cl)
Reimplemented in TDirectoryFile.
Definition at line 929 of file TDirectory.cxx.
|
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
VERY IMPORTANT NOTE:
The calling application must cast the returned pointer to the type described by the 2 arguments (i.e. cl):
Note: We recommend using the method TDirectory::GetObject:
Reimplemented in TDirectoryFile.
Definition at line 958 of file TDirectory.cxx.
|
virtual |
Return pointer to object identified by namecycle.
The returned object may or may not derive from TObject.
VERY IMPORTANT NOTE:
The calling application must cast the returned object to the final type, e.g.
Reimplemented in TDirectoryFile.
Definition at line 921 of file TDirectory.cxx.
|
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 1048 of file TDirectory.cxx.
|
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 1010 of file TDirectory.cxx.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 228 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 230 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 229 of file TDirectory.h.
|
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 416 of file TDirectory.cxx.
|
inline |
Definition at line 233 of file TDirectory.h.
|
inlineoverridevirtual |
Reimplemented from TObject.
Reimplemented in TXNetFile, TROOT, TGFALFile, TDirectoryFile, TFile, TMemFile, TSQLFile, TXMLFile, TNetFile, TParallelMergingFile, TS3WebFile, TWebFile, TNetXNGFile, and RooWorkspace::WSDir.
Definition at line 308 of file TDirectory.h.
|
inline |
Definition at line 234 of file TDirectory.h.
|
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 235 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 236 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 237 of file TDirectory.h.
|
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 TROOT, TDirectoryFile, and TFile.
Definition at line 1143 of file TDirectory.cxx.
|
virtual |
Create a sub-directory "a" or a hierarchy of sub-directories "a/b/c/...".
Returns 0 in case of error or if a sub-directory (hierarchy) with the requested name already exists. returnExistingDirectory returns a pointer to an already existing sub-directory with the same name. Returns a pointer to the created sub-directory or to the top sub-directory of the hierarchy (in the above example, the returned TDirectory * always points to "a"). In particular, the steps to create first a/b/c and then a/b/d without receiving errors are:
or
Reimplemented in TDirectoryFile.
Definition at line 1102 of file TDirectory.cxx.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 240 of file TDirectory.h.
|
protecteddelete |
|
overridevirtual |
|
overridevirtual |
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 245 of file TDirectory.h.
|
virtual |
Print the path of the directory.
Definition at line 1195 of file TDirectory.cxx.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 247 of file TDirectory.h.
Reimplemented in TDirectoryFile.
Definition at line 248 of file TDirectory.h.
Reimplemented in TDirectoryFile.
Definition at line 249 of file TDirectory.h.
|
overridevirtual |
Recursively remove object from a Directory.
Reimplemented from TObject.
Reimplemented in TROOT.
Definition at line 1203 of file TDirectory.cxx.
|
protected |
Register a TContext pointing to this TDirectory object.
Definition at line 1365 of file TDirectory.cxx.
|
protected |
Register a std::atomic<TDirectory*> that will soon be pointing to this TDirectory object.
Definition at line 1385 of file TDirectory.cxx.
Remove an object from the in-memory list.
Reimplemented in TROOT.
Definition at line 1212 of file TDirectory.cxx.
|
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 1227 of file TDirectory.cxx.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 253 of file TDirectory.h.
|
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.ch/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 1250 of file TDirectory.cxx.
Reimplemented in TDirectoryFile.
Definition at line 255 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 256 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 257 of file TDirectory.h.
|
inlinevirtual |
Definition at line 258 of file TDirectory.h.
|
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 1287 of file TDirectory.cxx.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 261 of file TDirectory.h.
Reimplemented in TDirectoryFile.
Definition at line 260 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 262 of file TDirectory.h.
|
inlineoverridevirtual |
Return size of the TNamed part of the TObject.
Reimplemented from TNamed.
Reimplemented in TSQLFile, TXMLFile, TDirectoryFile, and TFile.
Definition at line 263 of file TDirectory.h.
|
overridevirtual |
TDirectory Streamer.
Reimplemented from TObject.
Reimplemented in TXNetFile, TROOT, TGFALFile, TDirectoryFile, TFile, TMemFile, TSQLFile, TXMLFile, TNetFile, TParallelMergingFile, TS3WebFile, TWebFile, TNetXNGFile, and RooWorkspace::WSDir.
Definition at line 1434 of file TDirectory.cxx.
|
inline |
Definition at line 308 of file TDirectory.h.
|
protected |
UnRegister a TContext pointing to this TDirectory object.
Definition at line 1412 of file TDirectory.cxx.
|
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:
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 TSQLFile, TXMLFile, TFile, TParallelMergingFile, and TDirectoryFile.
Definition at line 265 of file TDirectory.h.
|
inlineoverridevirtual |
Write this object to the current directory.
For more see the const version of this method.
Reimplemented from TObject.
Reimplemented in TSQLFile, TXMLFile, TFile, TParallelMergingFile, ROOT::TBufferMergerFile, and TDirectoryFile.
Definition at line 264 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 302 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 303 of file TDirectory.h.
|
inline |
Write an object with proper type checking.
[in] | obj | Pointer to an object to be written. |
[in] | name | Name of the object in the file. |
[in] | option | Options. See TDirectory::WriteTObject. |
[in] | bufsize | Buffer size. See TDirectory::WriteTObject. |
This overload takes care of instances of classes that are not derived from TObject. The method redirects to TDirectory::WriteObjectAny.
Definition at line 282 of file TDirectory.h.
|
inline |
Write an object with proper type checking.
[in] | obj | Pointer to an object to be written. |
[in] | name | Name of the object in the file. |
[in] | option | Options. See TDirectory::WriteTObject. |
[in] | bufsize | Buffer size. See TDirectory::WriteTObject. |
This overload takes care of instances of classes that are derived from TObject. The method redirects to TDirectory::WriteTObject.
Definition at line 296 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 300 of file TDirectory.h.
|
inlinevirtual |
Reimplemented in TDirectoryFile.
Definition at line 301 of file TDirectory.h.
|
virtual |
Write an object with proper type checking.
[in] | obj | Pointer to an object to be written. |
[in] | name | Name of the object in the file. |
[in] | option | Options. See TDirectory::WriteTObject. |
[in] | bufsize | Buffer size. See TDirectory::WriteTObject. |
This overload takes care of instances of classes that are not derived from TObject. The method redirects to TDirectory::WriteObjectAny.
Reimplemented in TDirectoryFile.
Definition at line 1400 of file TDirectory.cxx.
|
friend |
Definition at line 169 of file TDirectory.h.
|
friend |
Definition at line 168 of file TDirectory.h.
|
protected |
Buffer for GetPath() function.
Definition at line 145 of file TDirectory.h.
|
protected |
thread local gDirectory pointing to this object.
Definition at line 153 of file TDirectory.h.
MSVC doesn't support = ATOMIC_FLAG_INIT;.
Definition at line 156 of file TDirectory.h.
|
protected |
Definition at line 151 of file TDirectory.h.
|
protected |
Definition at line 142 of file TDirectory.h.
|
protected |
Definition at line 141 of file TDirectory.h.
|
mutableprotected |
Definition at line 144 of file TDirectory.h.
|
mutableprotected |
Counter delaying the TDirectory destructor from finishing.
Definition at line 154 of file TDirectory.h.
|
protected |
Definition at line 143 of file TDirectory.h.