library: libCore
#include "TFile.h"


class description - header file - source file
viewCVS header - viewCVS source

class TFile: public TDirectory

Inheritance Inherited Members Includes Libraries
Class Charts

Function Members (Methods)

Display options:
Show inherited
Show non-public
TFile(const char* fname, Option_t* option = "", const char* ftitle = "", Int_t compress = 1)
voidTObject::AbstractMethod(const char* method) const
voidTDirectory::Add(TObject* obj)
virtual voidTDirectory::Append(TObject* obj)
Int_tTDirectory::AppendKey(TKey* key)
virtual voidTObject::AppendPad(Option_t* option = "")
static TFileOpenHandle*AsyncOpen(const char* name, Option_t* option = "", const char* ftitle = "", Int_t compress = 1, Int_t netopt = 0)
virtual voidTDirectory::Browse(TBrowser* b)
voidTDirectory::Build(TFile* motherFile = 0, TDirectory* motherDir = 0)
virtual Bool_tTDirectory::cd(const char* path = "0")
static Bool_tTDirectory::Cd(const char* path)
static TClass*Class()
virtual const char*TObject::ClassName() const
virtual voidTDirectory::Clear(Option_t* option = "")
virtual TObject*TNamed::Clone(const char* newname = "") const
virtual voidClose(Option_t* option = "")
virtual Int_tTNamed::Compare(const TObject* obj) const
virtual voidCopy(TObject&) const
virtual TKey*CreateKey(TDirectory* mother, const TObject* obj, const char* name, Int_t bufsize)
virtual TKey*CreateKey(TDirectory* mother, const void* obj, const TClass* cl, const char* name, Int_t bufsize)
static voidTDirectory::DecodeNameCycle(const char* namecycle, char* name, Short_t& cycle)
virtual voidDelete(const char* namecycle = "")
virtual voidTDirectory::DeleteAll(Option_t* option = "")
virtual Int_tTObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual voidDraw(Option_t* option = "")
virtual voidTObject::DrawClass() const
virtual TObject*TObject::DrawClone(Option_t* option = "") const
virtual voidDrawMap(const char* keys = "*", Option_t* option = "")
virtual voidTObject::Dump() const
static voidTDirectory::EncodeNameCycle(char* buffer, const char* name, Short_t cycle)
virtual voidTObject::Error(const char* method, const char* msgfmt) const
virtual voidTObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual voidTObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual voidTObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual voidTObject::Fatal(const char* method, const char* msgfmt) const
virtual voidFillBuffer(char*& buffer)
virtual TKey*TDirectory::FindKey(const char* keyname) const
virtual TKey*TDirectory::FindKeyAny(const char* keyname) const
virtual TObject*TDirectory::FindObject(const char* name) const
virtual TObject*TDirectory::FindObject(const TObject* obj) const
virtual TObject*TDirectory::FindObjectAny(const char* name) const
virtual voidFlush()
virtual TObject*TDirectory::Get(const char* namecycle)
TArchiveFile*GetArchive() const
static TFile::EAsyncOpenStatusGetAsyncOpenStatus(const char* name)
static TFile::EAsyncOpenStatusGetAsyncOpenStatus(TFileOpenHandle* handle)
Int_tGetBestBuffer() const
virtual Int_tTDirectory::GetBufferSize() const
virtual Long64_tGetBytesRead() const
virtual Long64_tGetBytesWritten() const
TFileCacheRead*GetCacheRead() const
TFileCacheWrite*GetCacheWrite() const
TArrayC*GetClassIndex() const
Int_tGetCompressionLevel() const
const TDatime&TDirectory::GetCreationDate() const
virtual TDirectory*TDirectory::GetDirectory(const char* namecycle, Bool_t printError = false, const char* funcname = "GetDirectory")
virtual Option_t*TObject::GetDrawOption() const
static Long_tTObject::GetDtorOnly()
virtual Long64_tGetEND() const
virtual const TUrl*GetEndpointUrl() const
static const TUrl*GetEndpointUrl(const char* name)
virtual Int_tGetErrno() const
Int_tGetFd() const
virtual TFile*TDirectory::GetFile() const
static Long64_tGetFileBytesRead()
static Long64_tGetFileBytesWritten()
static Long64_tGetFileCounter()
static Int_tGetFileReadCalls()
virtual const char*TObject::GetIconName() const
virtual TKey*TDirectory::GetKey(const char* name, Short_t cycle = 9999) const
virtual TList*TDirectory::GetList() const
TList*GetListOfFree() const
virtual TList*TDirectory::GetListOfKeys() const
TObjArray*GetListOfProcessIDs() const
const TDatime&TDirectory::GetModificationDate() const
TObject*TDirectory::GetMother() const
TDirectory*TDirectory::GetMotherDir() const
virtual const char*TNamed::GetName() const
virtual Int_tGetNbytesFree() const
virtual Int_tGetNbytesInfo() const
virtual Int_tTDirectory::GetNbytesKeys() const
virtual Int_tGetNfree() const
virtual Int_tTDirectory::GetNkeys() const
virtual Int_tGetNProcessIDs() const
voidTDirectory::GetObject(const char* namecycle, void*& ptr)
virtual void*TDirectory::GetObjectChecked(const char* namecycle, const char* classname)
virtual void*TDirectory::GetObjectChecked(const char* namecycle, const TClass* cl)
virtual char*TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_tTObject::GetObjectStat()
virtual void*TDirectory::GetObjectUnchecked(const char* namecycle)
virtual Option_t*GetOption() const
virtual const char*TDirectory::GetPath() const
virtual const char*TDirectory::GetPathStatic() const
virtual Int_tGetReadCalls() const
Int_tGetRecordHeader(char* buf, Long64_t first, Int_t maxbytes, Int_t& nbytes, Int_t& objlen, Int_t& keylen)
virtual Long64_tTDirectory::GetSeekDir() const
virtual Long64_tGetSeekFree() const
virtual Long64_tGetSeekInfo() const
virtual Long64_tTDirectory::GetSeekKeys() const
virtual Long64_tTDirectory::GetSeekParent() const
virtual Long64_tGetSize() const
const TList*GetStreamerInfoCache()
virtual TList*GetStreamerInfoList()
virtual const char*TNamed::GetTitle() const
static TFile::EFileTypeGetType(const char* name, Option_t* option = "")
virtual UInt_tTObject::GetUniqueID() const
TUUIDTDirectory::GetUUID() const
Int_tGetVersion() const
virtual Bool_tTObject::HandleTimer(TTimer* timer)
virtual ULong_tTNamed::Hash() const
static voidIncrementFileCounter()
virtual voidIncrementProcessIDs()
virtual voidTObject::Info(const char* method, const char* msgfmt) const
virtual Bool_tTObject::InheritsFrom(const char* classname) const
virtual Bool_tTObject::InheritsFrom(const TClass* cl) const
virtual voidTObject::Inspect() const
voidTObject::InvertBit(UInt_t f)
virtual TClass*IsA() const
virtual Bool_tIsArchive() const
Bool_tIsBinary() const
virtual Bool_tTObject::IsEqual(const TObject* obj) const
virtual Bool_tTDirectory::IsFolder() const
Bool_tTDirectory::IsModified() const
Bool_tTObject::IsOnHeap() const
virtual Bool_tIsOpen() const
Bool_tIsRaw() const
virtual Bool_tTNamed::IsSortable() const
Bool_tTDirectory::IsWritable() const
Bool_tTObject::IsZombie() const
virtual voidls(Option_t* option = "") const
virtual voidMakeFree(Long64_t first, Long64_t last)
virtual voidMakeProject(const char* dirname, const char* classes = "*", Option_t* option = "new")
virtual voidMap()
virtual Bool_tMatches(const char* name)
voidTObject::MayNotUse(const char* method) const
virtual TDirectory*TDirectory::mkdir(const char* name, const char* title = "")
virtual Bool_tMustFlush() const
virtual Bool_tTObject::Notify()
static TFile*Open(TFileOpenHandle* handle)
static TFile*Open(const char* name, Option_t* option = "", const char* ftitle = "", Int_t compress = 1, Int_t netopt = 0)
static voidTObject::operator delete(void* ptr)
static voidTObject::operator delete(void* ptr, void* vp)
static voidTObject::operator delete[](void* ptr)
static voidTObject::operator delete[](void* ptr, void* vp)
void*TObject::operator new(size_t sz)
void*TObject::operator new(size_t sz, void* vp)
void*TObject::operator new[](size_t sz)
void*TObject::operator new[](size_t sz, void* vp)
virtual voidPaint(Option_t* option = "")
virtual voidTObject::Pop()
virtual voidPrint(Option_t* option = "") const
virtual voidTDirectory::Purge(Short_t nkeep = 1)
virtual voidTDirectory::pwd() const
virtual Int_tTObject::Read(const char* name)
virtual voidTDirectory::ReadAll(Option_t* option = "")
virtual Bool_tReadBuffer(char* buf, Int_t len)
virtual Bool_tReadBuffers(char* buf, Long64_t* pos, Int_t* len, Int_t nbuf)
virtual voidReadFree()
virtual Int_tTDirectory::ReadKeys()
virtual voidReadStreamerInfo()
virtual Int_tRecover()
virtual voidTDirectory::RecursiveRemove(TObject* obj)
virtual Int_tReOpen(Option_t* mode)
voidTObject::ResetBit(UInt_t f)
virtual voidResetErrno() const
virtual voidTDirectory::rmdir(const char* name)
virtual voidTDirectory::Save()
virtual voidTObject::SaveAs(const char* filename = "", Option_t* option = "") const
virtual voidTObject::SavePrimitive(ostream& out, Option_t* option = "")
virtual voidTDirectory::SaveSelf(Bool_t force = kFALSE)
virtual voidSeek(Long64_t offset, TFile::ERelativeTo pos = kBeg)
voidTObject::SetBit(UInt_t f)
voidTObject::SetBit(UInt_t f, Bool_t set)
virtual voidTDirectory::SetBufferSize(Int_t bufsize)
virtual voidSetCacheRead(TFileCacheRead* cache)
virtual voidSetCacheWrite(TFileCacheWrite* cache)
virtual voidSetCompressionLevel(Int_t level = 1)
virtual voidTObject::SetDrawOption(Option_t* option = "")
static voidTObject::SetDtorOnly(void* obj)
virtual voidSetEND(Long64_t last)
static voidSetFileBytesRead(Long64_t bytes = 0)
static voidSetFileBytesWritten(Long64_t bytes = 0)
static voidSetFileReadCalls(Int_t readcalls = 0)
voidTDirectory::SetMother(const TObject* mother)
virtual voidTDirectory::SetName(const char* newname)
virtual voidTNamed::SetNameTitle(const char* name, const char* title)
static voidTObject::SetObjectStat(Bool_t stat)
virtual voidSetOption(Option_t* option = ">")
virtual voidSetReadCalls(Int_t readcalls = 0)
static voidSetReadStreamerInfo(Bool_t readinfo = kTRUE)
voidTDirectory::SetSeekDir(Long64_t v)
virtual voidTNamed::SetTitle(const char* title = "")
virtual voidTObject::SetUniqueID(UInt_t uid)
voidTDirectory::SetWritable(Bool_t writable = kTRUE)
virtual voidShowMembers(TMemberInspector& insp, char* parent)
virtual voidShowStreamerInfo()
virtual Int_tSizeof() const
virtual voidStreamer(TBuffer& b)
voidStreamerNVirtual(TBuffer& b)
voidSumBuffer(Int_t bufsize)
virtual voidTObject::SysError(const char* method, const char* msgfmt) const
Bool_tTObject::TestBit(UInt_t f) const
Int_tTObject::TestBits(UInt_t f) const
virtual voidUseCache(Int_t maxCacheSize = 10, Int_t pageSize = 0)
virtual voidTObject::UseCurrentStyle()
virtual voidTObject::Warning(const char* method, const char* msgfmt) const
virtual Int_tWrite(const char* name = "0", Int_t opt = 0, Int_t bufsiz = 0)
virtual Int_tWrite(const char* name = "0", Int_t opt = 0, Int_t bufsiz = 0) const
virtual Bool_tWriteBuffer(const char* buf, Int_t len)
virtual voidTDirectory::WriteDirHeader()
virtual voidWriteFree()
virtual voidWriteHeader()
virtual voidTDirectory::WriteKeys()
Int_tTDirectory::WriteObject(const void* obj, const char* name, Option_t* option = "")
virtual Int_tTDirectory::WriteObjectAny(const void* obj, const char* classname, const char* name, Option_t* option = "")
virtual Int_tTDirectory::WriteObjectAny(const void* obj, const TClass* cl, const char* name, Option_t* option = "")
virtual voidWriteStreamerInfo()
virtual Int_tTDirectory::WriteTObject(const TObject* obj, const char* name = "0", Option_t* option = "")
Bool_tTDirectory::cd1(const char* path)
static Bool_tTDirectory::Cd1(const char* path)
virtual Long64_tDirCreateEntry(TDirectory*)
virtual Int_tDirReadKeys(TDirectory*)
virtual voidDirWriteHeader(TDirectory*)
virtual voidDirWriteKeys(TDirectory*)
virtual voidTObject::DoError(int level, const char* location, const char* fmt, va_list va) const
voidTDirectory::FillFullPath(TString& buf) const
virtual TFile::EAsyncOpenStatusGetAsyncOpenStatus()
Long64_tGetRelOffset() const
virtual voidInit(Bool_t create)
Int_tReadBufferViaCache(char* buf, Int_t len)
virtual Int_tSysClose(Int_t fd)
virtual Int_tSysOpen(const char* pathname, Int_t flags, UInt_t mode)
virtual Int_tSysRead(Int_t fd, void* buf, Int_t len)
virtual Long64_tSysSeek(Int_t fd, Long64_t offset, Int_t whence)
virtual Int_tSysStat(Int_t fd, Long_t* id, Long64_t* size, Long_t* flags, Long_t* modtime)
virtual Int_tSysSync(Int_t fd)
virtual Int_tSysWrite(Int_t fd, const void* buf, Int_t len)
Int_tWriteBufferViaCache(const char* buf, Int_t len)
TFile(const TFile&)
voidoperator=(const TFile&)

Data Members

enum EAsyncOpenStatus { kAOSNotAsync
enum EStatusBits { kRecovered
enum ERelativeTo { kBeg
enum { kStartBigFile
enum EFileType { kDefault
enum TDirectory::[unnamed] { kCloseDirectory
enum TObject::EStatusBits { kCanDelete
enum TObject::[unnamed] { kIsOnHeap
Double_tfSumBufferSum of buffer sizes of objects written so far
Double_tfSum2BufferSum of squares of buffer sizes of objects written so far
Long64_tfBytesWriteNumber of bytes written to this file
Long64_tfBytesReadNumber of bytes read from this file
Long64_tfBEGINFirst used byte in file
Long64_tfENDLast used byte in file
Long64_tfSeekFreeLocation on disk of free segments structure
Long64_tfSeekInfoLocation on disk of StreamerInfo record
Int_tfDFile descriptor
Int_tfVersionFile format version
Int_tfCompressCompression level from 0(not compressed) to 9 (max compression)
Int_tfNbytesFreeNumber of bytes for free segments structure
Int_tfNbytesInfoNumber of bytes for StreamerInfo record
Int_tfWrittenNumber of objects written so far
Int_tfNProcessIDsNumber of TProcessID written to this file
Int_tfReadCallsNumber of read calls ( not counting the cache calls )
TStringfRealNameEffective real file name (not original url)
TStringfOptionFile options
Char_tfUnitsNumber of bytes for file pointers
TList*fFreeFree segments linked list table
TArrayC*fClassIndex!Index of TStreamerInfo classes written to this file
TObjArray*fProcessIDs!Array of pointers to TProcessIDs
Long64_tfOffset!Seek offset used by remote file classes
TArchiveFile*fArchive!Archive file from which we read this file
TFileCacheRead*fCacheRead!Pointer to the read cache (if any)
TFileCacheWrite*fCacheWrite!Pointer to the write cache (if any)
Long64_tfArchiveOffset!Offset at which file starts in archive
Bool_tfIsArchive!True if this is a pure archive file
Bool_tfNoAnchorInName!True if we don't want to force the anchor to be appended to the file name
Bool_tfIsRootFile!True is this is a ROOT file, raw file otherwise
Bool_tfInitDone!True if the file has been initialized
Bool_tfMustFlush!True if the file buffers must be flushed
TFileOpenHandle*fAsyncHandle!For proper automatic cleanup
TFile::EAsyncOpenStatusfAsyncOpenStatus!Status of an asynchronous open request
TUrlfUrl!URL of file
TList*fInfoCache!Cached list of the streamer infos in this file
static TList*fgAsyncOpenRequests!List of handles for pending open requests
static Long64_tfgBytesWriteNumber of bytes written by all TFile objects
static Long64_tfgBytesReadNumber of bytes read by all TFile objects
static Long64_tfgFileCounterCounter for all opened files
static Int_tfgReadCallsNumber of bytes read from all TFile objects
static Bool_tfgReadInfoif true (default) ReadStreamerInfo is called when opening a file
Bool_tTDirectory::fModifiedtrue if directory has been modified
Bool_tTDirectory::fWritabletrue if directory is writable
TDatimeTDirectory::fDatimeCDate and time when directory is created
TDatimeTDirectory::fDatimeMDate and time of last modification
Int_tTDirectory::fNbytesKeysNumber of bytes for the keys
Int_tTDirectory::fNbytesNameNumber of bytes in TNamed at creation time
Int_tTDirectory::fBufferSizeDefault buffer size to create new TKeys
Long64_tTDirectory::fSeekDirLocation of directory on file
Long64_tTDirectory::fSeekParentLocation of parent directory on file
Long64_tTDirectory::fSeekKeysLocation of Keys record on file
TFile*TDirectory::fFilepointer to current file in memory
TObject*TDirectory::fMotherpointer to mother of the directory
TList*TDirectory::fListPointer to objects list in memory
TList*TDirectory::fKeysPointer to keys list in memory
TUUIDTDirectory::fUUIDUnique identifier
TStringTDirectory::fPathBuffer!Buffer for GetPath() function
TStringTNamed::fNameobject identifier
TStringTNamed::fTitleobject title

Class Description

 File default Constructor.
TFile(const char *fname1, Option_t *option, const char *ftitle, Int_t compress)
 Opens or creates a local ROOT file whose name is fname1. It is
 recommended to specify fname1 as "<file>.root". The suffix ".root"
 will be used by object browsers to automatically identify the file as
 a ROOT file. If the constructor fails in any way IsZombie() will
 return true. Use IsOpen() to check if the file is (still) open.

 To open non-local files use the static TFile::Open() method, that
 will take care of opening the files using the correct remote file
 access plugin.

 If option = NEW or CREATE   create a new file and open it for writing,
                             if the file already exists the file is
                             not opened.
           = RECREATE        create a new file, if the file already
                             exists it will be overwritten.
           = UPDATE          open an existing file for writing.
                             if no file exists, it is created.
           = READ            open an existing file for reading.
           = NET             used by derived remote file access
                             classes, not a user callable option
           = WEB             used by derived remote http access
                             class, not a user callable option

 The file can be specified as a URL of the form:
    file:///user/rdm/bla.root or file:/user/rdm/bla.root

 The file can also be a member of an archive, in which case it is
 specified as: or
 which will open file.root which is a member of the file
 archive or member 1 from the archive. For more on archive file
 support see the TArchiveFile class.

 TFile and its remote access plugins can also be used to open any
 file, i.e. also non ROOT files, using:
 This is convenient because the many remote file access plugins allow
 easy access to/from the many different mass storage systems.

 The title of the file (ftitle) will be shown by the ROOT browsers.

 A ROOT file (like a Unix file system) may contain objects and
 directories. There are no restrictions for the number of levels
 of directories.

 A ROOT file is designed such that one can write in the file in pure
 sequential mode (case of BATCH jobs). In this case, the file may be
 read sequentially again without using the file index written
 at the end of the file. In case of a job crash, all the information
 on the file is therefore protected.

 A ROOT file can be used interactively. In this case, one has the
 possibility to delete existing objects and add new ones.
 When an object is deleted from the file, the freed space is added
 into the FREE linked list (fFree). The FREE list consists of a chain
 of consecutive free segments on the file. At the same time, the first
 4 bytes of the freed record on the file are overwritten by GAPSIZE
 where GAPSIZE = -(Number of bytes occupied by the record).

 Option compress is used to specify the compression level:
  compress = 0 objects written to this file will not be compressed.
  compress = 1 minimal compression level but fast.
  compress = 9 maximal compression level but slow.

 Note that the compression level may be changed at any time.
 The new compression level will only apply to newly written objects.
 The function TFile::Map() shows the compression factor
 for each object written to this file.
 The function TFile::GetCompressionFactor returns the global
 compression factor for this file.

 In case the file does not exist or is not a valid ROOT file,
 it is made a Zombie. One can detect this situation with a code like:
    TFile f("file.root");
    if (f.IsZombie()) {
       cout << "Error opening file" << endl;

 A ROOT file is a suite of consecutive data records (TKey's) with
 the following format (see also the TKey class). If the key is
 located past the 32 bit file limit (> 2 GB) then some fields will
 be 8 instead of 4 bytes:
    1->4            Nbytes    = Length of compressed object (in bytes)
    5->6            Version   = TKey version identifier
    7->10           ObjLen    = Length of uncompressed object
    11->14          Datime    = Date and time when object was written to file
    15->16          KeyLen    = Length of the key structure (in bytes)
    17->18          Cycle     = Cycle of key
    19->22 [19->26] SeekKey   = Pointer to record itself (consistency check)
    23->26 [27->34] SeekPdir  = Pointer to directory header
    27->27 [35->35] lname     = Number of bytes in the class name
    28->.. [36->..] ClassName = Object Class Name
    ..->..          lname     = Number of bytes in the object name
    ..->..          Name      = lName bytes with the name of the object
    ..->..          lTitle    = Number of bytes in the object title
    ..->..          Title     = Title of the object
    ----->          DATA      = Data bytes associated to the object

 The first data record starts at byte fBEGIN (currently set to kBEGIN).
 Bytes 1->kBEGIN contain the file description, when fVersion >= 1000000
 it is a large file (> 2 GB) and the offsets will be 8 bytes long and
 fUnits will be set to 8:
    1->4            "root"      = Root file identifier
    5->8            fVersion    = File format version
    9->12           fBEGIN      = Pointer to first data record
    13->16 [13->20] fEND        = Pointer to first free word at the EOF
    17->20 [21->28] fSeekFree   = Pointer to FREE data record
    21->24 [29->32] fNbytesFree = Number of bytes in FREE data record
    25->28 [33->36] nfree       = Number of free data records
    29->32 [37->40] fNbytesName = Number of bytes in TNamed at creation time
    33->33 [41->41] fUnits      = Number of bytes for file pointers
    34->37 [42->45] fCompress   = Zip compression level
    38->41 [46->53] fSeekInfo   = Pointer to TStreamerInfo record
    42->45 [54->57] fNbytesInfo = Number of bytes in TStreamerInfo record
    46->63 [58->75] fUUID       = Universal Unique ID
/* */

 The structure of a directory is shown in TDirectory::TDirectory
TFile(const TFile &file)
 Copy constructor.
 File destructor.
void Init(Bool_t create)
 Initialize a TFile object.
 TFile implementations providing asynchronous open functionality need to
 override this method to run the appropriate checks before calling this
 standard initialization part. See TXNetFile::Init for an example.
void Close(Option_t *option)
 Close a file.
 If option == "R", all TProcessIDs referenced by this file are deleted.
 Calling TFile::Close("R") might be necessary in case one reads a long list
 of files having TRef, writing some of the referenced objects or TRef
 to a new file. If the TRef or referenced objects of the file being closed
 will not be referenced again, it is possible to minimize the size
 of the TProcessID data structures in memory by forcing a delete of
 the unused TProcessID.
TKey* CreateKey(TDirectory* mother, const TObject* obj, const char* name, Int_t bufsize)
 Creates key for object and converts data to buffer.
TKey* CreateKey(TDirectory* mother, const void* obj, const TClass* cl, const char* name, Int_t bufsize)
 Creates key for object and converts data to buffer.
void Delete(const char *namecycle)
 Delete object namecycle.
 Namecycle identifies an object in the top directory of the file
   namecycle has the format name;cycle
   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

     foo   : delete object named foo in memory
     foo;1 : delete cycle 1 of foo on file
     foo;* : delete all cycles of foo on disk 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
void Draw(Option_t *option)
 Fill Graphics Structure and Paint.
 Loop on all objects (memory or file) and all subdirectories.
void DrawMap(const char *keys, Option_t *option)
 Draw map of objects in this file.
void Flush()
 Synchronize a file's in-core and on-disk states.
Bool_t FlushWriteCache()
 Flush the write cache if active.
 Return kTRUE in case of error
void FillBuffer(char *&buffer)
 Encode file output buffer.
 The file output buffer contains only the FREE data record.
Int_t GetBestBuffer()
 Return the best buffer size of objects on this file.
 The best buffer size is estimated based on the current mean value
 and standard deviation of all objects written so far to this file.
 Returns mean value + one standard deviation.
Float_t GetCompressionFactor()
 Return the file compression factor.
 Add total number of compressed/uncompressed bytes for each key.
 return ratio of the two.
Int_t GetErrno()
 Method returning errno. Is overriden in TRFIOFile.
void ResetErrno()
 Method resetting the errno. Is overridden in TRFIOFile.
TFileCacheRead * GetCacheRead()
 Return a pointer to the current read cache.
TFileCacheWrite * GetCacheWrite()
 Return a pointer to the current write cache.
Int_t GetRecordHeader(char *buf, Long64_t first, Int_t maxbytes, Int_t &nbytes, Int_t &objlen, Int_t &keylen)
 Read the logical record header starting at position first.
 Maxbytes bytes are read into buf the function reads nread bytes
 where nread is the minimum of maxbytes and the number of bytes
 before the end of file. The function returns nread.
 In output arguments:
    nbytes : number of bytes in record
             if negative, this is a deleted record
             if 0, cannot read record, wrong value of argument first
    objlen : uncompressed object size
    keylen : length of logical record header
 Note that the arguments objlen and keylen are returned only
 if maxbytes >=16
Long64_t GetSize()
 Returns the current file size. Returns -1 in case the file could not
 be stat'ed.
const TList * GetStreamerInfoCache()
 Returns the cached list of StreamerInfos used in this file.
TList * GetStreamerInfoList()
 Read the list of TStreamerInfo objects written to this file.
 The function returns a TList. It is the user'responsability
 to delete the list created by this function.

 Using the list, one can access additional information,eg:
   TFile f("myfile.root");
   TList *list = f.GetStreamerInfoList();
   TStreamerInfo *info = (TStreamerInfo*)list->FindObject("MyClass");
   Int_t classversionid = info->GetClassVersion();
   delete list;
void ls(Option_t *option)
 List File contents.
 Indentation is used to identify the file tree.
 Subdirectories are listed first, then objects in memory,
 then objects on the file.
Bool_t IsOpen()
 Returns kTRUE in case file is open and kFALSE if file is not open.
void MakeFree(Long64_t first, Long64_t last)
 Mark unused bytes on the file.
 The list of free segments is in the fFree linked list.
 When an object is deleted from the file, the freed space is added
 into the FREE linked list (fFree). The FREE list consists of a chain
 of consecutive free segments on the file. At the same time, the first
 4 bytes of the freed record on the file are overwritten by GAPSIZE
 where GAPSIZE = -(Number of bytes occupied by the record).
void Map()
 List the contents of a file sequentially.
 For each logical record found, it prints:
  Date/Time  Record_Adress Logical_Record_Length  ClassName  CompressionFactor

  Example of output
  20010404/150437  At:64        N=150       TFile
  20010404/150440  At:214       N=28326     TBasket        CX =  1.13
  20010404/150440  At:28540     N=29616     TBasket        CX =  1.08
  20010404/150440  At:58156     N=29640     TBasket        CX =  1.08
  20010404/150440  At:87796     N=29076     TBasket        CX =  1.10
  20010404/150440  At:116872    N=10151     TBasket        CX =  3.15
  20010404/150441  At:127023    N=28341     TBasket        CX =  1.13
  20010404/150441  At:155364    N=29594     TBasket        CX =  1.08
  20010404/150441  At:184958    N=29616     TBasket        CX =  1.08
  20010404/150441  At:214574    N=29075     TBasket        CX =  1.10
  20010404/150441  At:243649    N=9583      TBasket        CX =  3.34
  20010404/150442  At:253232    N=28324     TBasket        CX =  1.13
  20010404/150442  At:281556    N=29641     TBasket        CX =  1.08
  20010404/150442  At:311197    N=29633     TBasket        CX =  1.08
  20010404/150442  At:340830    N=29091     TBasket        CX =  1.10
  20010404/150442  At:369921    N=10341     TBasket        CX =  3.09
  20010404/150442  At:380262    N=509       TH1F           CX =  1.93
  20010404/150442  At:380771    N=1769      TH2F           CX =  4.32
  20010404/150442  At:382540    N=1849      TProfile       CX =  1.65
  20010404/150442  At:384389    N=18434     TNtuple        CX =  4.51
  20010404/150442  At:402823    N=307       KeysList
  20010404/150443  At:403130    N=4548      StreamerInfo   CX =  3.65
  20010404/150443  At:407678    N=86        FreeSegments
  20010404/150443  At:407764    N=1         END
void Paint(Option_t *option)
 Paint all objects in the file.
void Print(Option_t *option)
 Print all objects in the file.
Bool_t ReadBuffer(char *buf, Int_t len)
 Read a buffer from the file. This is the basic low level read operation.
 Returns kTRUE in case of failure.
Bool_t ReadBuffers(char *buf, Long64_t *pos, Int_t *len, Int_t nbuf)
 Read the nbuf blocks described in arrays pos and len,
 where pos[i] is the seek position of block i of length len[i].
 Note that for nbuf=1, this call is equivalent to TFile::ReafBuffer.
 This function is overloaded by TNetFile, TWebFile, etc.
 Returns kTRUE in case of failure.
Int_t ReadBufferViaCache(char *buf, Int_t len)
 Read buffer via cache. Returns 0 if the requested block is
 not in the cache, 1 in case read via cache was successful,
 2 in case read via cache failed.
void ReadFree()
 Read the FREE linked list.
 Every file has a linked list (fFree) of free segments.
 This linked list has been written on the file via WriteFree
 as a single data record.
Int_t Recover()
 Attempt to recover file if not correctly closed.
 The function returns the number of keys that have been recovered.
 If no keys can be recovered, the file will be declared Zombie by
 the calling function. This function is automatically called when
 opening a file.

 If the file is open in read only mode, the file is not modified.
 If open in update mode and the function finds something to recover,
  a new directory header is written to the file. When opening the file gain
  no message from Recover will be reported.
 If keys have been recovered, the file is usable and you can safely
 read the corresponding objects.
 If the file is not usable (a zombie), you can test for this case
 with code like:
   TFile f("myfile.root");
   if (f.IsZombie()) {file is unusable)
 If the file has been recovered, the bit kRecovered is set in the TFile object in memory.
 You can test if the file has been recovered with
   if (f.TestBit(TFile::kRecovered)) {.. the file has been recovered}

 When writing TTrees to a file, it is important to save the Tree header
 at regular intervals (see TTree::AutoSave). If a file containing a Tree
 is recovered, the last Tree header written to the file will be used.
 In this case all the entries in all the branches written before writing
 the header are valid entries.
Int_t ReOpen(Option_t *mode)
 Reopen a file with a different access mode, like from READ to
 mode argument can be either "READ" or "UPDATE". The method returns
 0 in case the mode was successfully modified, 1 in case the mode
 did not change (was already as requested or wrong input arguments)
 and -1 in case of failure, in which case the file cannot be used
 anymore. The current directory (gFile) is changed to this file.
void Seek(Long64_t offset, ERelativeTo pos)
 Seek to a specific position in the file. Pos it either kBeg, kCur or kEnd.
void SetCompressionLevel(Int_t level)
 Set level of compression for this file:
  level = 0 objects written to this file will not be compressed.
  level = 1 minimal compression level but fast.
  level = 9 maximal compression level but slow.

 Note that the compression level may be changed at any time.
 The new compression level will only apply to newly written objects.
 The function TFile::Map shows the compression factor
 for each object written to this file.
 The function TFile::GetCompressionFactor returns the global
 compression factor for this file.
void SetCacheRead(TFileCacheRead *cache)
 Set a pointer to the read cache.
void SetCacheWrite(TFileCacheWrite *cache)
 Set a pointer to the write cache.
 If file is null the existing write cache is deleted.
Int_t Sizeof()
 Return the size in bytes of the file header.
void Streamer(TBuffer &b)
 Stream a TFile object.
void SumBuffer(Int_t bufsize)
 Increment statistics for buffer sizes of objects in this file.
void UseCache(Int_t /*maxCacheSize*/, Int_t /*pageSize*/)
 Dummy function kept for backward compatibility.
 The read  cache is now managed by TFileCacheRead
 The write cache is now managed by TFileCacheWrite
 Both caches are created automatically by the system.
Int_t Write(const char *, Int_t opt, Int_t bufsiz)
 Write memory objects to this file.
 Loop on all objects in memory (including subdirectories).
 A new key is created in the KEYS linked list for each object.
 The list of keys is then saved on the file (via WriteKeys)
 as a single data record.
 For values of opt see TObject::Write().
 The directory header info is rewritten on the directory header record.
 The linked list of FREE segments is written.
 The file header is written (bytes 1->fBEGIN).
Int_t Write(const char *n, Int_t opt, Int_t bufsize)
 One can not save a const TDirectory object.
Bool_t WriteBuffer(const char *buf, Int_t len)
 Write a buffer to the file. This is the basic low level write operation.
 Returns kTRUE in case of failure.
Int_t WriteBufferViaCache(const char *buf, Int_t len)
 Write buffer via cache. Returns 0 if cache is not active, 1 in case
 write via cache was successful, 2 in case write via cache failed.
void WriteFree()
 Write FREE linked list on the file.
 The linked list of FREE segments (fFree) is written as a single data
void WriteHeader()
 Write File Header.
void MakeProject(const char *dirname, const char * /*classes*/, Option_t *option)
 Generate code in directory dirname for all classes specified in argument classes
 If classes = "*" (default), the function generates an include file for each
 class in the StreamerInfo list for which a TClass object does not exist.
 One can restrict the list of classes to be generated by using expressions like:
   classes = "Ali*" generate code only for classes starting with Ali
   classes = "myClass" generate code for class MyClass only.

 If option = "new" (default) a new directory dirname is created.
                   If dirname already exist, an error message is printed
                   and the function returns.
 If option = "recreate", then;
                   if dirname does not exist, it is created (like in "new")
                   if dirname already exist, all existing files in dirname
                   are deleted before creating the new files.
 If option = "update", then new classes are added to the existing directory.
                   Existing classes with the same name are replaced by the
                   new definition. If the directory dirname doest not exist,
                   same effect as "new".
 If, in addition to one of the 3 above options, the option "+" is specified,
 the function will generate:
   - a script called MAKE to build the shared lib
   - a LinkDef.h file
   - rootcint will be run to generate a dirnameProjectDict.cxx file
   - dirnameProjectDict.cxx will be compiled with the current options in compiledata.h
   - a shared lib will be created.
 If the option "++" is specified, the generated shared lib is dynamically
 linked with the current executable module.
  - creates a new directory demo unless it already exist
  - clear the previous directory content
  - generate the xxx.h files for all classes xxx found in this file
    and not yet known to the CINT dictionary.
  - creates the build script MAKE
  - creates a LinkDef.h file
  - runs rootcint generating demoProjectDict.cxx
  - compiles demoProjectDict.cxx into demoProjectDict.o
  - generates a shared lib
  - dynamically links the shared lib to the executable
  If only the option "+" had been specified, one can still link the
  shared lib to the current executable module with:
void ReadStreamerInfo()
 Read the list of StreamerInfo from this file.
 The key with name holding the list of TStreamerInfo objects is read.
 The corresponding TClass objects are updated.
 Note that this function is not called if the static member fgReadInfo is falsse.
  (see TFile::SetReadStreamerInfo)
void SetReadStreamerInfo(Bool_t readinfo)
 static function to set fgReadInfo.
 If fgReadInfo is true (default) TFile::ReadStreamerInfo is called
  when opening the file.
 It may be interesting to set fgReadInfo to false to speedup the file
 opening time or in case libraries containing classes referenced
 by the file have not yet been loaded.
 if fgReadInfo is false, one can still read the StreamerInfo with
void ShowStreamerInfo()
 Show the StreamerInfo of all classes written to this file.
void WriteStreamerInfo()
 Write the list of TStreamerInfo as a single object in this file
 The class Streamer description for all classes written to this file
 is saved. See class TStreamerInfo.
TFile * Open(const char *name, Option_t *option, const char *ftitle, Int_t compress, Int_t netopt)
 Static member function allowing the creation/opening of either a
 TFile, TNetFile, TWebFile or any TFile derived class for which an
 plugin library handler has been registered with the plugin manager
 (for the plugin manager see the TPluginManager class). The returned
 type of TFile depends on the file name. If the file starts with
 "root:", "roots:" or "rootk:" a TNetFile object will be returned,
 with "http:" a TWebFile, with "file:" a local TFile, etc. (see the
 list of TFile plugin handlers in $ROOTSYS/etc/system.rootrc for regular
 expressions that will be checked) and as last a local file will be tried.
 Before opening a file via TNetFile a check is made to see if the URL
 specifies a local file. If that is the case the file will be opened
 via a normal TFile. To force the opening of a local file via a
 TNetFile use either TNetFile directly or specify as host "localhost".
 The netopt argument is only used by TNetFile. For the meaning of the
 options and other arguments see the constructors of the individual
 file classes. In case of error returns 0.
TFileOpenHandle * AsyncOpen(const char *name, Option_t *option, const char *ftitle, Int_t compress, Int_t netopt)
 Static member function to submit an open request. The request will be
 processed asynchronously. See TFile::Open(const char *, ...) for an
 explanation of the arguments. A handler is returned which is to be passed
 to TFile::Open(TFileOpenHandle *) to get the real TFile instance once
 the file is open.
 This call never blocks and it is provided to allow parallel submission
 of file opening operations expected to take a long time.
 TFile::Open(TFileOpenHandle *) may block if the file is not yet ready.
 The sequence
    TFile::Open(TFile::AsyncOpen(const char *, ...))
 is equivalent to
    TFile::Open(const char *, ...) .
 To be effective, the underlying TFile implementation must be able to
 support asynchronous open functionality. Currently, only TXNetFile
 supports it. If the functionality is not implemented, this call acts
 transparently by returning an handle with the arguments for the
 standard synchronous open run by TFile::Open(TFileOpenHandle *).
 The retuned handle will be adopted by TFile after opening completion
 in TFile::Open(TFileOpenHandle *); if opening is not finalized the
 handle must be deleted by the caller.
TFile * Open(TFileOpenHandle *fh)
 Waits for the completion of an asynchronous open request.
 Returns the associated TFile, transferring ownership of the
 handle to the TFile instance.
Int_t SysOpen(const char *pathname, Int_t flags, UInt_t mode)
 Interface to system open. All arguments like in POSIX open().
Int_t SysClose(Int_t fd)
 Interface to system close. All arguments like in POSIX close().
Int_t SysRead(Int_t fd, void *buf, Int_t len)
 Interface to system read. All arguments like in POSIX read().
Int_t SysWrite(Int_t fd, const void *buf, Int_t len)
 Interface to system write. All arguments like in POSIX write().
Long64_t SysSeek(Int_t fd, Long64_t offset, Int_t whence)
 Interface to system lseek. All arguments like in POSIX lseek()
 except that the offset and return value are of a type which are
 able to handle 64 bit file systems.
Int_t SysStat(Int_t, Long_t *id, Long64_t *size, Long_t *flags, Long_t *modtime)
 Return file stat information. The interface and return value is
 identical to TSystem::GetPathInfo(). The function returns 0 in
 case of success and 1 if the file could not be stat'ed.
Int_t SysSync(Int_t fd)
 Interface to system fsync. All arguments like in POSIX fsync().
Long64_t GetBytesWritten()
 Return the total number of bytes written so far to the file.
Long64_t GetFileBytesRead()
 Static function returning the total number of bytes read from all files.
Long64_t GetFileBytesWritten()
 Static function returning the total number of bytes written to all files.
 Does not take into account what might still be in the write caches.
Int_t GetFileReadCalls()
 Static function returning the total number of read calls from all files.
void SetFileBytesRead(Long64_t bytes)
{ fgBytesRead = bytes; }
void SetFileBytesWritten(Long64_t bytes)
{ fgBytesWrite = bytes; }
void SetFileReadCalls(Int_t readcalls)
{ fgReadCalls = readcalls; }
Long64_t GetFileCounter()
{ return fgFileCounter; }
void IncrementFileCounter()
{ fgFileCounter++; }
Bool_t Matches(const char *url)
 Return kTRUE if 'url' matches the coordinates of this file.
 The check is implementation dependent and may need to be overload
 by each TFile implememtation relying on this check.
 The default implementation checks teh file name only.
const TUrl * GetEndpointUrl(const char* name)
 Get final URL for file being opened asynchronously.
 Returns 0 is the information is not yet available.
EAsyncOpenStatus GetAsyncOpenStatus()
{ return fAsyncOpenStatus; }
Long64_t GetRelOffset()
{ return fOffset - fArchiveOffset; }
Long64_t DirCreateEntry(TDirectory*)
 Interface for text-based TDirectory I/O
{ return 0; }
Int_t DirReadKeys(TDirectory*)
{ return 0; }
void DirWriteKeys(TDirectory*)
void DirWriteHeader(TDirectory*)
void operator=(const TFile &)
void Copy(TObject &)
{ MayNotUse("Copy(TObject &)"); }
TArchiveFile * GetArchive()
{ return fArchive; }
TArrayC * GetClassIndex()
{ return fClassIndex; }
Int_t GetCompressionLevel()
{ return fCompress; }
Long64_t GetEND()
{ return fEND; }
Int_t GetFd()
{ return fD; }
const TUrl * GetEndpointUrl()
{ return &fUrl; }
TObjArray * GetListOfProcessIDs()
{return fProcessIDs;}
TList * GetListOfFree()
{ return fFree; }
Int_t GetNfree()
{ return fFree->GetSize(); }
Int_t GetNProcessIDs()
{ return fNProcessIDs; }
Option_t * GetOption()
{ return fOption.Data(); }
Long64_t GetBytesRead()
{ return fBytesRead; }
Int_t GetReadCalls()
{ return fReadCalls; }
Int_t GetVersion()
{ return fVersion; }
Int_t GetNbytesInfo()
{return fNbytesInfo;}
Int_t GetNbytesFree()
{return fNbytesFree;}
Long64_t GetSeekFree()
{return fSeekFree;}
Long64_t GetSeekInfo()
{return fSeekInfo;}
void IncrementProcessIDs()
{ fNProcessIDs++; }
Bool_t IsArchive()
{ return fIsArchive; }
Bool_t IsBinary()
{ return TestBit(kBinaryFile); }
Bool_t IsRaw()
{ return !fIsRootFile; }
Bool_t MustFlush()
{return fMustFlush;}
void SetEND(Long64_t last)
{ fEND = last; }
void SetOption(Option_t *option=">")
{ fOption = option; }
void SetReadCalls(Int_t readcalls = 0)
{ fReadCalls = readcalls; }
EFileType GetType(const char *name, Option_t *option = "")
EAsyncOpenStatus GetAsyncOpenStatus(const char *name)
EAsyncOpenStatus GetAsyncOpenStatus(TFileOpenHandle *handle)

Author: Rene Brun 28/11/94
Last update: root/base:$Name: $:$Id: TFile.cxx,v 1.193 2006/11/07 15:18:29 brun Exp $
Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *

ROOT page - Class index - Class Hierarchy - Top of the page

This page has been automatically generated. If you have any comments or suggestions about the page layout send a mail to ROOT support, or contact the developers with any questions or problems regarding ROOT.