ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
TXMLFile Class Reference

Definition at line 32 of file TXMLFile.h.

Public Member Functions

 TXMLFile ()
 default TXMLFile constructor More...
 
 TXMLFile (const char *filename, Option_t *option="read", const char *title="title", Int_t compression=1)
 Open or creates local XML file with name filename. More...
 
virtual ~TXMLFile ()
 destructor of TXMLFile object More...
 
virtual void Close (Option_t *option="")
 Close a XML file For more comments see TFile::Close() function. More...
 
virtual TKeyCreateKey (TDirectory *mother, const TObject *obj, const char *name, Int_t bufsize)
 create XML key, which will store object in xml structures More...
 
virtual TKeyCreateKey (TDirectory *mother, const void *obj, const TClass *cl, const char *name, Int_t bufsize)
 create XML key, which will store object in xml structures More...
 
virtual void DrawMap (const char *="*", Option_t *="")
 Draw map of objects in this file. More...
 
virtual void FillBuffer (char *&)
 Encode file output buffer. More...
 
virtual void Flush ()
 Synchronize a file's in-memory and on-disk states. More...
 
virtual Long64_t GetEND () const
 
virtual Int_t GetErrno () const
 Method returning errno. Is overriden in TRFIOFile. More...
 
virtual void ResetErrno () const
 Method resetting the errno. Is overridden in TRFIOFile. More...
 
virtual Int_t GetNfree () const
 
virtual Int_t GetNbytesInfo () const
 
virtual Int_t GetNbytesFree () const
 
virtual Long64_t GetSeekFree () const
 
virtual Long64_t GetSeekInfo () const
 
virtual Long64_t GetSize () const
 Returns the current file size. More...
 
virtual TListGetStreamerInfoList ()
 Read streamerinfo structures from xml format and provide them in the list It is user responsibility to destroy this list. More...
 
Int_t GetIOVersion () const
 
virtual Bool_t IsOpen () const
 return kTRUE if file is opened and can be accessed More...
 
virtual void MakeFree (Long64_t, Long64_t)
 Mark unused bytes on the file. More...
 
virtual void MakeProject (const char *, const char *="*", Option_t *="new")
 Generate source code necessary to access the objects stored in the file. More...
 
virtual void Map ()
 List the contents of a file sequentially. More...
 
virtual void Paint (Option_t *="")
 Paint all objects in the file. More...
 
virtual void Print (Option_t *="") const
 Print all objects in the file. More...
 
virtual Bool_t ReadBuffer (char *, Int_t)
 Read a buffer from the file. More...
 
virtual Bool_t ReadBuffer (char *, Long64_t, Int_t)
 Read a buffer from the file at the offset 'pos' in the file. More...
 
virtual void ReadFree ()
 Read the FREE linked list. More...
 
virtual Int_t Recover ()
 Attempt to recover file if not correctly closed. More...
 
virtual Int_t ReOpen (Option_t *mode)
 Reopen a file with a different access mode, like from READ to See TFile::Open() for details. More...
 
virtual void Seek (Long64_t, ERelativeTo=kBeg)
 Seek to a specific position in the file. Pos it either kBeg, kCur or kEnd. More...
 
virtual void SetEND (Long64_t)
 
virtual Int_t Sizeof () const
 Return the size in bytes of the file header. More...
 
virtual Bool_t WriteBuffer (const char *, Int_t)
 Write a buffer to the file. More...
 
virtual Int_t Write (const char *=0, Int_t=0, Int_t=0)
 Write memory objects to this file. More...
 
virtual Int_t Write (const char *=0, Int_t=0, Int_t=0) const
 One can not save a const TDirectory object. More...
 
virtual void WriteFree ()
 Write FREE linked list on the file. More...
 
virtual void WriteHeader ()
 Write File Header. More...
 
virtual void WriteStreamerInfo ()
 convert all TStreamerInfo, used in file, to xml format More...
 
virtual void SetXmlLayout (EXMLLayout layout)
 Change layout of objects in xml file Can be changed only for newly created file. More...
 
virtual void SetStoreStreamerInfos (Bool_t iConvert=kTRUE)
 If true, all correspondent to file TStreamerInfo objects will be stored in file this allows to apply schema avolution later for this file may be usefull, when file used outside ROOT and TStreamerInfo objects does not required Can be changed only for newly created file. More...
 
virtual void SetUsedDtd (Bool_t use=kTRUE)
 Specify usage of DTD for this file. More...
 
virtual void SetUseNamespaces (Bool_t iUseNamespaces=kTRUE)
 Specifiy usage of namespaces in xml file In current implementation every instrumented class in file gets its unique namespace, which is equal to name of class and refer to root documentation page like <TAttPad xmlns:TAttPad="http://root.cern.ch/root/htmldoc/TAttPad.html" version="3"> And xml node for class member gets its name as combination of class name and member name <TAttPad:fLeftMargin v="0.100000"/> <TAttPad:fRightMargin v="0.100000"/> <TAttPad:fBottomMargin v="0.100000"/> and so on Usage of namespace increase size of xml file, but makes file more readable and allows to produce DTD in the case, when in several classes data member has same name Can be changed only for newly created file. More...
 
Bool_t AddXmlComment (const char *comment)
 Add comment line on the top of the xml document This line can only be seen in xml editor and cannot be accessed later with TXMLFile methods. More...
 
Bool_t AddXmlStyleSheet (const char *href, const char *type="text/css", const char *title=0, int alternate=-1, const char *media=0, const char *charset=0)
 Adds style sheet definition on the top of xml document Creates <?xml-stylesheet alternate="yes" title="compact" href="small-base.css" type="text/css"?> Attributes href and type must be supplied, other attributes: title, alternate, media, charset are optional if alternate==0, attribyte alternate="no" will be created, if alternate>0, attribute alternate="yes" if alternate<0, attribute will not be created This style sheet definition cannot be later access with TXMLFile methods. More...
 
Bool_t AddXmlLine (const char *line)
 Add just one line on the top of xml document For instance, line can contain special xml processing instructions Line should has correct xml syntax that later it can be decoded by xml parser To be parsed later by TXMLFile again, this line should contain either xml comments or xml processing instruction. More...
 
TXMLEngineXML ()
 
- Public Member Functions inherited from TFile
 TFile ()
 File default Constructor. More...
 
 TFile (const char *fname, Option_t *option="", const char *ftitle="", Int_t compress=1)
 Opens or creates a local ROOT file. More...
 
virtual ~TFile ()
 File destructor. More...
 
virtual void Copy (TObject &) const
 Copy this to obj. More...
 
virtual Bool_t Cp (const char *dst, Bool_t progressbar=kTRUE, UInt_t buffersize=1000000)
 Allows to copy this file to the dst URL. More...
 
virtual void Delete (const char *namecycle="")
 Delete object namecycle. More...
 
virtual void Draw (Option_t *option="")
 Fill Graphics Structure and Paint. More...
 
TArchiveFileGetArchive () const
 
Long64_t GetArchiveOffset () const
 
Int_t GetBestBuffer () const
 Return the best buffer size of objects on this file. More...
 
virtual Int_t GetBytesToPrefetch () const
 Max number of bytes to prefetch. More...
 
TFileCacheReadGetCacheRead (TObject *tree=0) const
 Return a pointer to the current read cache. More...
 
TFileCacheWriteGetCacheWrite () const
 Return a pointer to the current write cache. More...
 
TArrayCGetClassIndex () const
 
Int_t GetCompressionAlgorithm () const
 
Int_t GetCompressionLevel () const
 
Int_t GetCompressionSettings () const
 
Float_t GetCompressionFactor ()
 Return the file compression factor. More...
 
Int_t GetFd () const
 
virtual const TUrlGetEndpointUrl () const
 
TObjArrayGetListOfProcessIDs () const
 
TListGetListOfFree () const
 
virtual Int_t GetNProcessIDs () const
 
Option_tGetOption () const
 
virtual Long64_t GetBytesRead () const
 
virtual Long64_t GetBytesReadExtra () const
 
virtual Long64_t GetBytesWritten () const
 Return the total number of bytes written so far to the file. More...
 
virtual Int_t GetReadCalls () const
 
Int_t GetVersion () const
 
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 a certain postion. More...
 
virtual TString GetNewUrl ()
 
Long64_t GetRelOffset () const
 
const TListGetStreamerInfoCache ()
 Returns the cached list of StreamerInfos used in this file. More...
 
virtual void IncrementProcessIDs ()
 
virtual Bool_t IsArchive () const
 
Bool_t IsBinary () const
 
Bool_t IsRaw () const
 
virtual void ls (Option_t *option="") const
 List file contents. More...
 
virtual Bool_t Matches (const char *name)
 Return kTRUE if 'url' matches the coordinates of this file. More...
 
virtual Bool_t MustFlush () const
 
virtual Bool_t ReadBufferAsync (Long64_t offs, Int_t len)
 
virtual Bool_t ReadBuffers (char *buf, Long64_t *pos, Int_t *len, Int_t nbuf)
 Read the nbuf blocks described in arrays pos and len. More...
 
virtual TProcessIDReadProcessID (UShort_t pidf)
 The TProcessID with number pidf is read from this file. More...
 
virtual void ReadStreamerInfo ()
 Read the list of StreamerInfo from this file. More...
 
virtual void SetCacheRead (TFileCacheRead *cache, TObject *tree=0, ECacheAction action=kDisconnect)
 Set a pointer to the read cache. More...
 
virtual void SetCacheWrite (TFileCacheWrite *cache)
 Set a pointer to the write cache. More...
 
virtual void SetCompressionAlgorithm (Int_t algorithm=0)
 See comments for function SetCompressionSettings. More...
 
virtual void SetCompressionLevel (Int_t level=1)
 See comments for function SetCompressionSettings. More...
 
virtual void SetCompressionSettings (Int_t settings=1)
 Used to specify the compression level and algorithm. More...
 
virtual void SetOffset (Long64_t offset, ERelativeTo pos=kBeg)
 Set position from where to start reading. More...
 
virtual void SetOption (Option_t *option=">")
 
virtual void SetReadCalls (Int_t readcalls=0)
 
virtual void ShowStreamerInfo ()
 Show the StreamerInfo of all classes written to this file. More...
 
void SumBuffer (Int_t bufsize)
 Increment statistics for buffer sizes of objects in this file. More...
 
virtual UShort_t WriteProcessID (TProcessID *pid)
 Check if the ProcessID pidd is already in the file, if not, add it and return the index number in the local file list. More...
 
- Public Member Functions inherited from TDirectoryFile
 TDirectoryFile ()
 
 TDirectoryFile (const char *name, const char *title, Option_t *option="", TDirectory *motherDir=0)
 Create a new TDirectoryFile. More...
 
virtual ~TDirectoryFile ()
 Destructor. More...
 
virtual void Append (TObject *obj, Bool_t replace=kFALSE)
 Append object to this directory. More...
 
void Add (TObject *obj, Bool_t replace=kFALSE)
 
Int_t AppendKey (TKey *key)
 Insert key in the linked list of keys of this directory. More...
 
virtual void Browse (TBrowser *b)
 Browse the content of the directory. More...
 
void Build (TFile *motherFile=0, TDirectory *motherDir=0)
 Initialise directory to defaults. More...
 
virtual TObjectCloneObject (const TObject *obj, Bool_t autoadd=kTRUE)
 Make a clone of an object using the Streamer facility. More...
 
virtual Bool_t cd (const char *path=0)
 Change current directory to "this" directory. More...
 
virtual TKeyFindKey (const char *keyname) const
 Find key with name keyname in the current directory. More...
 
virtual TKeyFindKeyAny (const char *keyname) const
 Find key with name keyname in the current directory or its subdirectories. More...
 
virtual TObjectFindObjectAny (const char *name) const
 Find object by name in the list of memory objects of the current directory or its sub-directories. More...
 
virtual TObjectFindObjectAnyFile (const char *name) const
 Scan the memory lists of all files for an object with name. More...
 
virtual TObjectGet (const char *namecycle)
 Return pointer to object identified by namecycle. More...
 
virtual TDirectoryGetDirectory (const char *apath, Bool_t printError=false, const char *funcname="GetDirectory")
 Find a directory named "apath". More...
 
template<class T >
void GetObject (const char *namecycle, T *&ptr)
 
virtual voidGetObjectChecked (const char *namecycle, const char *classname)
 See documentation of TDirectoryFile::GetObjectCheck(const char *namecycle, const TClass *cl) More...
 
virtual voidGetObjectChecked (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. More...
 
virtual voidGetObjectUnchecked (const char *namecycle)
 Return pointer to object identified by namecycle. More...
 
virtual Int_t GetBufferSize () const
 Return the buffer size to create new TKeys. More...
 
const TDatimeGetCreationDate () const
 
virtual TFileGetFile () const
 
virtual TKeyGetKey (const char *name, Short_t cycle=9999) const
 Return pointer to key with name,cycle. More...
 
virtual TListGetListOfKeys () const
 
const TDatimeGetModificationDate () const
 
virtual Int_t GetNbytesKeys () const
 
virtual Int_t GetNkeys () const
 
virtual Long64_t GetSeekDir () const
 
virtual Long64_t GetSeekParent () const
 
virtual Long64_t GetSeekKeys () const
 
Bool_t IsModified () const
 
Bool_t IsWritable () const
 
virtual TDirectorymkdir (const char *name, const char *title="")
 Create a sub-directory and return a pointer to the created directory. More...
 
virtual TFileOpenFile (const char *name, Option_t *option="", const char *ftitle="", Int_t compress=1, Int_t netopt=0)
 Interface to TFile::Open. More...
 
virtual void Purge (Short_t nkeep=1)
 Purge lowest key cycles in a directory. More...
 
virtual void ReadAll (Option_t *option="")
 Read objects from a ROOT file directory into memory. More...
 
virtual Int_t ReadKeys (Bool_t forceRead=kTRUE)
 Read the linked list of keys. More...
 
virtual Int_t ReadTObject (TObject *obj, const char *keyname)
 Read object with keyname from the current directory. More...
 
virtual void ResetAfterMerge (TFileMergeInfo *)
 Reset the TDirectory after its content has been merged into another Directory. More...
 
virtual void rmdir (const char *name)
 Removes subdirectory from the directory. More...
 
virtual void Save ()
 Save recursively all directory keys and headers. More...
 
virtual void SaveSelf (Bool_t force=kFALSE)
 Save Directory keys and header. More...
 
virtual Int_t SaveObjectAs (const TObject *obj, const char *filename="", Option_t *option="") const
 Save object in filename. More...
 
virtual void SetBufferSize (Int_t bufsize)
 Set the default buffer size when creating new TKeys. More...
 
void SetModified ()
 
void SetSeekDir (Long64_t v)
 
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 number into fBits. More...
 
void SetWritable (Bool_t writable=kTRUE)
 Set the new value of fWritable recursively. More...
 
virtual Int_t WriteTObject (const TObject *obj, const char *name=0, Option_t *option="", Int_t bufsize=0)
 Write object obj to this directory. More...
 
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. More...
 
virtual Int_t WriteObjectAny (const void *obj, const TClass *cl, const char *name, Option_t *option="", Int_t bufsize=0)
 Write object of class with dictionary cl in this directory. More...
 
virtual void WriteDirHeader ()
 Overwrite the Directory header record. More...
 
virtual void WriteKeys ()
 Write Keys linked list on the file. More...
 
- Public Member Functions inherited from TDirectory
 TDirectory ()
 
 TDirectory (const char *name, const char *title, Option_t *option="", TDirectory *motherDir=0)
 Create a new Directory. More...
 
virtual ~TDirectory ()
 Destructor. More...
 
virtual void Clear (Option_t *option="")
 Delete all objects from a Directory list. More...
 
virtual void DeleteAll (Option_t *option="")
 Delete all objects from memory. More...
 
virtual TObjectFindObject (const char *name) const
 Find object by name in the list of memory objects. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Find object in the list of memory objects. More...
 
template<class T >
void GetObject (const char *namecycle, T *&ptr)
 
virtual TListGetList () const
 
virtual TObjectGetMother () const
 
virtual TDirectoryGetMotherDir () const
 
virtual const char * GetPathStatic () const
 Returns the full path of the directory. More...
 
virtual const char * GetPath () const
 Returns the full path of the directory. More...
 
TUUID GetUUID () const
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual void pwd () const
 Print the path of the directory. More...
 
virtual TObjectRemove (TObject *)
 Remove an object from the in-memory list. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove object from a Directory. More...
 
virtual void SetMother (TObject *mother)
 
virtual void SetName (const char *newname)
 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. More...
 
template<class T >
Int_t WriteObject (const T *obj, const char *name, Option_t *option="", Int_t bufsize=0)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual ~TNamed ()
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void SetNameTitle (const char *name, const char *title)
 Change (i.e. set) all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Change (i.e. set) the title of the TNamed. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
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). More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
- Public Member Functions inherited from TXMLSetup
 TXMLSetup ()
 defaule constructor of TXMLSetup class More...
 
 TXMLSetup (const char *opt)
 contsruct TXMLSetup object getting values from string More...
 
 TXMLSetup (const TXMLSetup &src)
 copy sonstructor of TXMLSetup class More...
 
virtual ~TXMLSetup ()
 TXMLSetup class destructor. More...
 
TString GetSetupAsString ()
 return setup values as string More...
 
void PrintSetup ()
 show setup values More...
 
EXMLLayout GetXmlLayout () const
 
Bool_t IsStoreStreamerInfos () const
 
Bool_t IsUseDtd () const
 
Bool_t IsUseNamespaces () const
 
const char * XmlConvertClassName (const char *name)
 convert class name to exclude any special symbols like ':', '<' '>' ',' and spaces More...
 
const char * XmlClassNameSpaceRef (const TClass *cl)
 produce string which used as reference in class namespace definition More...
 
const char * XmlGetElementName (const TStreamerElement *el)
 return converted name for TStreamerElement More...
 
Int_t GetNextRefCounter ()
 

Protected Member Functions

void InitXmlFile (Bool_t create)
 initialize xml file and correspondent structures identical to TFile::Init() function More...
 
virtual Int_t SysOpen (const char *, Int_t, UInt_t)
 Interface to system open. All arguments like in POSIX open(). More...
 
virtual Int_t SysClose (Int_t)
 Interface to system close. All arguments like in POSIX close(). More...
 
virtual Int_t SysRead (Int_t, void *, Int_t)
 Interface to system read. All arguments like in POSIX read(). More...
 
virtual Int_t SysWrite (Int_t, const void *, Int_t)
 Interface to system write. All arguments like in POSIX write(). More...
 
virtual Long64_t SysSeek (Int_t, Long64_t, Int_t)
 Interface to system lseek. More...
 
virtual Int_t SysStat (Int_t, Long_t *, Long64_t *, Long_t *, Long_t *)
 Return file stat information. More...
 
virtual Int_t SysSync (Int_t)
 Interface to system fsync. All arguments like in POSIX fsync(). More...
 
virtual Long64_t DirCreateEntry (TDirectory *)
 Create key for directory entry in the key. More...
 
virtual Int_t DirReadKeys (TDirectory *)
 Read keys for directory Make sence only once, while next time no new subnodes will be created. More...
 
virtual void DirWriteKeys (TDirectory *)
 Update key attributes. More...
 
virtual void DirWriteHeader (TDirectory *)
 Write the directory header. More...
 
void StoreStreamerElement (XMLNodePointer_t node, TStreamerElement *elem)
 store data of single TStreamerElement in streamer node More...
 
void ReadStreamerElement (XMLNodePointer_t node, TStreamerInfo *info)
 read and reconstruct single TStreamerElement from xml node More...
 
Bool_t ReadFromFile ()
 read document from file Now full content of docuument reads into the memory Then document decomposed to separate keys and streamer info structures All inrelevant data will be cleaned More...
 
Int_t ReadKeysList (TDirectory *dir, XMLNodePointer_t topnode)
 Read list of keys for directory. More...
 
TKeyXMLFindDirKey (TDirectory *dir)
 Serach for key which correspond to direcory dir. More...
 
TDirectoryFindKeyDir (TDirectory *mother, Long64_t keyid)
 Find a directory in motherdir with a seek equal to keyid. More...
 
void CombineNodesTree (TDirectory *dir, XMLNodePointer_t topnode, Bool_t dolink)
 Connect/disconnect all file nodes to single tree before/after saving. More...
 
void SaveToFile ()
 Saves xml structures to file xml elements are kept in list of TKeyXML objects When saving, all this elements are linked to root xml node In the end StreamerInfo structures are added After xml document is saved, all nodes will be unlinked from root node and kept in memory. More...
 
- Protected Member Functions inherited from TFile
virtual EAsyncOpenStatus GetAsyncOpenStatus ()
 
virtual void Init (Bool_t create)
 Initialize a TFile object. More...
 
Bool_t FlushWriteCache ()
 Flush the write cache if active. More...
 
Int_t ReadBufferViaCache (char *buf, Int_t len)
 Read buffer via cache. More...
 
Int_t WriteBufferViaCache (const char *buf, Int_t len)
 Write buffer via cache. More...
 
Int_t MakeProjectParMake (const char *packname, const char *filename)
 Create makefile at 'filemake' for PAR package 'pack'. More...
 
Int_t MakeProjectParProofInf (const char *packname, const char *proofinfdir)
 Create BUILD.sh and SETUP.C under 'proofinf' for PAR package 'pack'. More...
 
- Protected Member Functions inherited from TDirectoryFile
virtual void CleanTargets ()
 Clean the pointers to this object (gDirectory, TContext, etc.) More...
 
void Init (TClass *cl=0)
 Initialize the key associated with this directory (and the related data members. More...
 
- Protected Member Functions inherited from TDirectory
Bool_t cd1 (const char *path)
 flag to add histograms, graphs,etc to the directory More...
 
void FillFullPath (TString &buf) const
 Recursive method to fill full path for directory. More...
 
void RegisterContext (TContext *ctxt)
 Register a TContext pointing to this TDirectory object. More...
 
void UnregisterContext (TContext *ctxt)
 UnRegister a TContext pointing to this TDirectory object. More...
 
 TDirectory (const TDirectory &directory)
 Copy constructor. More...
 
void operator= (const TDirectory &)
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
- Protected Member Functions inherited from TXMLSetup
TClassXmlDefineClass (const char *xmlClassName)
 define class for the converted class name, where special symbols were replaced by '_' More...
 
const char * GetElItemName (TStreamerElement *el)
 get item name for given element More...
 
Bool_t IsValidXmlSetup (const char *setupstr)
 checks if string is valid setup More...
 
Bool_t ReadSetupFromStr (const char *setupstr)
 get values from string More...
 
Int_t AtoI (const char *sbuf, Int_t def=0, const char *errinfo=0)
 converts string to integer. More...
 

Static Protected Member Functions

static void ProduceFileNames (const char *filename, TString &fname, TString &dtdname)
 function produces pair of xml and dtd file names More...
 
- Static Protected Member Functions inherited from TDirectory
static Bool_t Cd1 (const char *path)
 Change current directory to "path". More...
 

Protected Attributes

XMLDocPointer_t fDoc
 
XMLNodePointer_t fStreamerInfoNode
 
TXMLEnginefXML
 pointer of node with streamer info data More...
 
Int_t fIOVersion
 object for interface with xml library More...
 
Long64_t fKeyCounter
 indicates format of ROOT xml file More...
 
- Protected Attributes inherited from TFile
Double_t fSumBuffer
 Sum of buffer sizes of objects written so far. More...
 
Double_t fSum2Buffer
 Sum of squares of buffer sizes of objects written so far. More...
 
Long64_t fBytesWrite
 Number of bytes written to this file. More...
 
Long64_t fBytesRead
 Number of bytes read from this file. More...
 
Long64_t fBytesReadExtra
 Number of extra bytes (overhead) read by the readahead buffer. More...
 
Long64_t fBEGIN
 First used byte in file. More...
 
Long64_t fEND
 Last used byte in file. More...
 
Long64_t fSeekFree
 Location on disk of free segments structure. More...
 
Long64_t fSeekInfo
 Location on disk of StreamerInfo record. More...
 
Int_t fD
 File descriptor. More...
 
Int_t fVersion
 File format version. More...
 
Int_t fCompress
 Compression level and algorithm. More...
 
Int_t fNbytesFree
 Number of bytes for free segments structure. More...
 
Int_t fNbytesInfo
 Number of bytes for StreamerInfo record. More...
 
Int_t fWritten
 Number of objects written so far. More...
 
Int_t fNProcessIDs
 Number of TProcessID written to this file. More...
 
Int_t fReadCalls
 Number of read calls ( not counting the cache calls ) More...
 
TString fRealName
 Effective real file name (not original url) More...
 
TString fOption
 File options. More...
 
Char_t fUnits
 Number of bytes for file pointers. More...
 
TListfFree
 Free segments linked list table. More...
 
TArrayCfClassIndex
 !Index of TStreamerInfo classes written to this file More...
 
TObjArrayfProcessIDs
 !Array of pointers to TProcessIDs More...
 
Long64_t fOffset
 !Seek offset cache More...
 
TArchiveFilefArchive
 !Archive file from which we read this file More...
 
TFileCacheReadfCacheRead
 !Pointer to the read cache (if any) More...
 
TMapfCacheReadMap
 !Pointer to the read cache (if any) More...
 
TFileCacheWritefCacheWrite
 !Pointer to the write cache (if any) More...
 
Long64_t fArchiveOffset
 !Offset at which file starts in archive More...
 
Bool_t fIsArchive: 1
 !True if this is a pure archive file More...
 
Bool_t fNoAnchorInName: 1
 !True if we don't want to force the anchor to be appended to the file name More...
 
Bool_t fIsRootFile: 1
 !True is this is a ROOT file, raw file otherwise More...
 
Bool_t fInitDone: 1
 !True if the file has been initialized More...
 
Bool_t fMustFlush: 1
 !True if the file buffers must be flushed More...
 
Bool_t fIsPcmFile: 1
 !True if the file is a ROOT pcm file. More...
 
TFileOpenHandlefAsyncHandle
 !For proper automatic cleanup More...
 
EAsyncOpenStatus fAsyncOpenStatus
 !Status of an asynchronous open request More...
 
TUrl fUrl
 !URL of file More...
 
TListfInfoCache
 !Cached list of the streamer infos in this file More...
 
TListfOpenPhases
 !Time info about open phases More...
 
- Protected Attributes inherited from TDirectoryFile
Bool_t fModified
 True if directory has been modified. More...
 
Bool_t fWritable
 True if directory is writable. More...
 
TDatime fDatimeC
 Date and time when directory is created. More...
 
TDatime fDatimeM
 Date and time of last modification. More...
 
Int_t fNbytesKeys
 Number of bytes for the keys. More...
 
Int_t fNbytesName
 Number of bytes in TNamed at creation time. More...
 
Int_t fBufferSize
 Default buffer size to create new TKeys. More...
 
Long64_t fSeekDir
 Location of directory on file. More...
 
Long64_t fSeekParent
 Location of parent directory on file. More...
 
Long64_t fSeekKeys
 Location of Keys record on file. More...
 
TFilefFile
 Pointer to current file in memory. More...
 
TListfKeys
 Pointer to keys list in memory. More...
 
- Protected Attributes inherited from TDirectory
TObjectfMother
 
TListfList
 
TUUID fUUID
 
TString fPathBuffer
 
TContextfContext
 Buffer for GetPath() function. More...
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 
- Protected Attributes inherited from TXMLSetup
EXMLLayout fXmlLayout
 
Bool_t fStoreStreamerInfos
 
Bool_t fUseDtd
 
Bool_t fUseNamespaces
 
Int_t fRefCounter
 
TString fStrBuf
 counter , used to build id of xml references More...
 

Private Member Functions

void operator= (const TXMLFile &)
 make private to exclude copy operator More...
 

Additional Inherited Members

- Public Types inherited from TFile
enum  EAsyncOpenStatus { kAOSNotAsync = -1, kAOSFailure = 0, kAOSInProgress = 1, kAOSSuccess = 2 }
 Asynchronous open request status. More...
 
enum  EOpenTimeOut { kInstantTimeout = 0, kEternalTimeout = 999999999 }
 Open timeout constants. More...
 
enum  ECacheAction { kDisconnect = 0, kDoNotDisconnect = 1 }
 TTreeCache flushing semantics. More...
 
enum  EStatusBits {
  kRecovered = BIT(10), kHasReferences = BIT(11), kDevNull = BIT(12), kWriteError = BIT(14),
  kBinaryFile = BIT(15), kRedirected = BIT(16)
}
 TFile status bits. BIT(13) is taken up by TObject. More...
 
enum  ERelativeTo { kBeg = 0, kCur = 1, kEnd = 2 }
 
enum  { kStartBigFile = 2000000000 }
 
enum  EFileType {
  kDefault = 0, kLocal = 1, kNet = 2, kWeb = 3,
  kFile = 4, kMerge = 5
}
 File type. More...
 
- Public Types inherited from TDirectoryFile
enum  { kCloseDirectory = BIT(7) }
 
- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Public Types inherited from TXMLSetup
enum  EXMLLayout { kSpecialized = 2, kGeneralized = 3 }
 
- Static Public Member Functions inherited from TFile
static TFile *& CurrentFile ()
 Return the current ROOT file if any. More...
 
static TFileOpenHandleAsyncOpen (const char *name, Option_t *option="", const char *ftitle="", Int_t compress=1, Int_t netopt=0)
 Submit an asynchronous open request. More...
 
static TFileOpen (const char *name, Option_t *option="", const char *ftitle="", Int_t compress=1, Int_t netopt=0)
 Create / open a file. More...
 
static TFileOpen (TFileOpenHandle *handle)
 Waits for the completion of an asynchronous open request. More...
 
static EFileType GetType (const char *name, Option_t *option="", TString *prefix=0)
 Resolve the file type as a function of the protocol field in 'name'. More...
 
static EAsyncOpenStatus GetAsyncOpenStatus (const char *name)
 Get status of the async open request related to 'name'. More...
 
static EAsyncOpenStatus GetAsyncOpenStatus (TFileOpenHandle *handle)
 Get status of the async open request related to 'handle'. More...
 
static const TUrlGetEndpointUrl (const char *name)
 Get final URL for file being opened asynchronously. More...
 
static Long64_t GetFileBytesRead ()
 Static function returning the total number of bytes read from all files. More...
 
static Long64_t GetFileBytesWritten ()
 Static function returning the total number of bytes written to all files. More...
 
static Int_t GetFileReadCalls ()
 Static function returning the total number of read calls from all files. More...
 
static Int_t GetReadaheadSize ()
 Static function returning the readahead buffer size. More...
 
static void SetFileBytesRead (Long64_t bytes=0)
 
static void SetFileBytesWritten (Long64_t bytes=0)
 
static void SetFileReadCalls (Int_t readcalls=0)
 
static void SetReadaheadSize (Int_t bufsize=256000)
 
static void SetReadStreamerInfo (Bool_t readinfo=kTRUE)
 Specify if the streamerinfos must be read at file opening. More...
 
static Bool_t GetReadStreamerInfo ()
 If the streamerinfos are to be read at file opening. More...
 
static Long64_t GetFileCounter ()
 
static void IncrementFileCounter ()
 
static Bool_t SetCacheFileDir (const char *cacheDir, Bool_t operateDisconnected=kTRUE, Bool_t forceCacheread=kFALSE)
 Sets the directory where to locally stage/cache remote files. More...
 
static const char * GetCacheFileDir ()
 Get the directory where to locally stage/cache remote files. More...
 
static Bool_t ShrinkCacheFileDir (Long64_t shrinkSize, Long_t cleanupInteval=0)
 Try to shrink the cache to the desired size. More...
 
static Bool_t Cp (const char *src, const char *dst, Bool_t progressbar=kTRUE, UInt_t buffersize=1000000)
 Allows to copy file from src to dst URL. More...
 
static UInt_t SetOpenTimeout (UInt_t timeout)
 Sets open timeout time (in ms). Returns previous timeout value. More...
 
static UInt_t GetOpenTimeout ()
 Returns open timeout (in ms). More...
 
static Bool_t SetOnlyStaged (Bool_t onlystaged)
 Sets only staged flag. More...
 
static Bool_t GetOnlyStaged ()
 Returns staged only flag. More...
 
- Static Public Member Functions inherited from TDirectory
static void AddDirectory (Bool_t add=kTRUE)
 Sets the flag controlling the automatic add objects like histograms, TGraph2D, etc in memory. More...
 
static Bool_t AddDirectoryStatus ()
 Static function: see TDirectory::AddDirectory for more comments. More...
 
static TDirectory *& CurrentDirectory ()
 Return the current directory for the current thread. More...
 
static Bool_t Cd (const char *path)
 Change current directory to "path". More...
 
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". More...
 
static void EncodeNameCycle (char *buffer, const char *name, Short_t cycle)
 Encode the name and cycle into buffer like: "aap;2". More...
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Static Public Member Functions inherited from TXMLSetup
static TString DefaultXmlSetup ()
 return default value for XML setup More...
 
static void SetNameSpaceBase (const char *namespacebase)
 set namespace base More...
 
- Static Protected Attributes inherited from TFile
static TListfgAsyncOpenRequests = 0
 
static TString fgCacheFileDir
 Directory where to locally stage files. More...
 
static Bool_t fgCacheFileDisconnected = kTRUE
 Indicates, we trust in the files in the cache dir without stat on the cached file. More...
 
static Bool_t fgCacheFileForce = kFALSE
 Indicates, to force all READ to CACHEREAD. More...
 
static UInt_t fgOpenTimeout = TFile::kEternalTimeout
 Timeout for open operations in ms - 0 corresponds to blocking i/o. More...
 
static Bool_t fgOnlyStaged = 0
 Before the file is opened, it is checked, that the file is staged, if not, the open fails. More...
 
static std::atomic< Long64_tfgBytesWrite {0}
 Number of bytes written by all TFile objects. More...
 
static std::atomic< Long64_tfgBytesRead
 Number of bytes read by all TFile objects. More...
 
static std::atomic< Long64_tfgFileCounter {0}
 Counter for all opened files. More...
 
static std::atomic< Int_tfgReadCalls {0}
 Number of bytes read from all TFile objects. More...
 
static Int_t fgReadaheadSize = 256000
 Readahead buffer size. More...
 
static Bool_t fgReadInfo = kTRUE
 if true (default) ReadStreamerInfo is called when opening a file More...
 
- Static Protected Attributes inherited from TDirectory
static Bool_t fgAddDirectory = kTRUE
 Pointer to a list of TContext object pointing to this TDirectory. More...
 
- Static Protected Attributes inherited from TXMLSetup
static TString fgNameSpaceBase = "http://root.cern.ch/root/htmldoc/"
 buffer, used in XmlDefineClass() function More...
 

#include <TXMLFile.h>

+ Inheritance diagram for TXMLFile:
+ Collaboration diagram for TXMLFile:

Constructor & Destructor Documentation

TXMLFile::TXMLFile ( )

default TXMLFile constructor

Definition at line 96 of file TXMLFile.cxx.

TXMLFile::TXMLFile ( const char *  filename,
Option_t option = "read",
const char *  title = "title",
Int_t  compression = 1 
)

Open or creates local XML file with name filename.

It is recommended to specify filename as "<file>.xml". The suffix ".xml" will be used by object browsers to automatically identify the file as a XML file. If the constructor fails in any way IsZombie() will return true. Use IsOpen() to check if the file is (still) open.

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. = 2xoo create a new file with specified xml settings for more details see TXMLSetup class = UPDATE open an existing file for writing. if no file exists, it is created. = READ open an existing file for reading.

For more details see comments for TFile::TFile() constructor

For a moment TXMLFile does not support TTree objects and subdirectories

Definition at line 131 of file TXMLFile.cxx.

TXMLFile::~TXMLFile ( )
virtual

destructor of TXMLFile object

Definition at line 371 of file TXMLFile.cxx.

Member Function Documentation

Bool_t TXMLFile::AddXmlComment ( const char *  comment)

Add comment line on the top of the xml document This line can only be seen in xml editor and cannot be accessed later with TXMLFile methods.

Definition at line 979 of file TXMLFile.cxx.

Bool_t TXMLFile::AddXmlLine ( const char *  line)

Add just one line on the top of xml document For instance, line can contain special xml processing instructions Line should has correct xml syntax that later it can be decoded by xml parser To be parsed later by TXMLFile again, this line should contain either xml comments or xml processing instruction.

Definition at line 1016 of file TXMLFile.cxx.

Bool_t TXMLFile::AddXmlStyleSheet ( const char *  href,
const char *  type = "text/css",
const char *  title = 0,
int  alternate = -1,
const char *  media = 0,
const char *  charset = 0 
)

Adds style sheet definition on the top of xml document Creates <?xml-stylesheet alternate="yes" title="compact" href="small-base.css" type="text/css"?> Attributes href and type must be supplied, other attributes: title, alternate, media, charset are optional if alternate==0, attribyte alternate="no" will be created, if alternate>0, attribute alternate="yes" if alternate<0, attribute will not be created This style sheet definition cannot be later access with TXMLFile methods.

Definition at line 997 of file TXMLFile.cxx.

void TXMLFile::Close ( Option_t option = "")
virtual

Close a XML file For more comments see TFile::Close() function.

Reimplemented from TFile.

Definition at line 318 of file TXMLFile.cxx.

Referenced by ~TXMLFile().

void TXMLFile::CombineNodesTree ( TDirectory dir,
XMLNodePointer_t  topnode,
Bool_t  dolink 
)
protected

Connect/disconnect all file nodes to single tree before/after saving.

Definition at line 553 of file TXMLFile.cxx.

Referenced by SaveToFile().

TKey * TXMLFile::CreateKey ( TDirectory mother,
const TObject obj,
const char *  name,
Int_t  bufsize 
)
virtual

create XML key, which will store object in xml structures

Reimplemented from TFile.

Definition at line 436 of file TXMLFile.cxx.

TKey * TXMLFile::CreateKey ( TDirectory mother,
const void obj,
const TClass cl,
const char *  name,
Int_t  bufsize 
)
virtual

create XML key, which will store object in xml structures

Reimplemented from TFile.

Definition at line 444 of file TXMLFile.cxx.

Long64_t TXMLFile::DirCreateEntry ( TDirectory dir)
protectedvirtual

Create key for directory entry in the key.

Reimplemented from TFile.

Definition at line 1026 of file TXMLFile.cxx.

Int_t TXMLFile::DirReadKeys ( TDirectory dir)
protectedvirtual

Read keys for directory Make sence only once, while next time no new subnodes will be created.

Reimplemented from TFile.

Definition at line 1084 of file TXMLFile.cxx.

void TXMLFile::DirWriteHeader ( TDirectory dir)
protectedvirtual

Write the directory header.

Reimplemented from TFile.

Definition at line 1109 of file TXMLFile.cxx.

void TXMLFile::DirWriteKeys ( TDirectory )
protectedvirtual

Update key attributes.

Reimplemented from TFile.

Definition at line 1095 of file TXMLFile.cxx.

virtual void TXMLFile::DrawMap ( const char *  keys = "*",
Option_t option = "" 
)
inlinevirtual

Draw map of objects in this file.

Reimplemented from TFile.

Definition at line 65 of file TXMLFile.h.

virtual void TXMLFile::FillBuffer ( char *&  buffer)
inlinevirtual

Encode file output buffer.

The file output buffer contains only the FREE data record.

Reimplemented from TFile.

Definition at line 66 of file TXMLFile.h.

TKeyXML * TXMLFile::FindDirKey ( TDirectory dir)
protected

Serach for key which correspond to direcory dir.

Definition at line 1041 of file TXMLFile.cxx.

Referenced by DirReadKeys(), and DirWriteHeader().

TDirectory * TXMLFile::FindKeyDir ( TDirectory mother,
Long64_t  keyid 
)
protected

Find a directory in motherdir with a seek equal to keyid.

Definition at line 1063 of file TXMLFile.cxx.

Referenced by CombineNodesTree().

virtual void TXMLFile::Flush ( )
inlinevirtual

Synchronize a file's in-memory and on-disk states.

Reimplemented from TFile.

Definition at line 67 of file TXMLFile.h.

virtual Long64_t TXMLFile::GetEND ( ) const
inlinevirtual

Reimplemented from TFile.

Definition at line 69 of file TXMLFile.h.

virtual Int_t TXMLFile::GetErrno ( ) const
inlinevirtual

Method returning errno. Is overriden in TRFIOFile.

Reimplemented from TFile.

Definition at line 70 of file TXMLFile.h.

Int_t TXMLFile::GetIOVersion ( ) const
inline
virtual Int_t TXMLFile::GetNbytesFree ( ) const
inlinevirtual

Reimplemented from TFile.

Definition at line 75 of file TXMLFile.h.

virtual Int_t TXMLFile::GetNbytesInfo ( ) const
inlinevirtual

Reimplemented from TFile.

Definition at line 74 of file TXMLFile.h.

virtual Int_t TXMLFile::GetNfree ( ) const
inlinevirtual

Reimplemented from TFile.

Definition at line 73 of file TXMLFile.h.

virtual Long64_t TXMLFile::GetSeekFree ( ) const
inlinevirtual

Reimplemented from TFile.

Definition at line 76 of file TXMLFile.h.

virtual Long64_t TXMLFile::GetSeekInfo ( ) const
inlinevirtual

Reimplemented from TFile.

Definition at line 77 of file TXMLFile.h.

virtual Long64_t TXMLFile::GetSize ( ) const
inlinevirtual

Returns the current file size.

Returns -1 in case the file could not be stat'ed.

Reimplemented from TFile.

Definition at line 78 of file TXMLFile.h.

Referenced by SetStoreStreamerInfos(), SetUsedDtd(), SetUseNamespaces(), and SetXmlLayout().

TList * TXMLFile::GetStreamerInfoList ( )
virtual

Read streamerinfo structures from xml format and provide them in the list It is user responsibility to destroy this list.

Reimplemented from TFile.

Definition at line 728 of file TXMLFile.cxx.

void TXMLFile::InitXmlFile ( Bool_t  create)
protected

initialize xml file and correspondent structures identical to TFile::Init() function

Definition at line 283 of file TXMLFile.cxx.

Referenced by TXMLFile().

Bool_t TXMLFile::IsOpen ( ) const
virtual

return kTRUE if file is opened and can be accessed

Reimplemented from TFile.

Definition at line 391 of file TXMLFile.cxx.

Referenced by Close(), and ReOpen().

virtual void TXMLFile::MakeFree ( Long64_t  first,
Long64_t  last 
)
inlinevirtual

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

Reimplemented from TFile.

Definition at line 84 of file TXMLFile.h.

virtual void TXMLFile::MakeProject ( const char *  dirname,
const char *  classes = "*",
Option_t option = "new" 
)
inlinevirtual

Generate source code necessary to access the objects stored in the file.

Generate code in directory dirname for all classes specified in argument classes If classes = "*" (default and currently the only supported value), the function generates an include file for each class in the StreamerInfo list for which a TClass object does not exist.

The code generated includes:

  • dirnameProjectHeaders.h, which contains one #include statement per generated header file
  • dirnameProjectSource.cxx,which contains all the constructors and destructors implementation. and one header per class that is not nested inside another class. The header file name is the fully qualified name of the class after all the special characters "<>,:" are replaced by underscored. For example for std::pair<edm::Vertex,int> the file name is pair_edm__Vertex_int_.h

In the generated classes, map, multimap when the first template parameter is a class are replaced by a vector of pair. set and multiset when the tempalte parameter is a class are replaced by a vector. This is required since we do not have the code needed to order and/or compare the object of the classes. This is a quick explanation of the options available:

Option Details
new (default) A new directory dirname is created. If dirname already exist, an error message is printed and the function returns.
recreate 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.
update 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".
genreflex Use genreflex rather than rootcint to generate the dictionary.
par Create a PAR file with the minimal set of code needed to read the content of the ROOT file. The name of the PAR file is basename(dirname), with extension '.par' enforced; the PAR file will be created at dirname(dirname).

If, in addition to one of the 3 above options, the option "+" is specified, the function will generate:

  • a script called MAKEP to build the shared lib
  • a dirnameLinkDef.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 dirname.so will be created. If the option "++" is specified, the generated shared lib is dynamically linked with the current executable module. If the option "+" and "nocompile" are specified, the utility files are generated as in the option "+" but they are not executed. Example: file.MakeProject("demo","*","recreate++");
  • 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 MAKEP
  • creates a LinkDef.h file
  • runs rootcint generating demoProjectDict.cxx
  • compiles demoProjectDict.cxx into demoProjectDict.o
  • generates a shared lib demo.so
  • dynamically links the shared lib demo.so to the executable If only the option "+" had been specified, one can still link the shared lib to the current executable module with:
    gSystem->load("demo/demo.so");
    

The following feature is not yet enabled: 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.

Reimplemented from TFile.

Definition at line 85 of file TXMLFile.h.

virtual void TXMLFile::Map ( )
inlinevirtual

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  

Reimplemented from TFile.

Definition at line 86 of file TXMLFile.h.

void TXMLFile::operator= ( const TXMLFile )
private

make private to exclude copy operator

Definition at line 384 of file TXMLFile.cxx.

virtual void TXMLFile::Paint ( Option_t option = "")
inlinevirtual

Paint all objects in the file.

Reimplemented from TFile.

Definition at line 87 of file TXMLFile.h.

virtual void TXMLFile::Print ( Option_t option = "") const
inlinevirtual

Print all objects in the file.

Reimplemented from TFile.

Definition at line 88 of file TXMLFile.h.

void TXMLFile::ProduceFileNames ( const char *  filename,
TString fname,
TString dtdname 
)
staticprotected

function produces pair of xml and dtd file names

Definition at line 452 of file TXMLFile.cxx.

Referenced by SaveToFile().

virtual Bool_t TXMLFile::ReadBuffer ( char *  buf,
Int_t  len 
)
inlinevirtual

Read a buffer from the file.

This is the basic low level read operation. Returns kTRUE in case of failure.

Reimplemented from TFile.

Definition at line 89 of file TXMLFile.h.

virtual Bool_t TXMLFile::ReadBuffer ( char *  buf,
Long64_t  pos,
Int_t  len 
)
inlinevirtual

Read a buffer from the file at the offset 'pos' in the file.

Returns kTRUE in case of failure. Compared to ReadBuffer(char*, Int_t), this routine does not change the cursor on the physical file representation (fD) if the data is in this TFile's cache.

Reimplemented from TFile.

Definition at line 90 of file TXMLFile.h.

virtual void TXMLFile::ReadFree ( )
inlinevirtual

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.

Reimplemented from TFile.

Definition at line 91 of file TXMLFile.h.

Bool_t TXMLFile::ReadFromFile ( )
protected

read document from file Now full content of docuument reads into the memory Then document decomposed to separate keys and streamer info structures All inrelevant data will be cleaned

Definition at line 577 of file TXMLFile.cxx.

Referenced by InitXmlFile().

Int_t TXMLFile::ReadKeysList ( TDirectory dir,
XMLNodePointer_t  topnode 
)
protected

Read list of keys for directory.

Definition at line 646 of file TXMLFile.cxx.

Referenced by DirReadKeys(), and ReadFromFile().

void TXMLFile::ReadStreamerElement ( XMLNodePointer_t  node,
TStreamerInfo info 
)
protected

read and reconstruct single TStreamerElement from xml node

Definition at line 836 of file TXMLFile.cxx.

Referenced by GetStreamerInfoList().

virtual Int_t TXMLFile::Recover ( )
inlinevirtual

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()) {<actions to take if 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. One can disable the automatic recovery procedure by setting

TFile.Recover 0

in the system.rootrc file.

Reimplemented from TFile.

Definition at line 92 of file TXMLFile.h.

Int_t TXMLFile::ReOpen ( Option_t mode)
virtual

Reopen a file with a different access mode, like from READ to See TFile::Open() for details.

Reimplemented from TFile.

Definition at line 400 of file TXMLFile.cxx.

virtual void TXMLFile::ResetErrno ( ) const
inlinevirtual

Method resetting the errno. Is overridden in TRFIOFile.

Reimplemented from TFile.

Definition at line 71 of file TXMLFile.h.

void TXMLFile::SaveToFile ( )
protected

Saves xml structures to file xml elements are kept in list of TKeyXML objects When saving, all this elements are linked to root xml node In the end StreamerInfo structures are added After xml document is saved, all nodes will be unlinked from root node and kept in memory.

Only Close() or destructor relase memory, used by xml structures

Definition at line 482 of file TXMLFile.cxx.

Referenced by Close(), and ReOpen().

virtual void TXMLFile::Seek ( Long64_t  offset,
ERelativeTo  pos = kBeg 
)
inlinevirtual

Seek to a specific position in the file. Pos it either kBeg, kCur or kEnd.

Reimplemented from TFile.

Definition at line 94 of file TXMLFile.h.

virtual void TXMLFile::SetEND ( Long64_t  )
inlinevirtual

Reimplemented from TFile.

Definition at line 96 of file TXMLFile.h.

void TXMLFile::SetStoreStreamerInfos ( Bool_t  iConvert = kTRUE)
virtual

If true, all correspondent to file TStreamerInfo objects will be stored in file this allows to apply schema avolution later for this file may be usefull, when file used outside ROOT and TStreamerInfo objects does not required Can be changed only for newly created file.

Reimplemented from TXMLSetup.

Definition at line 937 of file TXMLFile.cxx.

void TXMLFile::SetUsedDtd ( Bool_t  use = kTRUE)
virtual

Specify usage of DTD for this file.

Currently this option not available (always false). Can be changed only for newly created file.

Reimplemented from TXMLSetup.

Definition at line 948 of file TXMLFile.cxx.

void TXMLFile::SetUseNamespaces ( Bool_t  iUseNamespaces = kTRUE)
virtual

Specifiy usage of namespaces in xml file In current implementation every instrumented class in file gets its unique namespace, which is equal to name of class and refer to root documentation page like <TAttPad xmlns:TAttPad="http://root.cern.ch/root/htmldoc/TAttPad.html" version="3"> And xml node for class member gets its name as combination of class name and member name <TAttPad:fLeftMargin v="0.100000"/> <TAttPad:fRightMargin v="0.100000"/> <TAttPad:fBottomMargin v="0.100000"/> and so on Usage of namespace increase size of xml file, but makes file more readable and allows to produce DTD in the case, when in several classes data member has same name Can be changed only for newly created file.

Reimplemented from TXMLSetup.

Definition at line 968 of file TXMLFile.cxx.

void TXMLFile::SetXmlLayout ( EXMLLayout  layout)
virtual

Change layout of objects in xml file Can be changed only for newly created file.

Currently there are two supported layouts:

TXMLSetup::kSpecialized = 2 This is default layout of the file, when xml nodes names class names and data member names are used. For instance: <TAttLine version="1"> <fLineColor v="1"> <fLineStyle v="1"> <fLineWidth v="1"> </TAttLine>

TXMLSetup::kGeneralized = 3 For this layout all nodes name does not depend from class definitions. The same class looks like <Class name="TAttLine" version="1"> <Member name="fLineColor" v="1"> <Member name="fLineStyle" v="1"> <Member name="fLineWidth" v="1"> </Member>

Reimplemented from TXMLSetup.

Definition at line 925 of file TXMLFile.cxx.

virtual Int_t TXMLFile::Sizeof ( ) const
inlinevirtual

Return the size in bytes of the file header.

Reimplemented from TFile.

Definition at line 97 of file TXMLFile.h.

void TXMLFile::StoreStreamerElement ( XMLNodePointer_t  node,
TStreamerElement elem 
)
protected

store data of single TStreamerElement in streamer node

Definition at line 777 of file TXMLFile.cxx.

Referenced by WriteStreamerInfo().

virtual Int_t TXMLFile::SysClose ( Int_t  fd)
inlineprotectedvirtual

Interface to system close. All arguments like in POSIX close().

Reimplemented from TFile.

Definition at line 39 of file TXMLFile.h.

virtual Int_t TXMLFile::SysOpen ( const char *  pathname,
Int_t  flags,
UInt_t  mode 
)
inlineprotectedvirtual

Interface to system open. All arguments like in POSIX open().

Reimplemented from TFile.

Definition at line 38 of file TXMLFile.h.

virtual Int_t TXMLFile::SysRead ( Int_t  fd,
void buf,
Int_t  len 
)
inlineprotectedvirtual

Interface to system read. All arguments like in POSIX read().

Reimplemented from TFile.

Definition at line 40 of file TXMLFile.h.

virtual Long64_t TXMLFile::SysSeek ( Int_t  fd,
Long64_t  offset,
Int_t  whence 
)
inlineprotectedvirtual

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.

Reimplemented from TFile.

Definition at line 42 of file TXMLFile.h.

virtual Int_t TXMLFile::SysStat ( Int_t  fd,
Long_t id,
Long64_t size,
Long_t flags,
Long_t modtime 
)
inlineprotectedvirtual

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.

Reimplemented from TFile.

Definition at line 43 of file TXMLFile.h.

virtual Int_t TXMLFile::SysSync ( Int_t  fd)
inlineprotectedvirtual

Interface to system fsync. All arguments like in POSIX fsync().

Reimplemented from TFile.

Definition at line 44 of file TXMLFile.h.

virtual Int_t TXMLFile::SysWrite ( Int_t  fd,
const void buf,
Int_t  len 
)
inlineprotectedvirtual

Interface to system write. All arguments like in POSIX write().

Reimplemented from TFile.

Definition at line 41 of file TXMLFile.h.

virtual Int_t TXMLFile::Write ( const char *  name = 0,
Int_t  opt = 0,
Int_t  bufsiz = 0 
)
inlinevirtual

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

Reimplemented from TFile.

Definition at line 100 of file TXMLFile.h.

virtual Int_t TXMLFile::Write ( const char *  name = 0,
Int_t  opt = 0,
Int_t  bufsiz = 0 
) const
inlinevirtual

One can not save a const TDirectory object.

Reimplemented from TFile.

Definition at line 101 of file TXMLFile.h.

virtual Bool_t TXMLFile::WriteBuffer ( const char *  buf,
Int_t  len 
)
inlinevirtual

Write a buffer to the file.

This is the basic low level write operation. Returns kTRUE in case of failure.

Reimplemented from TFile.

Definition at line 99 of file TXMLFile.h.

virtual void TXMLFile::WriteFree ( )
inlinevirtual

Write FREE linked list on the file.

The linked list of FREE segments (fFree) is written as a single data record.

Reimplemented from TFile.

Definition at line 102 of file TXMLFile.h.

virtual void TXMLFile::WriteHeader ( )
inlinevirtual

Write File Header.

Reimplemented from TFile.

Definition at line 103 of file TXMLFile.h.

void TXMLFile::WriteStreamerInfo ( )
virtual

convert all TStreamerInfo, used in file, to xml format

Reimplemented from TFile.

Definition at line 679 of file TXMLFile.cxx.

Referenced by SaveToFile().

TXMLEngine* TXMLFile::XML ( )
inline

Definition at line 122 of file TXMLFile.h.

Referenced by TKeyXML::XMLEngine().

Member Data Documentation

XMLDocPointer_t TXMLFile::fDoc
protected
Int_t TXMLFile::fIOVersion
protected

object for interface with xml library

Definition at line 146 of file TXMLFile.h.

Referenced by GetIOVersion(), ReadFromFile(), and TXMLFile().

Long64_t TXMLFile::fKeyCounter
protected

indicates format of ROOT xml file

Definition at line 148 of file TXMLFile.h.

Referenced by CreateKey(), DirCreateEntry(), and ReadKeysList().

XMLNodePointer_t TXMLFile::fStreamerInfoNode
protected

Definition at line 142 of file TXMLFile.h.

Referenced by Close(), GetStreamerInfoList(), ReadFromFile(), SaveToFile(), and WriteStreamerInfo().

TXMLEngine* TXMLFile::fXML
protected

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