Logo ROOT   6.10/09
Reference Guide
Go to the documentation of this file.
1 // @(#)root/io:$Id$
2 // Author: Rene Brun 22/01/2007
4 /*************************************************************************
5  * Copyright (C) 1995-2007, Rene Brun and Fons Rademakers. *
6  * All rights reserved. *
7  * *
8  * For the licensing terms see $ROOTSYS/LICENSE. *
9  * For the list of contributors see $ROOTSYS/README/CREDITS. *
10  *************************************************************************/
12 #ifndef ROOT_TDirectoryFile
13 #define ROOT_TDirectoryFile
16 //////////////////////////////////////////////////////////////////////////
17 // //
18 // TDirectoryFile //
19 // //
20 // Describe directory structure in a ROOT file. //
21 // //
22 //////////////////////////////////////////////////////////////////////////
24 #include "TDirectory.h"
26 class TList;
27 class TBrowser;
28 class TKey;
29 class TFile;
31 class TDirectoryFile : public TDirectory {
33 protected:
34  Bool_t fModified; ///< True if directory has been modified
35  Bool_t fWritable; ///< True if directory is writable
36  TDatime fDatimeC; ///< Date and time when directory is created
37  TDatime fDatimeM; ///< Date and time of last modification
38  Int_t fNbytesKeys; ///< Number of bytes for the keys
39  Int_t fNbytesName; ///< Number of bytes in TNamed at creation time
40  Int_t fBufferSize; ///< Default buffer size to create new TKeys
41  Long64_t fSeekDir; ///< Location of directory on file
42  Long64_t fSeekParent; ///< Location of parent directory on file
43  Long64_t fSeekKeys; ///< Location of Keys record on file
44  TFile *fFile; ///< Pointer to current file in memory
45  TList *fKeys; ///< Pointer to keys list in memory
47  virtual void CleanTargets();
48  void Init(TClass *cl = 0);
50 private:
51  TDirectoryFile(const TDirectoryFile &directory); //Directories cannot be copied
52  void operator=(const TDirectoryFile &); //Directories cannot be copied
54 public:
55  // TDirectory status bits
56  enum { kCloseDirectory = BIT(7) };
59  TDirectoryFile(const char *name, const char *title, Option_t *option="", TDirectory* motherDir = 0);
60  virtual ~TDirectoryFile();
61  virtual void Append(TObject *obj, Bool_t replace = kFALSE);
62  void Add(TObject *obj, Bool_t replace = kFALSE) { Append(obj,replace); }
63  Int_t AppendKey(TKey *key);
64  virtual void Browse(TBrowser *b);
65  void Build(TFile* motherFile = 0, TDirectory* motherDir = 0);
66  virtual TObject *CloneObject(const TObject *obj, Bool_t autoadd = kTRUE);
67  virtual void Close(Option_t *option="");
68  virtual void Copy(TObject &) const { MayNotUse("Copy(TObject &)"); }
69  virtual Bool_t cd(const char *path = 0);
70  virtual void Delete(const char *namecycle="");
71  virtual void FillBuffer(char *&buffer);
72  virtual TKey *FindKey(const char *keyname) const;
73  virtual TKey *FindKeyAny(const char *keyname) const;
74  virtual TObject *FindObjectAny(const char *name) const;
75  virtual TObject *FindObjectAnyFile(const char *name) const;
76  virtual TObject *Get(const char *namecycle);
77  virtual TDirectory *GetDirectory(const char *apath, Bool_t printError = false, const char *funcname = "GetDirectory");
78  template <class T> inline void GetObject(const char* namecycle, T*& ptr) // See TDirectory::Get for information
79  {
80  ptr = (T*)GetObjectChecked(namecycle,TBuffer::GetClass(typeid(T)));
81  }
82  virtual void *GetObjectChecked(const char *namecycle, const char* classname);
83  virtual void *GetObjectChecked(const char *namecycle, const TClass* cl);
84  virtual void *GetObjectUnchecked(const char *namecycle);
85  virtual Int_t GetBufferSize() const;
86  const TDatime &GetCreationDate() const { return fDatimeC; }
87  virtual TFile *GetFile() const { return fFile; }
88  virtual TKey *GetKey(const char *name, Short_t cycle=9999) const;
89  virtual TList *GetListOfKeys() const { return fKeys; }
90  const TDatime &GetModificationDate() const { return fDatimeM; }
91  virtual Int_t GetNbytesKeys() const { return fNbytesKeys; }
92  virtual Int_t GetNkeys() const { return fKeys->GetSize(); }
93  virtual Long64_t GetSeekDir() const { return fSeekDir; }
94  virtual Long64_t GetSeekParent() const { return fSeekParent; }
95  virtual Long64_t GetSeekKeys() const { return fSeekKeys; }
96  Bool_t IsModified() const { return fModified; }
97  Bool_t IsWritable() const { return fWritable; }
98  virtual void ls(Option_t *option="") const;
99  virtual TDirectory *mkdir(const char *name, const char *title="");
100  virtual TFile *OpenFile(const char *name, Option_t *option= "",
101  const char *ftitle = "", Int_t compress = 1,
102  Int_t netopt = 0);
103  virtual void Purge(Short_t nkeep=1);
104  virtual void ReadAll(Option_t *option="");
105  virtual Int_t ReadKeys(Bool_t forceRead=kTRUE);
106  virtual Int_t ReadTObject(TObject *obj, const char *keyname);
107  virtual void ResetAfterMerge(TFileMergeInfo *);
108  virtual void rmdir(const char *name);
109  virtual void Save();
110  virtual void SaveSelf(Bool_t force = kFALSE);
111  virtual Int_t SaveObjectAs(const TObject *obj, const char *filename="", Option_t *option="") const;
112  virtual void SetBufferSize(Int_t bufsize);
113  void SetModified() {fModified = kTRUE;}
114  void SetSeekDir(Long64_t v) { fSeekDir = v; }
115  virtual void SetTRefAction(TObject *ref, TObject *parent);
116  void SetWritable(Bool_t writable=kTRUE);
117  virtual Int_t Sizeof() const;
118  virtual Int_t Write(const char *name=0, Int_t opt=0, Int_t bufsize=0);
119  virtual Int_t Write(const char *name=0, Int_t opt=0, Int_t bufsize=0) const ;
120  virtual Int_t WriteTObject(const TObject *obj, const char *name=0, Option_t *option="", Int_t bufsize=0);
121  virtual Int_t WriteObjectAny(const void *obj, const char *classname, const char *name, Option_t *option="", Int_t bufsize=0);
122  virtual Int_t WriteObjectAny(const void *obj, const TClass *cl, const char *name, Option_t *option="", Int_t bufsize=0);
123  virtual void WriteDirHeader();
124  virtual void WriteKeys();
126  ClassDef(TDirectoryFile,5) //Describe directory structure in a ROOT file
127 };
129 #endif
TDatime fDatimeM
Date and time of last modification.
virtual Bool_t cd(const char *path=0)
Change current directory to "this" directory.
virtual Int_t Sizeof() const
Return the size in bytes of the directory header.
virtual void ReadAll(Option_t *option="")
Read objects from a ROOT file directory into memory.
virtual TDirectory * mkdir(const char *name, const char *title="")
Create a sub-directory "a" or a hierarchy of sub-directories "a/b/c/...".
virtual TObject * CloneObject(const TObject *obj, Bool_t autoadd=kTRUE)
Make a clone of an object using the Streamer facility.
virtual void SetBufferSize(Int_t bufsize)
Set the default buffer size when creating new TKeys.
virtual TKey * FindKey(const char *keyname) const
Find key with name keyname in the current directory.
long long Long64_t
Definition: RtypesCore.h:69
void SetSeekDir(Long64_t v)
Long64_t fSeekParent
Location of parent directory on file.
virtual void CleanTargets()
Clean the pointers to this object (gDirectory, TContext, etc.)
Long64_t fSeekKeys
Location of Keys record on file.
virtual Int_t ReadTObject(TObject *obj, const char *keyname)
Read object with keyname from the current directory.
const char Option_t
Definition: RtypesCore.h:62
virtual Int_t WriteObjectAny(const void *obj, const char *classname, const char *name, Option_t *option="", Int_t bufsize=0)
Write object from pointer of class classname in this directory.
virtual void Save()
Save recursively all directory keys and headers.
double T(double x)
Definition: ChebyshevPol.h:34
virtual void SetTRefAction(TObject *ref, TObject *parent)
Find the action to be executed in the dictionary of the parent class and store the corresponding exec...
#define BIT(n)
Definition: Rtypes.h:75
Int_t fBufferSize
Default buffer size to create new TKeys.
virtual TKey * GetKey(const char *name, Short_t cycle=9999) const
Return pointer to key with name,cycle.
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format...
Definition: TFile.h:46
virtual TObject * Get(const char *namecycle)
Return pointer to object identified by namecycle.
virtual Long64_t GetSeekKeys() const
int Int_t
Definition: RtypesCore.h:41
bool Bool_t
Definition: RtypesCore.h:59
virtual TKey * FindKeyAny(const char *keyname) const
Find key with name keyname in the current directory or its subdirectories.
virtual void * GetObjectUnchecked(const char *namecycle)
Return pointer to object identified by namecycle.
virtual Int_t Write(const char *name=0, Int_t opt=0, Int_t bufsize=0)
Write all objects in memory to disk.
virtual Int_t GetNkeys() const
virtual void FillBuffer(char *&buffer)
Encode directory header into output buffer.
const TDatime & GetCreationDate() const
virtual Int_t WriteTObject(const TObject *obj, const char *name=0, Option_t *option="", Int_t bufsize=0)
Write object obj to this directory.
TDatime fDatimeC
Date and time when directory is created.
void Init(TClass *cl=0)
Initialize the key associated with this directory (and the related data members.
#define ClassDef(name, id)
Definition: Rtypes.h:297
virtual void WriteKeys()
Write Keys linked list on the file.
static TClass * GetClass(const std::type_info &typeinfo)
Forward to TROOT::GetClass().
Definition: TBuffer.cxx:297
virtual void Append(TObject *obj, Bool_t replace=kFALSE)
Append object to this directory.
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 clas...
Definition: TObject.cxx:926
virtual ~TDirectoryFile()
Book space in a file, create I/O buffers, to fill them, (un)compress them.
Definition: TKey.h:24
Long64_t fSeekDir
Location of directory on file.
void GetObject(const char *namecycle, T *&ptr)
const TDatime & GetModificationDate() const
virtual Int_t GetNbytesKeys() const
A doubly linked list.
Definition: TList.h:43
virtual void ls(Option_t *option="") const
List Directory contents.
void Add(TObject *obj, Bool_t replace=kFALSE)
Using a TBrowser one can browse all ROOT objects.
Definition: TBrowser.h:37
virtual void SaveSelf(Bool_t force=kFALSE)
Save Directory keys and header.
virtual void Copy(TObject &) const
Copy this to obj.
TList * fKeys
Pointer to keys list in memory.
SVector< double, 2 > v
Definition: Dict.h:5
virtual Int_t SaveObjectAs(const TObject *obj, const char *filename="", Option_t *option="") const
Save object in filename.
A ROOT file is structured in Directories (like a file system).
Int_t fNbytesName
Number of bytes in TNamed at creation time.
short Short_t
Definition: RtypesCore.h:35
The ROOT global object gROOT contains a list of all defined classes.
Definition: TClass.h:71
virtual void Browse(TBrowser *b)
Browse the content of the directory.
virtual void Delete(const char *namecycle="")
Delete Objects or/and keys in a directory.
void Build(TFile *motherFile=0, TDirectory *motherDir=0)
Initialise directory to defaults.
virtual TDirectory * GetDirectory(const char *apath, Bool_t printError=false, const char *funcname="GetDirectory")
Find a directory named "apath".
Bool_t fWritable
True if directory is writable.
Int_t AppendKey(TKey *key)
Insert key in the linked list of keys of this directory.
virtual void WriteDirHeader()
Overwrite the Directory header record.
const Bool_t kFALSE
Definition: RtypesCore.h:92
TFile * fFile
Pointer to current file in memory.
virtual TObject * FindObjectAnyFile(const char *name) const
Scan the memory lists of all files for an object with name.
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 Int_t ReadKeys(Bool_t forceRead=kTRUE)
Read the linked list of keys.
virtual Int_t GetBufferSize() const
Return the buffer size to create new TKeys.
Default Constructor.
Describe directory structure in memory.
Definition: TDirectory.h:34
virtual Long64_t GetSeekParent() const
void SetWritable(Bool_t writable=kTRUE)
Set the new value of fWritable recursively.
virtual TFile * GetFile() const
virtual void * GetObjectChecked(const char *namecycle, const char *classname)
See documentation of TDirectoryFile::GetObjectCheck(const char *namecycle, const TClass *cl) ...
virtual void Close(Option_t *option="")
Delete all objects from memory and directory structure itself.
Mother of all ROOT objects.
Definition: TObject.h:37
virtual void rmdir(const char *name)
Removes subdirectory from the directory.
Bool_t fModified
True if directory has been modified.
virtual TList * GetListOfKeys() const
void operator=(const TDirectoryFile &)
virtual TFile * OpenFile(const char *name, Option_t *option="", const char *ftitle="", Int_t compress=1, Int_t netopt=0)
Interface to TFile::Open.
you should not use this method at all Int_t Int_t Double_t Double_t Double_t Int_t Double_t Double_t Double_t Double_t b
Definition: TRolke.cxx:630
virtual void ResetAfterMerge(TFileMergeInfo *)
Reset the TDirectory after its content has been merged into another Directory.
virtual Long64_t GetSeekDir() const
Bool_t IsWritable() const
virtual Int_t GetSize() const
Definition: TCollection.h:89
const Bool_t kTRUE
Definition: RtypesCore.h:91
This class stores the date and time with a precision of one second in an unsigned 32 bit word (950130...
Definition: TDatime.h:37
Int_t fNbytesKeys
Number of bytes for the keys.
virtual void Purge(Short_t nkeep=1)
Purge lowest key cycles in a directory.
Bool_t IsModified() const