Logo ROOT  
Reference Guide
Loading...
Searching...
No Matches
TXMLFile Class Referencefinal

Definition at line 25 of file TXMLFile.h.

Public Types

enum  { kSingleKey = (1ULL << (0)) , kOverwrite = (1ULL << (1)) , kWriteDelete = (1ULL << (2)) }
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
enum  { kStartBigFile = 2000000000 }
enum  EAsyncOpenStatus { kAOSNotAsync = -1 , kAOSFailure = 0 , kAOSInProgress = 1 , kAOSSuccess = 2 }
 Asynchronous open request status. More...
enum  ECacheAction { kDisconnect = 0 , kDoNotDisconnect = 1 }
 TTreeCache flushing semantics. More...
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << (3)) }
enum  EFileType {
  kDefault = 0 , kLocal = 1 , kNet = 2 , kWeb = 3 ,
  kFile = 4 , kMerge = 5
}
 File type. More...
enum  EOpenTimeOut { kInstantTimeout = 0 , kEternalTimeout = 999999999 }
 Open timeout constants. More...
enum  ERelativeTo { kBeg = 0 , kCur = 1 , kEnd = 2 }
enum  EStatusBits {
  k630forwardCompatibility = (1ULL << (2)) , kRecovered = (1ULL << (10)) , kHasReferences = (1ULL << (11)) , kDevNull = (1ULL << (12)) ,
  kWriteError = (1ULL << (14)) , kBinaryFile = (1ULL << (15)) , kRedirected = (1ULL << (16)) , kReproducible = (1ULL << (17)) ,
  kCancelTTreeChangeRequest = (1ULL << (18))
}
 TFile status bits. BIT(13) is taken up by TObject. More...
enum  EXMLLayout { kSpecialized = 2 , kGeneralized = 3 }

Public Member Functions

 TXMLFile ()
 TXMLFile (const char *filename, Option_t *option="read", const char *title="title", Int_t compression=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault)
 Open or creates local XML file with name filename.
 ~TXMLFile () override
 destructor of TXMLFile object
void AbstractMethod (const char *method) const
 Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.
void Add (TObject *obj, Bool_t replace=kFALSE) override
 Append object to this directory.
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.
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.
Bool_t AddXmlStyleSheet (const char *href, const char *type="text/css", const char *title=nullptr, int alternate=-1, const char *media=nullptr, const char *charset=nullptr)
 Adds style sheet definition on the top of xml document Creates <?xml-stylesheet alternate="yes" title="compact" href="small-base.css" type="text/css"?
void Append (TObject *obj, Bool_t replace=kFALSE) override
 Append object to this directory.
Int_t AppendKey (TKey *key) override
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
void Browse (TBrowser *b) override
 Browse the content of the directory.
void Build (TFile *motherFile=nullptr, TDirectory *motherDir=nullptr) override
Bool_t cd () override
 Change current directory to "this" directory.
Bool_t cd (const char *path) override
 Change current directory to "this" directory or to the directory described by the path if given one.
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
void Clear (Option_t *option="") override
 Delete all objects from a Directory list.
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
TObjectCloneObject (const TObject *obj, Bool_t autoadd=kTRUE) override
 Clone an object.
void Close (Option_t *option="") final
 Close a XML file For more comments see TFile::Close() function.
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
void Copy (TObject &) const override
 Copy this to obj.
virtual Bool_t Cp (const char *dst, Bool_t progressbar=kTRUE, UInt_t bufsize=1000000)
TKeyCreateKey (TDirectory *mother, const TObject *obj, const char *name, Int_t bufsize) final
 create XML key, which will store object in xml structures
TKeyCreateKey (TDirectory *mother, const void *obj, const TClass *cl, const char *name, Int_t bufsize) final
 create XML key, which will store object in xml structures
void Delete (const char *namecycle="") override
 Delete Objects or/and keys in a directory.
virtual void DeleteAll (Option_t *option="")
 Delete all objects from memory.
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
void Draw (Option_t *option="") override
 Fill Graphics Structure and Paint.
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs.
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
void DrawMap (const char *="*", Option_t *="") final
virtual void Dump () const
 Dump contents of object on stdout.
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
void FillBuffer (char *&) final
 Encode TNamed into output buffer.
TKeyFindKey (const char *keyname) const override
TKeyFindKeyAny (const char *keyname) const override
TObjectFindObject (const char *name) const override
 Find object by name in the list of memory objects.
TObjectFindObject (const TObject *obj) const override
 Find object in the list of memory objects.
TObjectFindObjectAny (const char *name) const override
 Find object by name in the list of memory objects of the current directory or its sub-directories.
TObjectFindObjectAnyFile (const char *name) const override
void Flush () final
template<class T>
T * Get (const char *namecycle)
 See documentation of TDirectoryFile::Get(const char *namecycle).
TObjectGet (const char *namecycle) override
 Return pointer to object identified by namecycle.
TArchiveFileGetArchive () const
Long64_t GetArchiveOffset () const
Int_t GetBestBuffer () const
Int_t GetBufferSize () const override
virtual Long64_t GetBytesRead () const
virtual Long64_t GetBytesReadExtra () const
virtual Int_t GetBytesToPrefetch () const
virtual Long64_t GetBytesWritten () const
TFileCacheReadGetCacheRead (const TObject *tree=nullptr) const
TFileCacheWriteGetCacheWrite () const
TArrayCGetClassIndex () const
Int_t GetCompressionAlgorithm () const
Float_t GetCompressionFactor ()
Int_t GetCompressionLevel () const
Int_t GetCompressionSettings () const
const TDatimeGetCreationDate () const
TDirectoryGetDirectory (const char *apath, Bool_t printError=false, const char *funcname="GetDirectory") override
 Find a directory using apath.
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
Long64_t GetEND () const final
virtual const TUrlGetEndpointUrl () const
Int_t GetErrno () const final
Int_t GetFd () const
TFileGetFile () const override
virtual const char * GetIconName () const
 Returns mime type name of object.
Int_t GetIOVersion () const
TKeyGetKey (const char *name, Short_t cycle=9999) const override
virtual TListGetList () const
TListGetListOfFree () const
TListGetListOfKeys () const override
TObjArrayGetListOfProcessIDs () const
const TDatimeGetModificationDate () const
TObjectGetMother () const
TDirectoryGetMotherDir () const
const char * GetName () const override
 Returns name of object.
Int_t GetNbytesFree () const final
Int_t GetNbytesInfo () const final
Int_t GetNbytesKeys () const override
virtual TString GetNewUrl ()
Int_t GetNextRefCounter ()
Int_t GetNfree () const final
Int_t GetNkeys () const override
virtual Int_t GetNProcessIDs () const
template<class T>
void GetObject (const char *namecycle, T *&ptr)
 Get an object with proper type checking.
void * GetObjectChecked (const char *namecycle, const char *classname) override
 See documentation of TDirectory::GetObjectCheck(const char *namecycle, const TClass *cl).
void * GetObjectChecked (const char *namecycle, const TClass *cl) override
 Return pointer to object identified by namecycle if and only if the actual object is a type suitable to be stored as a pointer to a "expectedClass" If expectedClass is null, no check is performed.
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
void * GetObjectUnchecked (const char *namecycle) override
 Return pointer to object identified by namecycle.
Option_tGetOption () const override
virtual const char * GetPath () const
 Returns the full path of the directory.
virtual const char * GetPathStatic () const
 Returns the full path of the directory.
virtual Int_t GetReadCalls () const
Int_t GetRecordHeader (char *buf, Long64_t first, Int_t maxbytes, Int_t &nbytes, Int_t &objlen, Int_t &keylen)
Long64_t GetRelOffset () const
Long64_t GetSeekDir () const override
Long64_t GetSeekFree () const final
Long64_t GetSeekInfo () const final
Long64_t GetSeekKeys () const override
Long64_t GetSeekParent () const override
TString GetSetupAsString ()
 return setup values as string
Long64_t GetSize () const final
const TListGetStreamerInfoCache ()
virtual TListGetStreamerInfoList () final
const char * GetTitle () const override
 Returns title of object.
virtual UInt_t GetUniqueID () const
 Return the unique object id.
TUUID GetUUID () const
Int_t GetVersion () const
EXMLLayout GetXmlLayout () const
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
ULong_t Hash () const override
 Return hash value for this object.
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
virtual void IncrementProcessIDs ()
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
void InvertBit (UInt_t f)
TClassIsA () const override
virtual Bool_t IsArchive () const
Bool_t IsBinary () const
Bool_t IsBuilt () const
Bool_t IsDestructed () const
 IsDestructed.
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
Bool_t IsFolder () const override
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
Bool_t IsModified () const override
Bool_t IsOnHeap () const
Bool_t IsOpen () const final
 return kTRUE if file is opened and can be accessed
Bool_t IsRaw () const
Bool_t IsSortable () const override
Bool_t IsStoreStreamerInfos () const
Bool_t IsUseDtd () const
Bool_t IsUseNamespaces () const
Bool_t IsWritable () const override
Bool_t IsZombie () const
void ls (Option_t *option="") const override
 List Directory contents.
void MakeFree (Long64_t, Long64_t) final
void MakeProject (const char *, const char *="*", Option_t *="new") final
void Map () final
void Map (Option_t *) final
virtual Bool_t Matches (const char *name)
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).
TDirectorymkdir (const char *name, const char *title="", Bool_t returnExistingDirectory=kFALSE) override
 Create a sub-directory "a" or a hierarchy of sub-directories "a/b/c/...".
virtual Bool_t MustFlush () const
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
TFileOpenFile (const char *name, Option_t *option="", const char *ftitle="", Int_t compress=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault, Int_t netopt=0) override
void operator delete (void *, size_t)
 Operator delete for sized deallocation.
void operator delete (void *ptr)
 Operator delete.
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
void operator delete[] (void *, size_t)
 Operator delete [] for sized deallocation.
void operator delete[] (void *ptr)
 Operator delete [].
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
void * operator new (size_t sz)
void * operator new (size_t sz, void *vp)
void * operator new[] (size_t sz)
void * operator new[] (size_t sz, void *vp)
void Paint (Option_t *="") final
 Paint all objects in the directory.
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
void Print (Option_t *="") const final
 Print all objects in the directory.
void PrintSetup ()
 show setup values
void Purge (Short_t nkeep=1) override
virtual void pwd () const
 Print the path of the directory.
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
void ReadAll (Option_t *option="") override
Bool_t ReadBuffer (char *, Int_t) final
Bool_t ReadBuffer (char *, Long64_t, Int_t) final
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)
void ReadFree () final
Int_t ReadKeys (Bool_t forceRead=kTRUE) override
virtual TProcessIDReadProcessID (UShort_t pidf)
virtual void ReadStreamerInfo ()
Int_t ReadTObject (TObject *obj, const char *keyname) override
Int_t Recover () final
void RecursiveRemove (TObject *obj) override
 Recursively remove object from a Directory.
virtual TObjectRemove (TObject *)
 Remove an object from the in-memory list.
Int_t ReOpen (Option_t *mode) final
 Reopen a file with a different access mode, like from READ to See TFile::Open() for details.
virtual void ResetAfterMerge (TFileMergeInfo *)
void ResetBit (UInt_t f)
void ResetErrno () const final
void rmdir (const char *name) override
 Removes subdirectory from the directory When directory is deleted, all keys in all subdirectories will be read first and deleted from file (if exists) Equivalent call is Delete("name;*");.
void Save () override
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
Int_t SaveObjectAs (const TObject *obj, const char *filename="", Option_t *option="") const override
 Save object in filename, if filename is nullptr or "", a file with "<objectname>.root" is created.
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
void SaveSelf (Bool_t force=kFALSE) override
void Seek (Long64_t, ERelativeTo=kBeg) final
void SetBit (UInt_t f)
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
void SetBufferSize (Int_t bufsize) override
virtual void SetCacheRead (TFileCacheRead *cache, TObject *tree=nullptr, ECacheAction action=kDisconnect)
virtual void SetCacheWrite (TFileCacheWrite *cache)
virtual void SetCompressionAlgorithm (Int_t algorithm=ROOT::RCompressionSetting::EAlgorithm::kUseGlobal)
virtual void SetCompressionLevel (Int_t level=ROOT::RCompressionSetting::ELevel::kUseMin)
virtual void SetCompressionSettings (Int_t settings=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault)
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
void SetEND (Long64_t) final
void SetModified () override
virtual void SetMother (TObject *mother)
void SetName (const char *newname) override
 Set the name for directory If the directory name is changed after the directory was written once, ROOT currently would NOT change the name of correspondent key in the mother directory.
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
virtual void SetOffset (Long64_t offset, ERelativeTo pos=kBeg)
virtual void SetOption (Option_t *option=">")
virtual void SetReadCalls (Int_t readcalls=0)
void SetSeekDir (Long64_t v) override
void SetStoreStreamerInfos (Bool_t iConvert=kTRUE) final
 If true, all correspondent to file TStreamerInfo objects will be stored in file this allows to apply schema evolution later for this file may be useful, when file used outside ROOT and TStreamerInfo objects does not required Can be changed only for newly created file.
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
void SetTRefAction (TObject *ref, TObject *parent) override
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
void SetUsedDtd (Bool_t use=kTRUE) final
 Specify usage of DTD for this file.
void SetUseNamespaces (Bool_t iUseNamespaces=kTRUE) final
 Specify 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.
void SetWritable (Bool_t writable=kTRUE) override
void SetXmlLayout (EXMLLayout layout) final
 Change layout of objects in xml file Can be changed only for newly created file.
virtual void ShowStreamerInfo ()
Int_t Sizeof () const final
 Return size of the TNamed part of the TObject.
void Streamer (TBuffer &) override
 TDirectory Streamer.
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
void SumBuffer (Int_t bufsize)
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
Bool_t TestBit (UInt_t f) const
Int_t TestBits (UInt_t f) const
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
ROOT::Detail::TKeyMapIterable WalkTKeys ()
 Traverses all TKeys in the TFile and returns information about them.
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
Int_t Write (const char *=nullptr, Int_t=0, Int_t=0) const final
 Write this object to the current directory.
Int_t Write (const char *=nullptr, Int_t=0, Int_t=0) final
 Write this object to the current directory.
Bool_t WriteBuffer (const char *, Int_t) final
void WriteDirHeader () override
void WriteFree () final
void WriteHeader () final
void WriteKeys () override
template<typename T>
std::enable_if_t< std::is_base_of< TObject, T >::value, Int_tWriteObject (const T *obj, const char *name, Option_t *option="", Int_t bufsize=0)
 Write an object with proper type checking.
template<typename T>
std::enable_if_t<!std::is_base_of< TObject, T >::value, Int_tWriteObject (const T *obj, const char *name, Option_t *option="", Int_t bufsize=0)
 Write an object with proper type checking.
Int_t WriteObjectAny (const void *obj, const char *classname, const char *name, Option_t *option="", Int_t bufsize=0) override
Int_t WriteObjectAny (const void *obj, const TClass *cl, const char *name, Option_t *option="", Int_t bufsize=0) override
virtual UShort_t WriteProcessID (TProcessID *pid)
void WriteStreamerInfo () final
 convert all TStreamerInfo, used in file, to xml format
Int_t WriteTObject (const TObject *obj, const char *name=nullptr, Option_t *option="", Int_t bufsize=0) override
TXMLEngineXML ()
const char * XmlClassNameSpaceRef (const TClass *cl)
 produce string which used as reference in class namespace definition
const char * XmlConvertClassName (const char *name)
 convert class name to exclude any special symbols like ':', '<' '>' ',' and spaces
const char * XmlGetElementName (const TStreamerElement *el)
 return converted name for TStreamerElement

Static Public Member Functions

static void _R__DEPRECATED_ ("will be removed in ROOT v" "7" "." "00" ": " "This function has no effect on ROOT") AddDirectory(Bool_t add
static Bool_t _R__DEPRECATED_ ("will be removed in ROOT v" "7" "." "00" ": " "This function has no effect on ROOT") AddDirectoryStatus()
static TFileOpenHandleAsyncOpen (const char *name, Option_t *option="", const char *ftitle="", Int_t compress=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault, Int_t netopt=0)
static Bool_t Cd (const char *path)
static TClassClass ()
static const char * Class_Name ()
static constexpr Version_t Class_Version ()
static Bool_t Cp (const char *src, const char *dst, Bool_t progressbar=kTRUE, UInt_t buffersize=1000000)
static std::atomic< TDirectory * > & CurrentDirectory ()
 Return the current directory for the current thread.
static TFile *& CurrentFile ()
static const char * DeclFileName ()
static size_t DecodeNameCycle (const char *namecycle, char *name, Short_t &cycle, const size_t namesize=0)
static TString DefaultXmlSetup ()
 return default value for XML setup
static EAsyncOpenStatus GetAsyncOpenStatus (const char *name)
static EAsyncOpenStatus GetAsyncOpenStatus (TFileOpenHandle *handle)
static const char * GetCacheFileDir ()
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
static const TUrlGetEndpointUrl (const char *name)
static Long64_t GetFileBytesRead ()
static Long64_t GetFileBytesWritten ()
static Long64_t GetFileCounter ()
static Int_t GetFileReadCalls ()
static Bool_t GetObjectStat ()
 Get status of object stat flag.
static Bool_t GetOnlyStaged ()
static UInt_t GetOpenTimeout ()
static Int_t GetReadaheadSize ()
static Bool_t GetReadStreamerInfo ()
static EFileType GetType (const char *name, Option_t *option="", TString *prefix=nullptr)
static void IncrementFileCounter ()
static TFileOpen (const char *name, Option_t *option="", const char *ftitle="", Int_t compress=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault, Int_t netopt=0)
static TFileOpen (TFileOpenHandle *handle)
static Bool_t SetCacheFileDir (std::string_view cacheDir, Bool_t operateDisconnected=kTRUE, Bool_t forceCacheread=kFALSE)
static void SetDtorOnly (void *obj)
 Set destructor only flag.
static void SetFileBytesRead (Long64_t bytes=0)
static void SetFileBytesWritten (Long64_t bytes=0)
static void SetFileReadCalls (Int_t readcalls=0)
static void SetNameSpaceBase (const char *namespacebase)
 set namespace base
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
static Bool_t SetOnlyStaged (Bool_t onlystaged)
static UInt_t SetOpenTimeout (UInt_t timeout)
static void SetReadaheadSize (Int_t bufsize=256000)
static void SetReadStreamerInfo (Bool_t readinfo=kTRUE)
static Bool_t ShrinkCacheFileDir (Long64_t shrinkSize, Long_t cleanupInteval=0)

Protected Types

enum  { kOnlyPrepStep = (1ULL << (3)) }
using SharedGDirectory_t = std::shared_ptr<std::atomic<TDirectory *>>

Protected Member Functions

Int_t AtoI (const char *sbuf, Int_t def=0, const char *errinfo=nullptr)
 converts string to integer.
void BuildDirectory (TFile *motherFile, TDirectory *motherDir)
 Initialise directory to defaults.
void BuildDirectoryFile (TFile *motherFile, TDirectory *motherDir)
Bool_t cd1 (const char *path)
 Change current directory to "this" directory or to the directory described by the path if given one.
void CleanTargets ()
void CombineNodesTree (TDirectory *dir, XMLNodePointer_t topnode, Bool_t dolink)
 Connect/disconnect all file nodes to single tree before/after saving.
Long64_t DirCreateEntry (TDirectory *) final
 Create key for directory entry in the key.
Int_t DirReadKeys (TDirectory *) final
 Read keys for directory Make sense only once, while next time no new subnodes will be created.
void DirWriteHeader (TDirectory *) final
 Write the directory header.
void DirWriteKeys (TDirectory *) final
 Update key attributes.
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
void FillFullPath (TString &buf) const
 Recursive method to fill full path for directory.
TKeyXMLFindDirKey (TDirectory *dir)
 Search for key which correspond to directory dir.
TDirectoryFindKeyDir (TDirectory *mother, Long64_t keyid)
 Find a directory in motherdir with a seek equal to keyid.
Bool_t FlushWriteCache ()
virtual EAsyncOpenStatus GetAsyncOpenStatus ()
const char * GetElItemName (TStreamerElement *el)
 get item name for given element
InfoListRet GetStreamerInfoListImpl (bool lookupSICache) final
 Read streamerinfo structures from xml format and provide them in the list It is user responsibility to destroy this list.
virtual void Init (Bool_t create)
void InitDirectoryFile (TClass *cl=nullptr)
void InitXmlFile (Bool_t create)
 initialize xml file and correspondent structures identical to TFile::Init() function
Bool_t IsValidXmlSetup (const char *setupstr)
 checks if string is valid setup
void MakeZombie ()
Int_t ReadBufferViaCache (char *buf, Int_t len)
Bool_t ReadFromFile ()
 read document from file Now full content of document reads into the memory Then document decomposed to separate keys and streamer info structures All irrelevant data will be cleaned
Int_t ReadKeysList (TDirectory *dir, XMLNodePointer_t topnode)
 Read list of keys for directory.
Bool_t ReadSetupFromStr (const char *setupstr)
 get values from string
void ReadStreamerElement (XMLNodePointer_t node, TStreamerInfo *info)
 read and reconstruct single TStreamerElement from xml node
void RegisterContext (TContext *ctxt)
void RegisterGDirectory (SharedGDirectory_t &ptr)
void SavePrimitiveNameTitle (std::ostream &out, const char *variable_name)
 Save object name and title into the output stream "out".
void SaveToFile ()
 Saves xml structures to the file xml elements are kept in list of TKeyXML objects When saving, all this elements are linked to root xml node At the end StreamerInfo structures are added After xml document is saved, all nodes will be unlinked from root node and kept in memory.
void StoreStreamerElement (XMLNodePointer_t node, TStreamerElement *elem)
 store data of single TStreamerElement in streamer node
Int_t SysClose (Int_t) final
Int_t SysOpen (const char *, Int_t, UInt_t) final
Int_t SysRead (Int_t, void *, Int_t) final
Long64_t SysSeek (Int_t, Long64_t, Int_t) final
Int_t SysStat (Int_t, Long_t *, Long64_t *, Long_t *, Long_t *) final
Int_t SysSync (Int_t) final
Int_t SysWrite (Int_t, const void *, Int_t) final
void UnregisterContext (TContext *ctxt)
 UnRegister a TContext pointing to this TDirectory object.
Int_t WriteBufferViaCache (const char *buf, Int_t len)
TClassXmlDefineClass (const char *xmlClassName)
 define class for the converted class name, where special symbols were replaced by '_'

Static Protected Member Functions

static Bool_t Cd1 (const char *path)
 Change current directory to "path".
static SharedGDirectory_tGetSharedLocalCurrentDirectory ()
 Return the (address of) a shared pointer to the struct holding the actual thread local gDirectory pointer and the atomic_flag for its lock.
static void ProduceFileNames (const char *filename, TString &fname, TString &dtdname)
 function produces pair of xml and dtd file names
static void SavePrimitiveConstructor (std::ostream &out, TClass *cl, const char *variable_name, const char *constructor_agrs="", Bool_t empty_line=kTRUE)
 Save object constructor in the output stream "out".
static void SavePrimitiveDraw (std::ostream &out, const char *variable_name, Option_t *option=nullptr)
 Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.
static TString SavePrimitiveVector (std::ostream &out, const char *prefix, Int_t len, Double_t *arr, Int_t flag=0)
 Save array in the output stream "out" as vector.

Protected Attributes

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

Static Protected Attributes

static Bool_t fgAddDirectory = false
 !
static TListfgAsyncOpenRequests
static std::atomic< Long64_tfgBytesRead
 Number of bytes read by all TFile objects.
static std::atomic< Long64_tfgBytesWrite
 Number of bytes written by all TFile objects.
static TString fgCacheFileDir
 Directory where to locally stage files.
static Bool_t fgCacheFileDisconnected
 Indicates, we trust in the files in the cache dir without stat on the cached file.
static Bool_t fgCacheFileForce
 Indicates, to force all READ to CACHEREAD.
static std::atomic< Long64_tfgFileCounter
 Counter for all opened files.
static TString fgNameSpaceBase = fgROOTDocNameSpaceBase
static Bool_t fgOnlyStaged
 Before the file is opened, it is checked, that the file is staged, if not, the open fails.
static UInt_t fgOpenTimeout
 Timeout for open operations in ms - 0 corresponds to blocking i/o.
static Int_t fgReadaheadSize
 Readahead buffer size.
static std::atomic< Int_tfgReadCalls
 Number of bytes read from all TFile objects.
static Bool_t fgReadInfo
 if true (default) ReadStreamerInfo is called when opening a file
static ROOT::Internal::RConcurrentHashColl fgTsSIHashes
 !TS Set of hashes built from read streamer infos

Private Member Functions

 TXMLFile (const TXMLFile &)=delete
void operator= (const TXMLFile &)=delete

Static Private Member Functions

static void AddToTObjectTable (TObject *)
 Private helper function which will dispatch to TObjectTable::AddObj.
static void CpProgress (Long64_t bytesread, Long64_t size, TStopwatch &watch)
static TFileOpenFromCache (const char *name, Option_t *="", const char *ftitle="", Int_t compress=ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault, Int_t netopt=0)

Private Attributes

UInt_t fBits
 bit field status word
UInt_t fUniqueID
 object unique identifier

Static Private Attributes

static Longptr_t fgDtorOnly = 0
 object for which to call dtor only (i.e. no delete)
static Bool_t fgObjectStat = kTRUE
 if true keep track of objects in TObjectTable
Inheritance diagram for TXMLFile:
TFile TXMLSetup TDirectoryFile TDirectory TNamed TObject

Member Typedef Documentation

◆ SharedGDirectory_t

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

Definition at line 147 of file TDirectory.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protectedinherited
Enumerator
kOnlyPrepStep 

Used to request that the class specific implementation of TObject::Write just prepare the objects to be ready to be written but do not actually write them into the TBuffer.

This is just for example by TBufferMerger to request that the TTree inside the file calls TTree::FlushBaskets (outside of the merging lock) and TBufferMerger will later ask for the write (inside the merging lock). To take advantage of this feature the class needs to overload TObject::Write and use this enum value accordingly. (See TTree::Write and TObject::Write) Do not use, this feature will be migrate to the Merge function (See TClass and TTree::Merge)

Definition at line 106 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kSingleKey 

write collection with single key

kOverwrite 

overwrite existing object with same name

kWriteDelete 

write object, then delete previous key with same name

Definition at line 99 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kIsOnHeap 

object is on heap

kNotDeleted 

object has not been deleted

kZombie 

object ctor failed

kInconsistent 

class overload Hash but does call RecursiveRemove in destructor

kBitMask 

Definition at line 89 of file TObject.h.

◆ anonymous enum

anonymous enum
inherited
Enumerator
kStartBigFile 

Definition at line 278 of file TFile.h.

◆ EAsyncOpenStatus

enum TFile::EAsyncOpenStatus
inherited

Asynchronous open request status.

Enumerator
kAOSNotAsync 
kAOSFailure 
kAOSInProgress 
kAOSSuccess 

Definition at line 142 of file TFile.h.

◆ ECacheAction

enum TFile::ECacheAction
inherited

TTreeCache flushing semantics.

Enumerator
kDisconnect 
kDoNotDisconnect 

Definition at line 148 of file TFile.h.

◆ EDeprecatedStatusBits

Enumerator
kObjInCanvas 

for backward compatibility only, use kMustCleanup

Definition at line 84 of file TObject.h.

◆ EFileType

enum TFile::EFileType
inherited

File type.

Enumerator
kDefault 
kLocal 
kNet 
kWeb 
kFile 
kMerge 

Definition at line 280 of file TFile.h.

◆ EOpenTimeOut

enum TFile::EOpenTimeOut
inherited

Open timeout constants.

Enumerator
kInstantTimeout 
kEternalTimeout 

Definition at line 145 of file TFile.h.

◆ ERelativeTo

enum TFile::ERelativeTo
inherited
Enumerator
kBeg 
kCur 
kEnd 

Definition at line 277 of file TFile.h.

◆ EStatusBits

enum TFile::EStatusBits
inherited

TFile status bits. BIT(13) is taken up by TObject.

Enumerator
k630forwardCompatibility 
kRecovered 
kHasReferences 
kDevNull 
kWriteError 
kBinaryFile 
kRedirected 
kReproducible 
kCancelTTreeChangeRequest 

Definition at line 257 of file TFile.h.

◆ EXMLLayout

enum TXMLSetup::EXMLLayout
inherited
Enumerator
kSpecialized 
kGeneralized 

Definition at line 84 of file TXMLSetup.h.

Constructor & Destructor Documentation

◆ TXMLFile() [1/3]

TXMLFile::TXMLFile ( const TXMLFile & )
privatedelete

◆ TXMLFile() [2/3]

TXMLFile::TXMLFile ( )
inline

Definition at line 51 of file TXMLFile.h.

◆ TXMLFile() [3/3]

TXMLFile::TXMLFile ( const char * filename,
Option_t * option = "read",
const char * title = "title",
Int_t compression = ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault )

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

TXMLFile does not support TTree objects

Definition at line 115 of file TXMLFile.cxx.

◆ ~TXMLFile()

TXMLFile::~TXMLFile ( )
override

destructor of TXMLFile object

Definition at line 354 of file TXMLFile.cxx.

Member Function Documentation

◆ _R__DEPRECATED_() [1/2]

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

◆ _R__DEPRECATED_() [2/2]

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

◆ AbstractMethod()

void TObject::AbstractMethod ( const char * method) const
inherited

Call this function within a function that you don't want to define as purely virtual, in order not to force all users deriving from that class to implement that maybe (on their side) unused function; but at the same time, emit a run-time warning if they try to call it, telling that it is not implemented in the derived class: action must thus be taken on the user side to override it.

In other word, this method acts as a "runtime purely virtual" warning instead of a "compiler purely virtual" error.

Warning
This interface is a legacy function that is no longer recommended to be used by new development code.
Note
The name "AbstractMethod" does not imply that it's an abstract method in the strict C++ sense.

Definition at line 1149 of file TObject.cxx.

◆ Add()

void TDirectoryFile::Add ( TObject * obj,
Bool_t replace = kFALSE )
inlineoverridevirtualinherited

Append object to this directory.

See also
Append(TObject*, Bool_t)

Reimplemented from TDirectory.

Reimplemented in RooWorkspace::WSDir.

Definition at line 65 of file TDirectoryFile.h.

◆ AddToTObjectTable()

void TObject::AddToTObjectTable ( TObject * op)
staticprivateinherited

Private helper function which will dispatch to TObjectTable::AddObj.

Included here to avoid circular dependency between header files.

Definition at line 195 of file TObject.cxx.

◆ AddXmlComment()

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 963 of file TXMLFile.cxx.

◆ AddXmlLine()

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 997 of file TXMLFile.cxx.

◆ AddXmlStyleSheet()

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

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, attribute 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 981 of file TXMLFile.cxx.

◆ Append()

void TDirectoryFile::Append ( TObject * obj,
Bool_t replace = kFALSE )
overridevirtualinherited

Append object to this directory.

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

Reimplemented from TDirectory.

Reimplemented in RooWorkspace::WSDir.

◆ AppendKey()

Int_t TDirectoryFile::AppendKey ( TKey * key)
overridevirtualinherited

Reimplemented from TDirectory.

◆ AppendPad()

void TObject::AppendPad ( Option_t * option = "")
virtualinherited

Append graphics object to current pad.

In case no current pad is set yet, create a default canvas with the name "c1".

Definition at line 204 of file TObject.cxx.

◆ AsyncOpen()

TFileOpenHandle * TFile::AsyncOpen ( const char * name,
Option_t * option = "",
const char * ftitle = "",
Int_t compress = ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault,
Int_t netopt = 0 )
staticinherited

◆ AtoI()

Int_t TXMLSetup::AtoI ( const char * sbuf,
Int_t def = 0,
const char * errinfo = nullptr )
protectedinherited

converts string to integer.

if error, returns default value

Definition at line 289 of file TXMLSetup.cxx.

◆ Browse()

void TDirectoryFile::Browse ( TBrowser * b)
overridevirtualinherited

Browse the content of the directory.

Reimplemented from TDirectory.

◆ Build()

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

Reimplemented from TDirectory.

Definition at line 68 of file TDirectoryFile.h.

◆ BuildDirectory()

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

Initialise directory to defaults.

If directory is created via default ctor (when dir is read from file) don't add it here to the directory since its name is not yet known. It will be added to the directory in TKey::ReadObj().

Definition at line 255 of file TDirectory.cxx.

◆ BuildDirectoryFile()

void TDirectoryFile::BuildDirectoryFile ( TFile * motherFile,
TDirectory * motherDir )
protectedinherited

◆ Cd()

Bool_t TDirectory::Cd ( const char * path)
staticinherited

◆ cd() [1/2]

Bool_t TDirectoryFile::cd ( )
overridevirtualinherited

Change current directory to "this" directory.

Returns kTRUE (it's guaranteed to succeed).

Reimplemented from TDirectory.

◆ cd() [2/2]

Bool_t TDirectoryFile::cd ( const char * path)
overridevirtualinherited

Change current directory to "this" directory or to the directory described by the path if given one.

Using path one can change the current directory to "path". The absolute path syntax is: file.root:/dir1/dir2 where file.root is the file and /dir1/dir2 the desired subdirectory in the file.

Relative syntax is relative to "this" directory. E.g: ../aa.

Returns kTRUE in case of success.

Reimplemented from TDirectory.

◆ Cd1()

Bool_t TDirectory::Cd1 ( const char * apath)
staticprotectedinherited

Change current directory to "path".

The absolute path syntax is: file.root:/dir1/dir2 where file.root is the file and /dir1/dir2 the desired subdirectory in the file. Relative syntax is relative to the current directory gDirectory, e.g.: ../aa`.

Returns kTRUE in case of success. */

Bool_t TDirectory::Cd(const char *path) { return Cd1(path); }

/** Change current directory to "path". The path syntax is: file.root:/dir1/dir2 where file.root is the file and /dir1/dir2 the desired subdirectory in the file. Relative syntax is relative to the current directory gDirectory, e.g.: ../aa.

Returns kFALSE in case path does not exist.

Definition at line 623 of file TDirectory.cxx.

◆ cd1()

Bool_t TDirectory::cd1 ( const char * apath)
protectedinherited

Change current directory to "this" directory or to the directory described by the path if given one.

Using path one can change the current directory to "path". The absolute path syntax is: file.root:/dir1/dir2 where file.root is the file and /dir1/dir2 the desired subdirectory in the file.

Relative syntax is relative to "this" directory. E.g: ../aa.

Returns kFALSE in case path does not exist.

Definition at line 587 of file TDirectory.cxx.

◆ CheckedHash()

ULong_t TObject::CheckedHash ( )
inlineinherited

Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

The intent is for this routine to be called instead of directly calling the function Hash during "insert" operations. See TObject::HasInconsistenTObjectHash();

(*) The setup is consistent when all classes in the class hierarchy that overload TObject::Hash do call ROOT::CallRecursiveRemoveIfNeeded in their destructor. i.e. it is safe to call the Hash virtual function during the RecursiveRemove operation.

Definition at line 332 of file TObject.h.

◆ Class()

TClass * TXMLFile::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

const char * TXMLFile::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

constexpr Version_t TXMLFile::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 140 of file TXMLFile.h.

◆ ClassName()

const char * TObject::ClassName ( ) const
virtualinherited

Returns name of class to which the object belongs.

Definition at line 227 of file TObject.cxx.

◆ CleanTargets()

void TDirectoryFile::CleanTargets ( )
protectedinherited

◆ Clear()

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

Delete all objects from a Directory list.

Reimplemented from TObject.

Definition at line 640 of file TDirectory.cxx.

◆ Clone()

TObject * TNamed::Clone ( const char * newname = "") const
overridevirtualinherited

Make a clone of an object using the Streamer facility.

If newname is specified, this will be the name of the new object.

Reimplemented from TObject.

Reimplemented in TStreamerInfo, and TTreeIndex.

Definition at line 73 of file TNamed.cxx.

◆ CloneObject()

TObject * TDirectoryFile::CloneObject ( const TObject * obj,
Bool_t autoadd = kTRUE )
overridevirtualinherited

Clone an object.

This function is called when the directory is not a TDirectoryFile. This version has to load the I/O package, hence via Cling.

If autoadd is true and if the object class has a DirectoryAutoAdd function, it will be called at the end of the function with the parameter gDirectory. This usually means that the object will be appended to the current ROOT directory.

Reimplemented from TDirectory.

◆ Close()

void TXMLFile::Close ( Option_t * option = "")
finalvirtual

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

Reimplemented from TFile.

Definition at line 298 of file TXMLFile.cxx.

◆ CombineNodesTree()

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 534 of file TXMLFile.cxx.

◆ Compare()

Int_t TNamed::Compare ( const TObject * obj) const
overridevirtualinherited

Compare two TNamed objects.

Returns 0 when equal, -1 when this is smaller and +1 when bigger (like strcmp).

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 84 of file TNamed.cxx.

◆ Copy()

void TFile::Copy ( TObject & object) const
inlineoverridevirtualinherited

Copy this to obj.

Reimplemented from TDirectoryFile.

Definition at line 297 of file TFile.h.

◆ Cp() [1/2]

virtual Bool_t TFile::Cp ( const char * dst,
Bool_t progressbar = kTRUE,
UInt_t bufsize = 1000000 )
virtualinherited

◆ Cp() [2/2]

Bool_t TFile::Cp ( const char * src,
const char * dst,
Bool_t progressbar = kTRUE,
UInt_t buffersize = 1000000 )
staticinherited

◆ CpProgress()

void TFile::CpProgress ( Long64_t bytesread,
Long64_t size,
TStopwatch & watch )
staticprivateinherited

◆ CreateKey() [1/2]

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

create XML key, which will store object in xml structures

Reimplemented from TFile.

Definition at line 407 of file TXMLFile.cxx.

◆ CreateKey() [2/2]

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

create XML key, which will store object in xml structures

Reimplemented from TFile.

Definition at line 415 of file TXMLFile.cxx.

◆ CurrentDirectory()

std::atomic< TDirectory * > & TDirectory::CurrentDirectory ( )
staticinherited

Return the current directory for the current thread.

Definition at line 438 of file TDirectory.cxx.

◆ CurrentFile()

TFile *& TFile::CurrentFile ( )
staticinherited

◆ DeclFileName()

const char * TXMLFile::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 140 of file TXMLFile.h.

◆ DecodeNameCycle()

size_t TDirectory::DecodeNameCycle ( const char * namecycle,
char * name,
Short_t & cycle,
const size_t namesize = 0 )
staticinherited

◆ DefaultXmlSetup()

TString TXMLSetup::DefaultXmlSetup ( )
staticinherited

return default value for XML setup

Definition at line 103 of file TXMLSetup.cxx.

◆ Delete()

void TFile::Delete ( const char * namecycle = "")
overridevirtualinherited

Delete Objects or/and keys in a directory.

  • namecycle has the format name;cycle
  • namecycle = "" same as namecycle ="T*"
  • name = * means all
  • cycle = * means all cycles (memory and keys)
  • cycle = "" or cycle = 9999 ==> apply to a memory object When name=* use T* to delete subdirectories also

To delete one directory, you must specify the directory cycle, eg. file.Delete("dir1;1");

examples:

  • foo : delete object named foo in memory
  • foo* : delete all objects with a name starting with foo
  • foo;1 : delete cycle 1 of foo on file
  • foo;* : delete all cycles of foo on file and also from memory
  • ;2 : delete all objects on file having the cycle 2
  • *; : delete all objects from memory and file
  • T*;* : delete all objects from memory and file and all subdirectories

Reimplemented from TDirectoryFile.

◆ DeleteAll()

void TDirectory::DeleteAll ( Option_t * option = "")
virtualinherited

Delete all objects from memory.

Definition at line 691 of file TDirectory.cxx.

◆ DirCreateEntry()

Long64_t TXMLFile::DirCreateEntry ( TDirectory * dir)
finalprotectedvirtual

Create key for directory entry in the key.

Reimplemented from TFile.

Definition at line 1008 of file TXMLFile.cxx.

◆ DirReadKeys()

Int_t TXMLFile::DirReadKeys ( TDirectory * dir)
finalprotectedvirtual

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

Reimplemented from TFile.

Definition at line 1069 of file TXMLFile.cxx.

◆ DirWriteHeader()

void TXMLFile::DirWriteHeader ( TDirectory * dir)
finalprotectedvirtual

Write the directory header.

Reimplemented from TFile.

Definition at line 1096 of file TXMLFile.cxx.

◆ DirWriteKeys()

void TXMLFile::DirWriteKeys ( TDirectory * )
finalprotectedvirtual

Update key attributes.

Reimplemented from TFile.

Definition at line 1081 of file TXMLFile.cxx.

◆ DistancetoPrimitive()

◆ DoError()

void TObject::DoError ( int level,
const char * location,
const char * fmt,
va_list va ) const
protectedvirtualinherited

Interface to ErrorHandler (protected).

Reimplemented in TThread, and TTreeViewer.

Definition at line 1059 of file TObject.cxx.

◆ Draw()

void TFile::Draw ( Option_t * option = "")
overridevirtualinherited

Fill Graphics Structure and Paint.

Loop on all objects (memory or file) and all subdirectories

Reimplemented from TDirectory.

◆ DrawClass()

void TObject::DrawClass ( ) const
virtualinherited

Draw class inheritance tree of the class to which this object belongs.

If a class B inherits from a class A, description of B is drawn on the right side of description of A. Member functions overridden by B are shown in class A with a blue line crossing-out the corresponding member function. The following picture is the class inheritance tree of class TPaveLabel:

Reimplemented in TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 308 of file TObject.cxx.

◆ DrawClone()

TObject * TObject::DrawClone ( Option_t * option = "") const
virtualinherited

Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).

If pad was not selected - gPad will be used.

Note
For histograms, use the more specialised TH1::DrawCopy().

Reimplemented in TAxis, TCanvas, TGFrame, TSystemDirectory, and TSystemFile.

Definition at line 319 of file TObject.cxx.

◆ DrawMap()

void TXMLFile::DrawMap ( const char * = "*",
Option_t * = "" )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 58 of file TXMLFile.h.

◆ Dump()

void TObject::Dump ( ) const
virtualinherited

Dump contents of object on stdout.

Using the information in the object dictionary (class TClass) each data member is interpreted. If a data member is a pointer, the pointer value is printed

The following output is the Dump of a TArrow object:

fAngle 0 Arrow opening angle (degrees)
fArrowSize 0.2 Arrow Size
fOption.*fData
fX1 0.1 X of 1st point
fY1 0.15 Y of 1st point
fX2 0.67 X of 2nd point
fY2 0.83 Y of 2nd point
fUniqueID 0 object unique identifier
fBits 50331648 bit field status word
fLineColor 1 line color
fLineStyle 1 line style
fLineWidth 1 line width
fFillColor 19 fill area color
fFillStyle 1001 fill area style
#define X(type, name)
Option_t Option_t TPoint TPoint angle
Option_t Option_t width
Option_t Option_t style
TString fOption
File options.
Definition TFile.h:169
UInt_t fUniqueID
object unique identifier
Definition TObject.h:46
UInt_t fBits
bit field status word
Definition TObject.h:47
TLine * line

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

Definition at line 367 of file TObject.cxx.

◆ Error()

void TObject::Error ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue error message.

Use "location" to specify the method where the error occurred. Accepts standard printf formatting arguments.

Reimplemented in TFitResult.

Definition at line 1098 of file TObject.cxx.

◆ Execute() [1/2]

void TObject::Execute ( const char * method,
const char * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with the given parameter string, e.g.

"3.14,1,\"text\"".

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

Definition at line 378 of file TObject.cxx.

◆ Execute() [2/2]

void TObject::Execute ( TMethod * method,
TObjArray * params,
Int_t * error = nullptr )
virtualinherited

Execute method on this object with parameters stored in the TObjArray.

The TObjArray should contain an argv vector like:

argv[0] ... argv[n] = the list of TObjString parameters
Collectable string class.
Definition TObjString.h:28
const Int_t n
Definition legend1.C:16

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

Definition at line 398 of file TObject.cxx.

◆ ExecuteEvent()

◆ Fatal()

void TObject::Fatal ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue fatal error message.

Use "location" to specify the method where the fatal error occurred. Accepts standard printf formatting arguments.

Definition at line 1126 of file TObject.cxx.

◆ FillBuffer()

void TXMLFile::FillBuffer ( char *& buffer)
inlinefinalvirtual

Encode TNamed into output buffer.

Reimplemented from TFile.

Definition at line 59 of file TXMLFile.h.

◆ FillFullPath()

void TDirectory::FillFullPath ( TString & buf) const
protectedinherited

Recursive method to fill full path for directory.

Definition at line 1067 of file TDirectory.cxx.

◆ FindDirKey()

TKeyXML * TXMLFile::FindDirKey ( TDirectory * dir)
protected

Search for key which correspond to directory dir.

Definition at line 1024 of file TXMLFile.cxx.

◆ FindKey()

TKey * TDirectoryFile::FindKey ( const char * keyname) const
overridevirtualinherited

Reimplemented from TDirectory.

◆ FindKeyAny()

TKey * TDirectoryFile::FindKeyAny ( const char * keyname) const
overridevirtualinherited

Reimplemented from TDirectory.

◆ FindKeyDir()

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

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

Definition at line 1047 of file TXMLFile.cxx.

◆ FindObject() [1/2]

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

Find object by name in the list of memory objects.

Reimplemented from TObject.

Reimplemented in TROOT.

Definition at line 790 of file TDirectory.cxx.

◆ FindObject() [2/2]

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

Find object in the list of memory objects.

Reimplemented from TObject.

Reimplemented in TROOT.

Definition at line 782 of file TDirectory.cxx.

◆ FindObjectAny()

TObject * TDirectoryFile::FindObjectAny ( const char * aname) const
overridevirtualinherited

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

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

Reimplemented from TDirectory.

◆ FindObjectAnyFile()

TObject * TDirectoryFile::FindObjectAnyFile ( const char * name) const
overridevirtualinherited

Reimplemented from TDirectory.

◆ Flush()

void TXMLFile::Flush ( )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 60 of file TXMLFile.h.

◆ FlushWriteCache()

Bool_t TFile::FlushWriteCache ( )
protectedinherited

◆ Get() [1/2]

template<class T>
T * TDirectoryFile::Get ( const char * namecycle)
inlinevirtualinherited

See documentation of TDirectoryFile::Get(const char *namecycle).

Reimplemented from TDirectory.

Definition at line 82 of file TDirectoryFile.h.

◆ Get() [2/2]

TObject * TDirectoryFile::Get ( const char * namecycle)
overridevirtualinherited

Return pointer to object identified by namecycle.

namecycle has the format name;cycle

  • name = * is illegal, cycle = * is illegal
  • cycle = "" or cycle = 9999 ==> apply to a memory object

examples:

  • foo : get object named foo in memory if object is not in memory, try with highest cycle from file
  • foo;1 : get cycle 1 of foo on file

The retrieved object should in principle derive from TObject. If not, the function TDirectory::GetObject should be called. However, this function will still work for a non-TObject, providing that the calling application cast the return type to the correct type (which is the actual type of the object).

NOTE:

The method GetObject offer better protection and avoid the need for any cast:

MyClass *obj;
directory->GetObject("some object",obj);
if (obj) { ... the object exist and inherits from MyClass ... }

VERY IMPORTANT NOTE:

In case the class of this object derives from TObject but not as a first inheritance, one must use dynamic_cast<>().

Example 1: Normal case:

class MyClass : public TObject, public AnotherClass
Mother of all ROOT objects.
Definition TObject.h:42

then on return, one can do:

MyClass *obj = (MyClass*)directory->Get("some object of MyClass");

Example 2: Special case:

class MyClass : public AnotherClass, public TObject

then on return, one must do:

MyClass *obj = dynamic_cast<MyClass*>(directory->Get("some object of MyClass"));

Of course, dynamic_cast<> can also be used in the example 1.

Reimplemented from TDirectory.

◆ GetArchive()

TArchiveFile * TFile::GetArchive ( ) const
inlineinherited

Definition at line 308 of file TFile.h.

◆ GetArchiveOffset()

Long64_t TFile::GetArchiveOffset ( ) const
inlineinherited

Definition at line 309 of file TFile.h.

◆ GetAsyncOpenStatus() [1/3]

virtual EAsyncOpenStatus TFile::GetAsyncOpenStatus ( )
inlineprotectedvirtualinherited

Definition at line 215 of file TFile.h.

◆ GetAsyncOpenStatus() [2/3]

EAsyncOpenStatus TFile::GetAsyncOpenStatus ( const char * name)
staticinherited

◆ GetAsyncOpenStatus() [3/3]

EAsyncOpenStatus TFile::GetAsyncOpenStatus ( TFileOpenHandle * handle)
staticinherited

◆ GetBestBuffer()

Int_t TFile::GetBestBuffer ( ) const
inherited

◆ GetBufferSize()

Int_t TDirectoryFile::GetBufferSize ( ) const
overridevirtualinherited

Reimplemented from TDirectory.

◆ GetBytesRead()

virtual Long64_t TFile::GetBytesRead ( ) const
inlinevirtualinherited

Definition at line 329 of file TFile.h.

◆ GetBytesReadExtra()

virtual Long64_t TFile::GetBytesReadExtra ( ) const
inlinevirtualinherited

Definition at line 330 of file TFile.h.

◆ GetBytesToPrefetch()

virtual Int_t TFile::GetBytesToPrefetch ( ) const
virtualinherited

◆ GetBytesWritten()

virtual Long64_t TFile::GetBytesWritten ( ) const
virtualinherited

◆ GetCacheFileDir()

const char * TFile::GetCacheFileDir ( )
staticinherited

◆ GetCacheRead()

TFileCacheRead * TFile::GetCacheRead ( const TObject * tree = nullptr) const
inherited

◆ GetCacheWrite()

TFileCacheWrite * TFile::GetCacheWrite ( ) const
inherited

◆ GetClassIndex()

TArrayC * TFile::GetClassIndex ( ) const
inlineinherited

Definition at line 314 of file TFile.h.

◆ GetCompressionAlgorithm()

Int_t TFile::GetCompressionAlgorithm ( ) const
inlineinherited

Definition at line 477 of file TFile.h.

◆ GetCompressionFactor()

Float_t TFile::GetCompressionFactor ( )
inherited

◆ GetCompressionLevel()

Int_t TFile::GetCompressionLevel ( ) const
inlineinherited

Definition at line 483 of file TFile.h.

◆ GetCompressionSettings()

Int_t TFile::GetCompressionSettings ( ) const
inlineinherited

Definition at line 489 of file TFile.h.

◆ GetCreationDate()

const TDatime & TDirectoryFile::GetCreationDate ( ) const
inlineinherited

Definition at line 91 of file TDirectoryFile.h.

◆ GetDirectory()

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

Find a directory using apath.

It apath is null or empty, returns "this" directory. Otherwise use apath to find a directory. The absolute path syntax is: file.root:/dir1/dir2

where file.root is the file and /dir1/dir2 the desired subdirectory in the file. Relative syntax is relative to "this" directory. E.g: ../aa. Returns 0 in case path does not exist. If printError is true, use Error with 'funcname' to issue an error message.

Reimplemented from TDirectory.

◆ GetDrawOption()

Option_t * TObject::GetDrawOption ( ) const
virtualinherited

Get option used by the graphics system to draw this object.

Note that before calling object.GetDrawOption(), you must have called object.Draw(..) before in the current pad.

Reimplemented in TBrowser, TFitEditor, TGedFrame, TGFileBrowser, TRootBrowser, and TRootBrowserLite.

Definition at line 445 of file TObject.cxx.

◆ GetDtorOnly()

Longptr_t TObject::GetDtorOnly ( )
staticinherited

Return destructor only flag.

Definition at line 1196 of file TObject.cxx.

◆ GetElItemName()

const char * TXMLSetup::GetElItemName ( TStreamerElement * el)
protectedinherited

get item name for given element

Definition at line 257 of file TXMLSetup.cxx.

◆ GetEND()

Long64_t TXMLFile::GetEND ( ) const
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 62 of file TXMLFile.h.

◆ GetEndpointUrl() [1/2]

virtual const TUrl * TFile::GetEndpointUrl ( ) const
inlinevirtualinherited

Definition at line 323 of file TFile.h.

◆ GetEndpointUrl() [2/2]

const TUrl * TFile::GetEndpointUrl ( const char * name)
staticinherited

◆ GetErrno()

Int_t TXMLFile::GetErrno ( ) const
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 63 of file TXMLFile.h.

◆ GetFd()

Int_t TFile::GetFd ( ) const
inlineinherited

Definition at line 322 of file TFile.h.

◆ GetFile()

TFile * TDirectoryFile::GetFile ( ) const
inlineoverridevirtualinherited

Reimplemented from TDirectory.

Definition at line 92 of file TDirectoryFile.h.

◆ GetFileBytesRead()

Long64_t TFile::GetFileBytesRead ( )
staticinherited

◆ GetFileBytesWritten()

Long64_t TFile::GetFileBytesWritten ( )
staticinherited

◆ GetFileCounter()

Long64_t TFile::GetFileCounter ( )
staticinherited

◆ GetFileReadCalls()

Int_t TFile::GetFileReadCalls ( )
staticinherited

◆ GetIconName()

const char * TObject::GetIconName ( ) const
virtualinherited

Returns mime type name of object.

Used by the TBrowser (via TGMimeTypes class). Override for class of which you would like to have different icons for objects of the same class.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TASImage, TBranch, TBranchElement, TGeoVolume, TGMainFrame, TKey, TMethodBrowsable, TSystemFile, and TVirtualBranchBrowsable.

Definition at line 472 of file TObject.cxx.

◆ GetIOVersion()

Int_t TXMLFile::GetIOVersion ( ) const
inline

Definition at line 73 of file TXMLFile.h.

◆ GetKey()

TKey * TDirectoryFile::GetKey ( const char * name,
Short_t cycle = 9999 ) const
overridevirtualinherited

Reimplemented from TDirectory.

◆ GetList()

virtual TList * TDirectory::GetList ( ) const
inlinevirtualinherited

Definition at line 223 of file TDirectory.h.

◆ GetListOfFree()

TList * TFile::GetListOfFree ( ) const
inlineinherited

Definition at line 325 of file TFile.h.

◆ GetListOfKeys()

TList * TDirectoryFile::GetListOfKeys ( ) const
inlineoverridevirtualinherited

Reimplemented from TDirectory.

Definition at line 94 of file TDirectoryFile.h.

◆ GetListOfProcessIDs()

TObjArray * TFile::GetListOfProcessIDs ( ) const
inlineinherited

Definition at line 324 of file TFile.h.

◆ GetModificationDate()

const TDatime & TDirectoryFile::GetModificationDate ( ) const
inlineinherited

Definition at line 95 of file TDirectoryFile.h.

◆ GetMother()

TObject * TDirectory::GetMother ( ) const
inlineinherited

Definition at line 225 of file TDirectory.h.

◆ GetMotherDir()

TDirectory * TDirectory::GetMotherDir ( ) const
inlineinherited

Definition at line 226 of file TDirectory.h.

◆ GetName()

const char * TNamed::GetName ( ) const
inlineoverridevirtualinherited

Returns name of object.

This default method returns the class name. Classes that give objects a name should override this method.

Reimplemented from TObject.

Definition at line 49 of file TNamed.h.

◆ GetNbytesFree()

Int_t TXMLFile::GetNbytesFree ( ) const
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 68 of file TXMLFile.h.

◆ GetNbytesInfo()

Int_t TXMLFile::GetNbytesInfo ( ) const
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 67 of file TXMLFile.h.

◆ GetNbytesKeys()

Int_t TDirectoryFile::GetNbytesKeys ( ) const
inlineoverridevirtualinherited

Reimplemented from TDirectory.

Definition at line 96 of file TDirectoryFile.h.

◆ GetNewUrl()

virtual TString TFile::GetNewUrl ( )
inlinevirtualinherited

Reimplemented in TDavixFile, and TNetXNGFile.

Definition at line 338 of file TFile.h.

◆ GetNextRefCounter()

Int_t TXMLSetup::GetNextRefCounter ( )
inlineinherited

Definition at line 111 of file TXMLSetup.h.

◆ GetNfree()

Int_t TXMLFile::GetNfree ( ) const
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 66 of file TXMLFile.h.

◆ GetNkeys()

Int_t TDirectoryFile::GetNkeys ( ) const
inlineoverridevirtualinherited

Reimplemented from TDirectory.

Definition at line 97 of file TDirectoryFile.h.

◆ GetNProcessIDs()

virtual Int_t TFile::GetNProcessIDs ( ) const
inlinevirtualinherited

Definition at line 327 of file TFile.h.

◆ GetObject()

template<class T>
void TDirectory::GetObject ( const char * namecycle,
T *& ptr )
inlineinherited

Get an object with proper type checking.

If the object doesn't exist in the file or if the type doesn't match, a nullptr is returned. Also see TDirectory::Get().

Definition at line 213 of file TDirectory.h.

◆ GetObjectChecked() [1/2]

void * TDirectoryFile::GetObjectChecked ( const char * namecycle,
const char * classname )
overridevirtualinherited

See documentation of TDirectory::GetObjectCheck(const char *namecycle, const TClass *cl).

Reimplemented from TDirectory.

◆ GetObjectChecked() [2/2]

void * TDirectoryFile::GetObjectChecked ( const char * namecycle,
const TClass * expectedClass )
overridevirtualinherited

Return pointer to object identified by namecycle if and only if the actual object is a type suitable to be stored as a pointer to a "expectedClass" If expectedClass is null, no check is performed.

namecycle has the format name;cycle

  • name = * is illegal, cycle = * is illegal
  • cycle = "" or cycle = 9999 ==> apply to a memory object

VERY IMPORTANT NOTE:

The calling application must cast the returned pointer to the type described by the 2 arguments (i.e. cl):

MyClass *obj = (MyClass*)directory->GetObjectChecked("some object of MyClass","MyClass"));

Note: We recommend using the method TDirectory::GetObject:

MyClass *obj = nullptr;
directory->GetObject("some object inheriting from MyClass",obj);
if (obj) { ... we found what we are looking for ... }
static const char * what
Definition stlLoader.cc:5

Reimplemented from TDirectory.

◆ GetObjectInfo()

char * TObject::GetObjectInfo ( Int_t px,
Int_t py ) const
virtualinherited

Returns string containing info about the object at position (px,py).

This method is typically overridden by classes of which the objects can report peculiarities for different positions. Returned string will be re-used (lock in MT environment).

Reimplemented in TASImage, TAxis3D, TColorWheel, TF1, TF2, TFileDrawMap, TGeoNode, TGeoTrack, TGeoVolume, TGL5DDataSet, TGLHistPainter, TGLParametricEquation, TGLTH3Composition, TGraph, TH1, THistPainter, TNode, TPaletteAxis, TParallelCoordVar, and TVirtualHistPainter.

Definition at line 491 of file TObject.cxx.

◆ GetObjectStat()

Bool_t TObject::GetObjectStat ( )
staticinherited

Get status of object stat flag.

Definition at line 1181 of file TObject.cxx.

◆ GetObjectUnchecked()

void * TDirectoryFile::GetObjectUnchecked ( const char * namecycle)
overridevirtualinherited

Return pointer to object identified by namecycle.

The returned object may or may not derive from TObject.

  • namecycle has the format name;cycle
  • name = * is illegal, cycle = * is illegal
  • cycle = "" or cycle = 9999 ==> apply to a memory object

VERY IMPORTANT NOTE:

The calling application must cast the returned object to the final type, e.g.

MyClass *obj = (MyClass*)directory->GetObject("some object of MyClass");

Reimplemented from TDirectory.

◆ GetOnlyStaged()

Bool_t TFile::GetOnlyStaged ( )
staticinherited

◆ GetOpenTimeout()

UInt_t TFile::GetOpenTimeout ( )
staticinherited

◆ GetOption()

Option_t * TFile::GetOption ( ) const
inlineoverridevirtualinherited

Reimplemented from TObject.

Definition at line 328 of file TFile.h.

◆ GetPath()

const char * TDirectory::GetPath ( ) const
virtualinherited

Returns the full path of the directory.

E.g. file:/dir1/dir2. The returned path will be re-used by the next call to GetPath().

Definition at line 1054 of file TDirectory.cxx.

◆ GetPathStatic()

const char * TDirectory::GetPathStatic ( ) const
virtualinherited

Returns the full path of the directory.

E.g. file:/dir1/dir2. The returned path will be re-used by the next call to GetPath().

Definition at line 1016 of file TDirectory.cxx.

◆ GetReadaheadSize()

Int_t TFile::GetReadaheadSize ( )
staticinherited

◆ GetReadCalls()

virtual Int_t TFile::GetReadCalls ( ) const
inlinevirtualinherited

Definition at line 332 of file TFile.h.

◆ GetReadStreamerInfo()

Bool_t TFile::GetReadStreamerInfo ( )
staticinherited

◆ GetRecordHeader()

Int_t TFile::GetRecordHeader ( char * buf,
Long64_t first,
Int_t maxbytes,
Int_t & nbytes,
Int_t & objlen,
Int_t & keylen )
inherited

◆ GetRelOffset()

Long64_t TFile::GetRelOffset ( ) const
inlineinherited

Definition at line 339 of file TFile.h.

◆ GetSeekDir()

Long64_t TDirectoryFile::GetSeekDir ( ) const
inlineoverridevirtualinherited

Reimplemented from TDirectory.

Definition at line 98 of file TDirectoryFile.h.

◆ GetSeekFree()

Long64_t TXMLFile::GetSeekFree ( ) const
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 69 of file TXMLFile.h.

◆ GetSeekInfo()

Long64_t TXMLFile::GetSeekInfo ( ) const
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 70 of file TXMLFile.h.

◆ GetSeekKeys()

Long64_t TDirectoryFile::GetSeekKeys ( ) const
inlineoverridevirtualinherited

Reimplemented from TDirectory.

Definition at line 100 of file TDirectoryFile.h.

◆ GetSeekParent()

Long64_t TDirectoryFile::GetSeekParent ( ) const
inlineoverridevirtualinherited

Reimplemented from TDirectory.

Definition at line 99 of file TDirectoryFile.h.

◆ GetSetupAsString()

TString TXMLSetup::GetSetupAsString ( )
inherited

return setup values as string

Definition at line 148 of file TXMLSetup.cxx.

◆ GetSharedLocalCurrentDirectory()

TDirectory::SharedGDirectory_t & TDirectory::GetSharedLocalCurrentDirectory ( )
staticprotectedinherited

Return the (address of) a shared pointer to the struct holding the actual thread local gDirectory pointer and the atomic_flag for its lock.

Definition at line 422 of file TDirectory.cxx.

◆ GetSize()

Long64_t TXMLFile::GetSize ( ) const
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 71 of file TXMLFile.h.

◆ GetStreamerInfoCache()

const TList * TFile::GetStreamerInfoCache ( )
inherited

◆ GetStreamerInfoList()

virtual TList * TFile::GetStreamerInfoList ( )
finalvirtualinherited

◆ GetStreamerInfoListImpl()

TFile::InfoListRet TXMLFile::GetStreamerInfoListImpl ( bool lookupSICache)
finalprotectedvirtual

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 714 of file TXMLFile.cxx.

◆ GetTitle()

const char * TNamed::GetTitle ( ) const
inlineoverridevirtualinherited

Returns title of object.

This default method returns the class title (i.e. description). Classes that give objects a title should override this method.

Reimplemented from TObject.

Definition at line 50 of file TNamed.h.

◆ GetType()

EFileType TFile::GetType ( const char * name,
Option_t * option = "",
TString * prefix = nullptr )
staticinherited

◆ GetUniqueID()

UInt_t TObject::GetUniqueID ( ) const
virtualinherited

Return the unique object id.

Definition at line 480 of file TObject.cxx.

◆ GetUUID()

TUUID TDirectory::GetUUID ( ) const
inlineinherited

Definition at line 234 of file TDirectory.h.

◆ GetVersion()

Int_t TFile::GetVersion ( ) const
inlineinherited

Definition at line 333 of file TFile.h.

◆ GetXmlLayout()

EXMLLayout TXMLSetup::GetXmlLayout ( ) const
inlineinherited

Definition at line 97 of file TXMLSetup.h.

◆ HandleTimer()

Bool_t TObject::HandleTimer ( TTimer * timer)
virtualinherited

Execute action in response of a timer timing out.

This method must be overridden if an object has to react to timers.

Reimplemented in TGCommandPlugin, TGDNDManager, TGFileContainer, TGHtml, TGLEventHandler, TGPopupMenu, TGraphTime, TGScrollBar, TGShutter, TGTextEdit, TGTextEditor, TGTextEntry, TGTextView, TGToolTip, TGuiBldDragManager, TGWindow, and TTreeViewer.

Definition at line 516 of file TObject.cxx.

◆ Hash()

ULong_t TNamed::Hash ( ) const
inlineoverridevirtualinherited

Return hash value for this object.

Note: If this routine is overloaded in a derived class, this derived class should also add

void CallRecursiveRemoveIfNeeded(TObject &obj)
call RecursiveRemove for obj if gROOT is valid and obj.TestBit(kMustCleanup) is true.
Definition TROOT.h:406

Otherwise, when RecursiveRemove is called (by ~TObject or example) for this type of object, the transversal of THashList and THashTable containers will will have to be done without call Hash (and hence be linear rather than logarithmic complexity). You will also see warnings like

Error in <ROOT::Internal::TCheckHashRecursiveRemoveConsistency::CheckRecursiveRemove>: The class SomeName overrides
TObject::Hash but does not call TROOT::RecursiveRemove in its destructor.
Error("WriteTObject","The current directory (%s) is not associated with a file. The object (%s) has not been written.", GetName(), objname)
ULong_t Hash() const override
Return hash value for this object.
Definition TNamed.h:51
void RecursiveRemove(TObject *obj) override
Recursively remove this object from the list of Cleanups.
Definition TROOT.cxx:2651

Reimplemented from TObject.

Definition at line 51 of file TNamed.h.

◆ HasInconsistentHash()

Bool_t TObject::HasInconsistentHash ( ) const
inlineinherited

Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

missing call to RecursiveRemove in destructor).

Note: Since the consistency is only tested for during inserts, this routine will return true for object that have never been inserted whether or not they have a consistent setup. This has no negative side-effect as searching for the object with the right or wrong Hash will always yield a not-found answer (Since anyway no hash can be guaranteed unique, there is always a check)

Definition at line 366 of file TObject.h.

◆ IncrementFileCounter()

void TFile::IncrementFileCounter ( )
staticinherited

◆ IncrementProcessIDs()

virtual void TFile::IncrementProcessIDs ( )
inlinevirtualinherited

Definition at line 345 of file TFile.h.

◆ Info()

void TObject::Info ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue info message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1072 of file TObject.cxx.

◆ InheritsFrom() [1/2]

Bool_t TObject::InheritsFrom ( const char * classname) const
virtualinherited

Returns kTRUE if object inherits from class "classname".

Reimplemented in TClass.

Definition at line 549 of file TObject.cxx.

◆ InheritsFrom() [2/2]

Bool_t TObject::InheritsFrom ( const TClass * cl) const
virtualinherited

Returns kTRUE if object inherits from TClass cl.

Reimplemented in TClass.

Definition at line 557 of file TObject.cxx.

◆ Init()

virtual void TFile::Init ( Bool_t create)
protectedvirtualinherited

Reimplemented in TDavixFile, and TNetXNGFile.

◆ InitDirectoryFile()

void TDirectoryFile::InitDirectoryFile ( TClass * cl = nullptr)
protectedinherited

◆ InitXmlFile()

void TXMLFile::InitXmlFile ( Bool_t create)
protected

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

Definition at line 261 of file TXMLFile.cxx.

◆ Inspect()

void TObject::Inspect ( ) const
virtualinherited

Dump contents of this object in a graphics canvas.

Same action as Dump but in a graphical form. In addition pointers to other objects can be followed.

The following picture is the Inspect of a histogram object:

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TGFrame, TInspectorObject, and TSystemFile.

Definition at line 570 of file TObject.cxx.

◆ InvertBit()

void TObject::InvertBit ( UInt_t f)
inlineinherited

Definition at line 206 of file TObject.h.

◆ IsA()

TClass * TXMLFile::IsA ( ) const
inlineoverridevirtual
Returns
TClass describing current object

Reimplemented from TFile.

Definition at line 140 of file TXMLFile.h.

◆ IsArchive()

virtual Bool_t TFile::IsArchive ( ) const
inlinevirtualinherited

Definition at line 346 of file TFile.h.

◆ IsBinary()

Bool_t TFile::IsBinary ( ) const
inlineinherited

Definition at line 347 of file TFile.h.

◆ IsBuilt()

Bool_t TDirectory::IsBuilt ( ) const
inlineinherited

Definition at line 235 of file TDirectory.h.

◆ IsDestructed()

Bool_t TObject::IsDestructed ( ) const
inlineinherited

IsDestructed.

Note
This function must be non-virtual as it can be used on destructed (but not yet modified) memory. This is used for example in TClonesArray to record the element that have been destructed but not deleted and thus are ready for re-use (by operator new with placement).
Returns
true if this object's destructor has been run.

Definition at line 186 of file TObject.h.

◆ IsEqual()

Bool_t TObject::IsEqual ( const TObject * obj) const
virtualinherited

Default equal comparison (objects are equal if they have the same address in memory).

More complicated classes might want to override this function.

Reimplemented in TGObject, TObjString, TPair, and TQCommand.

Definition at line 589 of file TObject.cxx.

◆ IsFolder()

Bool_t TDirectory::IsFolder ( ) const
inlineoverridevirtualinherited

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

Reimplemented from TObject.

Reimplemented in TROOT.

Definition at line 236 of file TDirectory.h.

◆ IsModified()

Bool_t TDirectoryFile::IsModified ( ) const
inlineoverridevirtualinherited

Reimplemented from TDirectory.

Definition at line 101 of file TDirectoryFile.h.

◆ IsOnHeap()

Bool_t TObject::IsOnHeap ( ) const
inlineinherited

Definition at line 160 of file TObject.h.

◆ IsOpen()

Bool_t TXMLFile::IsOpen ( ) const
finalvirtual

return kTRUE if file is opened and can be accessed

Reimplemented from TFile.

Definition at line 362 of file TXMLFile.cxx.

◆ IsRaw()

Bool_t TFile::IsRaw ( ) const
inlineinherited

Definition at line 348 of file TFile.h.

◆ IsSortable()

Bool_t TNamed::IsSortable ( ) const
inlineoverridevirtualinherited

Reimplemented from TObject.

Reimplemented in TStructNodeProperty.

Definition at line 52 of file TNamed.h.

◆ IsStoreStreamerInfos()

Bool_t TXMLSetup::IsStoreStreamerInfos ( ) const
inlineinherited

Definition at line 98 of file TXMLSetup.h.

◆ IsUseDtd()

Bool_t TXMLSetup::IsUseDtd ( ) const
inlineinherited

Definition at line 99 of file TXMLSetup.h.

◆ IsUseNamespaces()

Bool_t TXMLSetup::IsUseNamespaces ( ) const
inlineinherited

Definition at line 100 of file TXMLSetup.h.

◆ IsValidXmlSetup()

Bool_t TXMLSetup::IsValidXmlSetup ( const char * setupstr)
protectedinherited

checks if string is valid setup

Definition at line 163 of file TXMLSetup.cxx.

◆ IsWritable()

Bool_t TDirectoryFile::IsWritable ( ) const
inlineoverridevirtualinherited

Reimplemented from TDirectory.

Definition at line 102 of file TDirectoryFile.h.

◆ IsZombie()

Bool_t TObject::IsZombie ( ) const
inlineinherited

Definition at line 161 of file TObject.h.

◆ ls()

void TFile::ls ( Option_t * option = "") const
overridevirtualinherited

List Directory contents.

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

The option can has the following format:

 [<regexp>]

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

Reimplemented from TDirectoryFile.

◆ MakeFree()

void TXMLFile::MakeFree ( Long64_t ,
Long64_t  )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 77 of file TXMLFile.h.

◆ MakeProject()

void TXMLFile::MakeProject ( const char * ,
const char * = "*",
Option_t * = "new" )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 78 of file TXMLFile.h.

◆ MakeZombie()

void TObject::MakeZombie ( )
inlineprotectedinherited

Definition at line 55 of file TObject.h.

◆ Map() [1/2]

void TXMLFile::Map ( )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 80 of file TXMLFile.h.

◆ Map() [2/2]

void TXMLFile::Map ( Option_t * )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 79 of file TXMLFile.h.

◆ Matches()

virtual Bool_t TFile::Matches ( const char * name)
virtualinherited

◆ MayNotUse()

void TObject::MayNotUse ( const char * method) const
inherited

Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

Definition at line 1160 of file TObject.cxx.

◆ mkdir()

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

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

Parameters
namethe name or hierarchy of the subdirectory ("a" or "a/b/c")
titlethe title
returnExistingDirectoryif key-name is already existing, the returned value points to preexisting sub-directory if true and to nullptr if false.
Returns
a pointer to the created sub-directory, not to the top sub-directory of the hierarchy (in the above example, the returned TDirectory * points to "c"). In case of an error, it returns nullptr. In case of a preexisting sub-directory (hierarchy) with the requested name, the return value depends on the parameter returnExistingDirectory.

In particular, the steps to create first a/b/c and then a/b/d without receiving errors are:

TFile * file = new TFile("afile","RECREATE");
file->mkdir("a");
file->cd("a");
gDirectory->mkdir("b/c");
gDirectory->cd("b");
gDirectory->mkdir("d");
#define gDirectory
Definition TDirectory.h:385
Bool_t cd() override
Change current directory to "this" directory.
TDirectory * mkdir(const char *name, const char *title="", Bool_t returnExistingDirectory=kFALSE) override
Create a sub-directory "a" or a hierarchy of sub-directories "a/b/c/...".
TFile(const TFile &)=delete

or

TFile * file = new TFile("afile","RECREATE");
file->mkdir("a");
file->cd("a");
gDirectory->mkdir("b/c");
gDirectory->mkdir("b/d", "", true);

Reimplemented from TDirectory.

◆ MustFlush()

virtual Bool_t TFile::MustFlush ( ) const
inlinevirtualinherited

Definition at line 361 of file TFile.h.

◆ Notify()

Bool_t TObject::Notify ( )
virtualinherited

This method must be overridden to handle object notification (the base implementation is no-op).

Different objects in ROOT use the Notify method for different purposes, in coordination with other objects that call this method at the appropriate time.

For example, TLeaf uses it to load class information; TBranchRef to load contents of referenced branches TBranchRef; most notably, based on Notify, TChain implements a callback mechanism to inform interested parties when it switches to a new sub-tree.

Reimplemented in h1analysis, h1analysisTreeReader, TARInterruptHandler, TASInputHandler, TASInterruptHandler, TASLogHandler, TASSigPipeHandler, TBlinkTimer, TBranchElement, TBranchRef, TBreakLineCom, TBrowserTimer, TCollection, TDelCharCom, TDelTextCom, TFileHandler, TGContainerKeyboardTimer, TGContainerScrollTimer, TGInputHandler, TGLRedrawTimer, TGTextEditHist, TGuiBldDragManagerRepeatTimer, TIdleTimer, TInsCharCom, TInsTextCom, TInterruptHandler, TLeafObject, TMessageHandler, TNotifyLink< Type >, TNotifyLink< RNoCleanupNotifierHelper >, TNotifyLink< ROOT::Detail::TBranchProxy >, TNotifyLink< TTreeReader >, TPopupDelayTimer, TProcessEventTimer, TRefTable, TRepeatTimer, TSBRepeatTimer, TSelector, TSelectorDraw, TSelectorEntries, TSignalHandler, TSingleShotCleaner, TSocketHandler, TStdExceptionHandler, TSysEvtHandler, TTermInputHandler, TThreadTimer, TTimeOutTimer, TTimer, TTipDelayTimer, TTree, TTreeFormula, TTreeFormulaManager, TTreeReader, TViewTimer, and TViewUpdateTimer.

Definition at line 618 of file TObject.cxx.

◆ Obsolete()

void TObject::Obsolete ( const char * method,
const char * asOfVers,
const char * removedFromVers ) const
inherited

Use this method to declare a method obsolete.

Specify as of which version the method is obsolete and as from which version it will be removed.

Definition at line 1169 of file TObject.cxx.

◆ Open() [1/2]

TFile * TFile::Open ( const char * name,
Option_t * option = "",
const char * ftitle = "",
Int_t compress = ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault,
Int_t netopt = 0 )
staticinherited

◆ Open() [2/2]

TFile * TFile::Open ( TFileOpenHandle * handle)
staticinherited

◆ OpenFile()

TFile * TDirectoryFile::OpenFile ( const char * name,
Option_t * option = "",
const char * ftitle = "",
Int_t compress = ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault,
Int_t netopt = 0 )
overridevirtualinherited

Reimplemented from TDirectory.

◆ OpenFromCache()

TFile * TFile::OpenFromCache ( const char * name,
Option_t * = "",
const char * ftitle = "",
Int_t compress = ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault,
Int_t netopt = 0 )
staticprivateinherited

◆ operator delete() [1/3]

void TObject::operator delete ( void * ptr,
size_t size )
inherited

Operator delete for sized deallocation.

Definition at line 1234 of file TObject.cxx.

◆ operator delete() [2/3]

void TObject::operator delete ( void * ptr)
inherited

Operator delete.

Definition at line 1212 of file TObject.cxx.

◆ operator delete() [3/3]

void TObject::operator delete ( void * ptr,
void * vp )
inherited

Only called by placement new when throwing an exception.

Definition at line 1266 of file TObject.cxx.

◆ operator delete[]() [1/3]

void TObject::operator delete[] ( void * ptr,
size_t size )
inherited

Operator delete [] for sized deallocation.

Definition at line 1245 of file TObject.cxx.

◆ operator delete[]() [2/3]

void TObject::operator delete[] ( void * ptr)
inherited

Operator delete [].

Definition at line 1223 of file TObject.cxx.

◆ operator delete[]() [3/3]

void TObject::operator delete[] ( void * ptr,
void * vp )
inherited

Only called by placement new[] when throwing an exception.

Definition at line 1274 of file TObject.cxx.

◆ operator new() [1/2]

void * TObject::operator new ( size_t sz)
inlineinherited

Definition at line 189 of file TObject.h.

◆ operator new() [2/2]

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

Definition at line 191 of file TObject.h.

◆ operator new[]() [1/2]

void * TObject::operator new[] ( size_t sz)
inlineinherited

Definition at line 190 of file TObject.h.

◆ operator new[]() [2/2]

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

Definition at line 192 of file TObject.h.

◆ operator=()

void TXMLFile::operator= ( const TXMLFile & )
privatedelete

◆ Paint()

void TXMLFile::Paint ( Option_t * option = "")
inlinefinalvirtual

Paint all objects in the directory.

Reimplemented from TFile.

Definition at line 81 of file TXMLFile.h.

◆ Pop()

void TObject::Pop ( )
virtualinherited

Pop on object drawn in a pad to the top of the display list.

I.e. it will be drawn last and on top of all other primitives.

Reimplemented in TFrame, TPad, and TVirtualPad.

Definition at line 640 of file TObject.cxx.

◆ Print()

void TXMLFile::Print ( Option_t * option = "") const
inlinefinalvirtual

Print all objects in the directory.

Reimplemented from TFile.

Definition at line 82 of file TXMLFile.h.

◆ PrintSetup()

void TXMLSetup::PrintSetup ( )
inherited

show setup values

Definition at line 199 of file TXMLSetup.cxx.

◆ ProduceFileNames()

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

function produces pair of xml and dtd file names

Definition at line 423 of file TXMLFile.cxx.

◆ Purge()

void TDirectoryFile::Purge ( Short_t nkeep = 1)
overridevirtualinherited

Reimplemented from TDirectory.

◆ pwd()

void TDirectory::pwd ( ) const
virtualinherited

Print the path of the directory.

Definition at line 1205 of file TDirectory.cxx.

◆ Read()

Int_t TObject::Read ( const char * name)
virtualinherited

Read contents of object with specified name from the current directory.

First the key with the given name is searched in the current directory, next the key buffer is deserialized into the object. The object must have been created before via the default constructor. See TObject::Write().

Reimplemented in TBuffer, TKey, TKeySQL, and TKeyXML.

Definition at line 673 of file TObject.cxx.

◆ ReadAll()

void TDirectoryFile::ReadAll ( Option_t * option = "")
overridevirtualinherited

Reimplemented from TDirectory.

◆ ReadBuffer() [1/2]

Bool_t TXMLFile::ReadBuffer ( char * ,
Int_t  )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 83 of file TXMLFile.h.

◆ ReadBuffer() [2/2]

Bool_t TXMLFile::ReadBuffer ( char * ,
Long64_t ,
Int_t  )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 84 of file TXMLFile.h.

◆ ReadBufferAsync()

virtual Bool_t TFile::ReadBufferAsync ( Long64_t offs,
Int_t len )
virtualinherited

Reimplemented in TDavixFile.

◆ ReadBuffers()

virtual Bool_t TFile::ReadBuffers ( char * buf,
Long64_t * pos,
Int_t * len,
Int_t nbuf )
virtualinherited

Reimplemented in TDavixFile, TDCacheFile, and TNetXNGFile.

◆ ReadBufferViaCache()

Int_t TFile::ReadBufferViaCache ( char * buf,
Int_t len )
protectedinherited

◆ ReadFree()

void TXMLFile::ReadFree ( )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 85 of file TXMLFile.h.

◆ ReadFromFile()

Bool_t TXMLFile::ReadFromFile ( )
protected

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

Definition at line 558 of file TXMLFile.cxx.

◆ ReadKeys()

Int_t TDirectoryFile::ReadKeys ( Bool_t forceRead = kTRUE)
overridevirtualinherited

Reimplemented from TDirectory.

◆ ReadKeysList()

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

Read list of keys for directory.

Definition at line 629 of file TXMLFile.cxx.

◆ ReadProcessID()

virtual TProcessID * TFile::ReadProcessID ( UShort_t pidf)
virtualinherited

◆ ReadSetupFromStr()

Bool_t TXMLSetup::ReadSetupFromStr ( const char * setupstr)
protectedinherited

get values from string

Definition at line 180 of file TXMLSetup.cxx.

◆ ReadStreamerElement()

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

read and reconstruct single TStreamerElement from xml node

Definition at line 824 of file TXMLFile.cxx.

◆ ReadStreamerInfo()

virtual void TFile::ReadStreamerInfo ( )
virtualinherited

◆ ReadTObject()

Int_t TDirectoryFile::ReadTObject ( TObject * obj,
const char * keyname )
overridevirtualinherited

Reimplemented from TDirectory.

◆ Recover()

Int_t TXMLFile::Recover ( )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 86 of file TXMLFile.h.

◆ RecursiveRemove()

void TDirectory::RecursiveRemove ( TObject * obj)
overridevirtualinherited

Recursively remove object from a Directory.

Reimplemented from TObject.

Reimplemented in TROOT.

Definition at line 1213 of file TDirectory.cxx.

◆ RegisterContext()

void TDirectory::RegisterContext ( TContext * ctxt)
protectedinherited

◆ RegisterGDirectory()

void TDirectory::RegisterGDirectory ( SharedGDirectory_t & ptr)
protectedinherited

◆ Remove()

TObject * TDirectory::Remove ( TObject * obj)
virtualinherited

Remove an object from the in-memory list.

Reimplemented in TROOT.

Definition at line 1222 of file TDirectory.cxx.

◆ ReOpen()

Int_t TXMLFile::ReOpen ( Option_t * mode)
finalvirtual

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

Reimplemented from TFile.

Definition at line 371 of file TXMLFile.cxx.

◆ ResetAfterMerge()

virtual void TDirectoryFile::ResetAfterMerge ( TFileMergeInfo * )
virtualinherited

Reimplemented in TMemFile.

◆ ResetBit()

void TObject::ResetBit ( UInt_t f)
inlineinherited

Definition at line 203 of file TObject.h.

◆ ResetErrno()

void TXMLFile::ResetErrno ( ) const
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 64 of file TXMLFile.h.

◆ rmdir()

void TDirectoryFile::rmdir ( const char * name)
overridevirtualinherited

Removes subdirectory from the directory When directory is deleted, all keys in all subdirectories will be read first and deleted from file (if exists) Equivalent call is Delete("name;*");.

Reimplemented from TDirectory.

◆ Save()

void TDirectoryFile::Save ( )
overridevirtualinherited

Reimplemented from TDirectory.

◆ SaveAs()

void TObject::SaveAs ( const char * filename = "",
Option_t * option = "" ) const
virtualinherited

Save this object in the file specified by filename.

  • if "filename" contains ".root" the object is saved in filename as root binary file.
  • if "filename" contains ".xml" the object is saved in filename as a xml ascii file.
  • if "filename" contains ".cc" the object is saved in filename as C code independent from ROOT. The code is generated via SavePrimitive(). Specific code should be implemented in each object to handle this option. Like in TF1::SavePrimitive().
  • otherwise the object is written to filename as a CINT/C++ script. The C++ code to rebuild this object is generated via SavePrimitive(). The "option" parameter is passed to SavePrimitive. By default it is an empty string. It can be used to specify the Draw option in the code generated by SavePrimitive.

    The function is available via the object context menu.

Reimplemented in ROOT::Experimental::XRooFit::xRooNode, TClassTree, TFolder, TGeoVolume, TGObject, TGraph, TH1, TPad, TPaveClass, TSpline3, TSpline5, TSpline, TTreePerfStats, and TVirtualPad.

Definition at line 708 of file TObject.cxx.

◆ SaveObjectAs()

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

Save object in filename, if filename is nullptr or "", a file with "<objectname>.root" is created.

The name of the key is the object name. By default new file will be created. Using option "a", one can append object to the existing ROOT file. If the operation is successful, it returns the number of bytes written to the file otherwise it returns 0. By default a message is printed. Use option "q" to not print the message. If filename contains ".json" extension, JSON representation of the object will be created and saved in the text file. Such file can be used in JavaScript ROOT (https://root.cern/js/) to display object in web browser When creating JSON file, option string may contain compression level from 0 to 3 (default 0)

Reimplemented from TDirectory.

◆ SavePrimitive()

void TObject::SavePrimitive ( std::ostream & out,
Option_t * option = "" )
virtualinherited

Save a primitive as a C++ statement(s) on output stream "out".

Reimplemented in TAnnotation, TArc, TArrow, TASImage, TAxis3D, TBox, TButton, TCanvas, TChain, TCrown, TCurlyArc, TCurlyLine, TCutG, TDiamond, TEfficiency, TEllipse, TExec, TF12, TF1, TF2, TF3, TFrame, TGaxis, TGButton, TGButtonGroup, TGCanvas, TGCheckButton, TGColorSelect, TGColumnLayout, TGComboBox, TGCompositeFrame, TGContainer, TGDockableFrame, TGDoubleHSlider, TGDoubleVSlider, TGedMarkerSelect, TGedPatternSelect, TGeoArb8, TGeoBBox, TGeoBoolNode, TGeoCombiTrans, TGeoCompositeShape, TGeoCone, TGeoConeSeg, TGeoCtub, TGeoDecayChannel, TGeoElementRN, TGeoEltu, TGeoGtra, TGeoHalfSpace, TGeoHMatrix, TGeoHype, TGeoIdentity, TGeoIntersection, TGeoMaterial, TGeoMedium, TGeoMixture, TGeoPara, TGeoParaboloid, TGeoPatternCylPhi, TGeoPatternCylR, TGeoPatternParaX, TGeoPatternParaY, TGeoPatternParaZ, TGeoPatternSphPhi, TGeoPatternSphR, TGeoPatternSphTheta, TGeoPatternTrapZ, TGeoPatternX, TGeoPatternY, TGeoPatternZ, TGeoPcon, TGeoPgon, TGeoRotation, TGeoScaledShape, TGeoShapeAssembly, TGeoSphere, TGeoSubtraction, TGeoTessellated, TGeoTorus, TGeoTranslation, TGeoTrap, TGeoTrd1, TGeoTrd2, TGeoTube, TGeoTubeSeg, TGeoUnion, TGeoVolume, TGeoXtru, TGFileContainer, TGFont, TGFrame, TGFSComboBox, TGGC, TGGroupFrame, TGHButtonGroup, TGHorizontal3DLine, TGHorizontalFrame, TGHorizontalLayout, TGHProgressBar, TGHScrollBar, TGHSlider, TGHSplitter, TGHtml, TGIcon, TGLabel, TGLayoutHints, TGLineStyleComboBox, TGLineWidthComboBox, TGListBox, TGListDetailsLayout, TGListLayout, TGListTree, TGListView, TGLVContainer, TGMainFrame, TGMatrixLayout, TGMdiFrame, TGMdiMainFrame, TGMdiMenuBar, TGMenuBar, TGMenuTitle, TGNumberEntry, TGNumberEntryField, TGPictureButton, TGPopupMenu, TGProgressBar, TGRadioButton, TGraph2D, TGraph2DAsymmErrors, TGraph2DErrors, TGraph, TGraphAsymmErrors, TGraphBentErrors, TGraphEdge, TGraphErrors, TGraphMultiErrors, TGraphNode, TGraphPolar, TGraphPolargram, TGraphStruct, TGroupButton, TGRowLayout, TGShapedFrame, TGShutter, TGShutterItem, TGSplitFrame, TGStatusBar, TGTab, TGTabLayout, TGTableLayout, TGTableLayoutHints, TGTextButton, TGTextEdit, TGTextEntry, TGTextLBEntry, TGTextView, TGTileLayout, TGToolBar, TGTransientFrame, TGTripleHSlider, TGTripleVSlider, TGVButtonGroup, TGVertical3DLine, TGVerticalFrame, TGVerticalLayout, TGVFileSplitter, TGVProgressBar, TGVScrollBar, TGVSlider, TGVSplitter, TGXYLayout, TGXYLayoutHints, TH1, TH2Poly, THelix, THStack, TLatex, TLegend, TLine, TMacro, TMarker3DBox, TMarker, TMathText, TMultiGraph, TPad, TPaletteAxis, TParallelCoord, TParallelCoordVar, TPave, TPaveClass, TPaveLabel, TPaveStats, TPavesText, TPaveText, TPie, TPieSlice, TPolyLine3D, TPolyLine, TPolyMarker3D, TPolyMarker, TProfile2D, TProfile3D, TProfile, TRootContainer, TRootEmbeddedCanvas, TScatter2D, TScatter, TSlider, TSliderBox, TSpline3, TSpline5, TStyle, TText, TTreePerfStats, and TWbox.

Definition at line 858 of file TObject.cxx.

◆ SavePrimitiveConstructor()

void TObject::SavePrimitiveConstructor ( std::ostream & out,
TClass * cl,
const char * variable_name,
const char * constructor_agrs = "",
Bool_t empty_line = kTRUE )
staticprotectedinherited

Save object constructor in the output stream "out".

Can be used as first statement when implementing SavePrimitive() method for the object

Definition at line 777 of file TObject.cxx.

◆ SavePrimitiveDraw()

void TObject::SavePrimitiveDraw ( std::ostream & out,
const char * variable_name,
Option_t * option = nullptr )
staticprotectedinherited

Save invocation of primitive Draw() method Skipped if option contains "nodraw" string.

Definition at line 845 of file TObject.cxx.

◆ SavePrimitiveNameTitle()

void TNamed::SavePrimitiveNameTitle ( std::ostream & out,
const char * variable_name )
protectedinherited

Save object name and title into the output stream "out".

Definition at line 135 of file TNamed.cxx.

◆ SavePrimitiveVector()

TString TObject::SavePrimitiveVector ( std::ostream & out,
const char * prefix,
Int_t len,
Double_t * arr,
Int_t flag = 0 )
staticprotectedinherited

Save array in the output stream "out" as vector.

Create unique variable name based on prefix value Returns name of vector which can be used in constructor or in other places of C++ code If flag === kTRUE, just add empty line If flag === 111, check if array is empty and return nullptr or <vectorname>.data()

Definition at line 796 of file TObject.cxx.

◆ SaveSelf()

void TDirectoryFile::SaveSelf ( Bool_t force = kFALSE)
overridevirtualinherited

Reimplemented from TDirectory.

◆ SaveToFile()

void TXMLFile::SaveToFile ( )
protected

Saves xml structures to the file xml elements are kept in list of TKeyXML objects When saving, all this elements are linked to root xml node At 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 release memory, used by xml structures

Definition at line 453 of file TXMLFile.cxx.

◆ Seek()

void TXMLFile::Seek ( Long64_t ,
ERelativeTo = kBeg )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 88 of file TXMLFile.h.

◆ SetBit() [1/2]

void TObject::SetBit ( UInt_t f)
inlineinherited

Definition at line 202 of file TObject.h.

◆ SetBit() [2/2]

void TObject::SetBit ( UInt_t f,
Bool_t set )
inherited

Set or unset the user status bits as specified in f.

Definition at line 888 of file TObject.cxx.

◆ SetBufferSize()

void TDirectoryFile::SetBufferSize ( Int_t bufsize)
overridevirtualinherited

Reimplemented from TDirectory.

◆ SetCacheFileDir()

Bool_t TFile::SetCacheFileDir ( std::string_view cacheDir,
Bool_t operateDisconnected = kTRUE,
Bool_t forceCacheread = kFALSE )
staticinherited

◆ SetCacheRead()

virtual void TFile::SetCacheRead ( TFileCacheRead * cache,
TObject * tree = nullptr,
ECacheAction action = kDisconnect )
virtualinherited

◆ SetCacheWrite()

virtual void TFile::SetCacheWrite ( TFileCacheWrite * cache)
virtualinherited

◆ SetCompressionAlgorithm()

virtual void TFile::SetCompressionAlgorithm ( Int_t algorithm = ROOT::RCompressionSetting::EAlgorithm::kUseGlobal)
virtualinherited

◆ SetCompressionLevel()

virtual void TFile::SetCompressionLevel ( Int_t level = ROOT::RCompressionSetting::ELevel::kUseMin)
virtualinherited

◆ SetCompressionSettings()

virtual void TFile::SetCompressionSettings ( Int_t settings = ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault)
virtualinherited

◆ SetDrawOption()

void TObject::SetDrawOption ( Option_t * option = "")
virtualinherited

Set drawing option for object.

This option only affects the drawing style and is stored in the option field of the TObjOptLink supporting a TPad's primitive list (TList). Note that it does not make sense to call object.SetDrawOption(option) before having called object.Draw().

Reimplemented in RooPlot, TAxis, TBrowser, TGedFrame, TGFrame, TPad, TPaveStats, TRootBrowserLite, TSystemDirectory, and TSystemFile.

Definition at line 871 of file TObject.cxx.

◆ SetDtorOnly()

void TObject::SetDtorOnly ( void * obj)
staticinherited

Set destructor only flag.

Definition at line 1204 of file TObject.cxx.

◆ SetEND()

void TXMLFile::SetEND ( Long64_t )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 90 of file TXMLFile.h.

◆ SetFileBytesRead()

void TFile::SetFileBytesRead ( Long64_t bytes = 0)
staticinherited

◆ SetFileBytesWritten()

void TFile::SetFileBytesWritten ( Long64_t bytes = 0)
staticinherited

◆ SetFileReadCalls()

void TFile::SetFileReadCalls ( Int_t readcalls = 0)
staticinherited

◆ SetModified()

void TDirectoryFile::SetModified ( )
inlineoverridevirtualinherited

Reimplemented from TDirectory.

Definition at line 118 of file TDirectoryFile.h.

◆ SetMother()

virtual void TDirectory::SetMother ( TObject * mother)
inlinevirtualinherited

Definition at line 259 of file TDirectory.h.

◆ SetName()

void TDirectory::SetName ( const char * newname)
overridevirtualinherited

Set the name for directory If the directory name is changed after the directory was written once, ROOT currently would NOT change the name of correspondent key in the mother directory.

DO NOT use this method to 'rename a directory'. Renaming a directory is currently NOT supported.

Reimplemented from TNamed.

Definition at line 1297 of file TDirectory.cxx.

◆ SetNameSpaceBase()

void TXMLSetup::SetNameSpaceBase ( const char * namespacebase)
staticinherited

set namespace base

Definition at line 111 of file TXMLSetup.cxx.

◆ SetNameTitle()

void TNamed::SetNameTitle ( const char * name,
const char * title )
virtualinherited

Set all the TNamed parameters (name and title).

WARNING: if the name is changed and the object is a member of a THashTable or THashList container the container must be Rehash()'ed after SetName(). For example the list of objects in the current directory is a THashList.

Reimplemented in RooAbsArg, RooAbsData, RooDataHist, RooDataSet, RooFitResult, RooPlot, TContextMenu, TGraph2D, TGraph, TH1, and TNode.

Definition at line 163 of file TNamed.cxx.

◆ SetObjectStat()

void TObject::SetObjectStat ( Bool_t stat)
staticinherited

Turn on/off tracking of objects in the TObjectTable.

Definition at line 1188 of file TObject.cxx.

◆ SetOffset()

virtual void TFile::SetOffset ( Long64_t offset,
ERelativeTo pos = kBeg )
virtualinherited

◆ SetOnlyStaged()

Bool_t TFile::SetOnlyStaged ( Bool_t onlystaged)
staticinherited

◆ SetOpenTimeout()

UInt_t TFile::SetOpenTimeout ( UInt_t timeout)
staticinherited

◆ SetOption()

virtual void TFile::SetOption ( Option_t * option = ">")
inlinevirtualinherited

Definition at line 381 of file TFile.h.

◆ SetReadaheadSize()

void TFile::SetReadaheadSize ( Int_t bufsize = 256000)
staticinherited

◆ SetReadCalls()

virtual void TFile::SetReadCalls ( Int_t readcalls = 0)
inlinevirtualinherited

Definition at line 382 of file TFile.h.

◆ SetReadStreamerInfo()

void TFile::SetReadStreamerInfo ( Bool_t readinfo = kTRUE)
staticinherited

◆ SetSeekDir()

void TDirectoryFile::SetSeekDir ( Long64_t v)
inlineoverridevirtualinherited

Reimplemented from TDirectory.

Definition at line 119 of file TDirectoryFile.h.

◆ SetStoreStreamerInfos()

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

If true, all correspondent to file TStreamerInfo objects will be stored in file this allows to apply schema evolution later for this file may be useful, 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 922 of file TXMLFile.cxx.

◆ SetTitle()

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

◆ SetTRefAction()

void TDirectoryFile::SetTRefAction ( TObject * ref,
TObject * parent )
overridevirtualinherited

Reimplemented from TDirectory.

◆ SetUniqueID()

void TObject::SetUniqueID ( UInt_t uid)
virtualinherited

Set the unique object id.

Definition at line 899 of file TObject.cxx.

◆ SetUsedDtd()

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

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 933 of file TXMLFile.cxx.

◆ SetUseNamespaces()

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

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

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 952 of file TXMLFile.cxx.

◆ SetWritable()

void TDirectoryFile::SetWritable ( Bool_t writable = kTRUE)
overridevirtualinherited

Reimplemented from TDirectory.

◆ SetXmlLayout()

void TXMLFile::SetXmlLayout ( EXMLLayout layout)
finalvirtual

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 910 of file TXMLFile.cxx.

◆ ShowStreamerInfo()

virtual void TFile::ShowStreamerInfo ( )
virtualinherited

◆ ShrinkCacheFileDir()

Bool_t TFile::ShrinkCacheFileDir ( Long64_t shrinkSize,
Long_t cleanupInteval = 0 )
staticinherited

◆ Sizeof()

Int_t TXMLFile::Sizeof ( ) const
inlinefinalvirtual

Return size of the TNamed part of the TObject.

Reimplemented from TFile.

Definition at line 91 of file TXMLFile.h.

◆ StoreStreamerElement()

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

store data of single TStreamerElement in streamer node

Definition at line 766 of file TXMLFile.cxx.

◆ Streamer()

void TXMLFile::Streamer ( TBuffer & R__b)
overridevirtual

TDirectory Streamer.

Reimplemented from TFile.

◆ StreamerNVirtual()

void TXMLFile::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 140 of file TXMLFile.h.

◆ SumBuffer()

void TFile::SumBuffer ( Int_t bufsize)
inherited

◆ SysClose()

Int_t TXMLFile::SysClose ( Int_t )
inlinefinalprotectedvirtual

Reimplemented from TFile.

Definition at line 31 of file TXMLFile.h.

◆ SysError()

void TObject::SysError ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue system error message.

Use "location" to specify the method where the system error occurred. Accepts standard printf formatting arguments.

Definition at line 1112 of file TObject.cxx.

◆ SysOpen()

Int_t TXMLFile::SysOpen ( const char * ,
Int_t ,
UInt_t  )
inlinefinalprotectedvirtual

Reimplemented from TFile.

Definition at line 30 of file TXMLFile.h.

◆ SysRead()

Int_t TXMLFile::SysRead ( Int_t ,
void * ,
Int_t  )
inlinefinalprotectedvirtual

Reimplemented from TFile.

Definition at line 32 of file TXMLFile.h.

◆ SysSeek()

Long64_t TXMLFile::SysSeek ( Int_t ,
Long64_t ,
Int_t  )
inlinefinalprotectedvirtual

Reimplemented from TFile.

Definition at line 34 of file TXMLFile.h.

◆ SysStat()

Int_t TXMLFile::SysStat ( Int_t ,
Long_t * ,
Long64_t * ,
Long_t * ,
Long_t *  )
inlinefinalprotectedvirtual

Reimplemented from TFile.

Definition at line 35 of file TXMLFile.h.

◆ SysSync()

Int_t TXMLFile::SysSync ( Int_t )
inlinefinalprotectedvirtual

Reimplemented from TFile.

Definition at line 36 of file TXMLFile.h.

◆ SysWrite()

Int_t TXMLFile::SysWrite ( Int_t ,
const void * ,
Int_t  )
inlinefinalprotectedvirtual

Reimplemented from TFile.

Definition at line 33 of file TXMLFile.h.

◆ TestBit()

Bool_t TObject::TestBit ( UInt_t f) const
inlineinherited

Definition at line 204 of file TObject.h.

◆ TestBits()

Int_t TObject::TestBits ( UInt_t f) const
inlineinherited

Definition at line 205 of file TObject.h.

◆ UnregisterContext()

void TDirectory::UnregisterContext ( TContext * ctxt)
protectedinherited

UnRegister a TContext pointing to this TDirectory object.

Definition at line 1444 of file TDirectory.cxx.

◆ UseCurrentStyle()

void TObject::UseCurrentStyle ( )
virtualinherited

Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

Reimplemented in TAxis3D, TCanvas, TFrame, TGraph, TH1, TPad, TPaveStats, TPaveText, and TTree.

Definition at line 909 of file TObject.cxx.

◆ WalkTKeys()

ROOT::Detail::TKeyMapIterable TFile::WalkTKeys ( )
inherited

Traverses all TKeys in the TFile and returns information about them.

◆ Warning()

void TObject::Warning ( const char * location,
const char * fmt,
... ) const
virtualinherited

Issue warning message.

Use "location" to specify the method where the warning occurred. Accepts standard printf formatting arguments.

Definition at line 1084 of file TObject.cxx.

◆ Write() [1/2]

Int_t TXMLFile::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 ) const
inlinefinalvirtual

Write this object to the current directory.

The data structure corresponding to this object is serialized. The corresponding buffer is written to the current directory with an associated key with name "name".

Writing an object to a file involves the following steps:

  • Creation of a support TKey object in the current directory. The TKey object creates a TBuffer object.
  • The TBuffer object is filled via the class::Streamer function.
  • If the file is compressed (default) a second buffer is created to hold the compressed buffer.
  • Reservation of the corresponding space in the file by looking in the TFree list of free blocks of the file.
  • The buffer is written to the file.

Bufsize can be given to force a given buffer size to write this object. By default, the buffersize will be taken from the average buffer size of all objects written to the current file so far.

If a name is specified, it will be the name of the key. If name is not given, the name of the key will be the name as returned by GetName().

The option can be a combination of: kSingleKey, kOverwrite or kWriteDelete Using the kOverwrite option a previous key with the same name is overwritten. The previous key is deleted before writing the new object. Using the kWriteDelete option a previous key with the same name is deleted only after the new object has been written. This option is safer than kOverwrite but it is slower. NOTE: Neither kOverwrite nor kWriteDelete reduces the size of a TFile– the space is simply freed up to be overwritten; in the case of a TTree, it is more complicated. If one opens a TTree, appends some entries, then writes it out, the behaviour is effectively the same. If, however, one creates a new TTree and writes it out in this way, only the metadata is replaced, effectively making the old data invisible without deleting it. TTree::Delete() can be used to mark all disk space occupied by a TTree as free before overwriting its metadata this way. The kSingleKey option is only used by TCollection::Write() to write a container with a single key instead of each object in the container with its own key.

An object is read from the file into memory via TKey::Read() or via TObject::Read().

The function returns the total number of bytes written to the file. It returns 0 if the object cannot be written.

Reimplemented from TFile.

Definition at line 95 of file TXMLFile.h.

◆ Write() [2/2]

Int_t TXMLFile::Write ( const char * name = nullptr,
Int_t option = 0,
Int_t bufsize = 0 )
inlinefinalvirtual

Write this object to the current directory.

For more see the const version of this method.

Reimplemented from TFile.

Definition at line 94 of file TXMLFile.h.

◆ WriteBuffer()

Bool_t TXMLFile::WriteBuffer ( const char * ,
Int_t  )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 93 of file TXMLFile.h.

◆ WriteBufferViaCache()

Int_t TFile::WriteBufferViaCache ( const char * buf,
Int_t len )
protectedinherited

◆ WriteDirHeader()

void TDirectoryFile::WriteDirHeader ( )
overridevirtualinherited

Reimplemented from TDirectory.

◆ WriteFree()

void TXMLFile::WriteFree ( )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 96 of file TXMLFile.h.

◆ WriteHeader()

void TXMLFile::WriteHeader ( )
inlinefinalvirtual

Reimplemented from TFile.

Definition at line 97 of file TXMLFile.h.

◆ WriteKeys()

void TDirectoryFile::WriteKeys ( )
overridevirtualinherited

Reimplemented from TDirectory.

◆ WriteObject() [1/2]

template<typename T>
std::enable_if_t< std::is_base_of< TObject, T >::value, Int_t > TDirectory::WriteObject ( const T * obj,
const char * name,
Option_t * option = "",
Int_t bufsize = 0 )
inlineinherited

Write an object with proper type checking.

Parameters
[in]objPointer to an object to be written.
[in]nameName of the object in the file.
[in]optionOptions. See TDirectoryFile::WriteTObject.
[in]bufsizeBuffer size. See TDirectoryFile::WriteTObject.

This overload takes care of instances of classes that are derived from TObject. The method redirects to TDirectory::WriteTObject.

Definition at line 297 of file TDirectory.h.

◆ WriteObject() [2/2]

template<typename T>
std::enable_if_t<!std::is_base_of< TObject, T >::value, Int_t > TDirectory::WriteObject ( const T * obj,
const char * name,
Option_t * option = "",
Int_t bufsize = 0 )
inlineinherited

Write an object with proper type checking.

Parameters
[in]objPointer to an object to be written.
[in]nameName of the object in the file.
[in]optionOptions. See TDirectoryFile::WriteTObject.
[in]bufsizeBuffer size. See TDirectoryFile::WriteTObject.

This overload takes care of instances of classes that are not derived from TObject. The method redirects to TDirectory::WriteObjectAny.

Definition at line 283 of file TDirectory.h.

◆ WriteObjectAny() [1/2]

Int_t TDirectoryFile::WriteObjectAny ( const void * obj,
const char * classname,
const char * name,
Option_t * option = "",
Int_t bufsize = 0 )
overridevirtualinherited

Reimplemented from TDirectory.

◆ WriteObjectAny() [2/2]

Int_t TDirectoryFile::WriteObjectAny ( const void * obj,
const TClass * cl,
const char * name,
Option_t * option = "",
Int_t bufsize = 0 )
overridevirtualinherited

Reimplemented from TDirectory.

◆ WriteProcessID()

virtual UShort_t TFile::WriteProcessID ( TProcessID * pid)
virtualinherited

◆ WriteStreamerInfo()

void TXMLFile::WriteStreamerInfo ( )
finalvirtual

convert all TStreamerInfo, used in file, to xml format

Reimplemented from TFile.

Definition at line 663 of file TXMLFile.cxx.

◆ WriteTObject()

Int_t TDirectoryFile::WriteTObject ( const TObject * obj,
const char * name = nullptr,
Option_t * option = "",
Int_t bufsize = 0 )
overridevirtualinherited

Reimplemented from TDirectory.

◆ XML()

TXMLEngine * TXMLFile::XML ( )
inline

Definition at line 112 of file TXMLFile.h.

◆ XmlClassNameSpaceRef()

const char * TXMLSetup::XmlClassNameSpaceRef ( const TClass * cl)
inherited

produce string which used as reference in class namespace definition

Definition at line 225 of file TXMLSetup.cxx.

◆ XmlConvertClassName()

const char * TXMLSetup::XmlConvertClassName ( const char * name)
inherited

convert class name to exclude any special symbols like ':', '<' '>' ',' and spaces

Definition at line 211 of file TXMLSetup.cxx.

◆ XmlDefineClass()

TClass * TXMLSetup::XmlDefineClass ( const char * xmlClassName)
protectedinherited

define class for the converted class name, where special symbols were replaced by '_'

Definition at line 270 of file TXMLSetup.cxx.

◆ XmlGetElementName()

const char * TXMLSetup::XmlGetElementName ( const TStreamerElement * el)
inherited

return converted name for TStreamerElement

Definition at line 243 of file TXMLSetup.cxx.

Member Data Documentation

◆ fArchive

TArchiveFile* TFile::fArchive {nullptr}
protectedinherited

!Archive file from which we read this file

Definition at line 175 of file TFile.h.

◆ fArchiveOffset

Long64_t TFile::fArchiveOffset {0}
protectedinherited

!Offset at which file starts in archive

Definition at line 179 of file TFile.h.

◆ fAsyncHandle

TFileOpenHandle* TFile::fAsyncHandle {nullptr}
protectedinherited

!For proper automatic cleanup

Definition at line 186 of file TFile.h.

◆ fAsyncOpenStatus

EAsyncOpenStatus TFile::fAsyncOpenStatus {kAOSNotAsync}
protectedinherited

!Status of an asynchronous open request

Definition at line 187 of file TFile.h.

◆ fBEGIN

Long64_t TFile::fBEGIN {0}
protectedinherited

First used byte in file.

Definition at line 156 of file TFile.h.

◆ fBits

UInt_t TObject::fBits
privateinherited

bit field status word

Definition at line 47 of file TObject.h.

◆ fBufferSize

Int_t TDirectoryFile::fBufferSize {0}
protectedinherited

Default buffer size to create new TKeys.

Definition at line 41 of file TDirectoryFile.h.

◆ fBytesRead

Long64_t TFile::fBytesRead {0}
protectedinherited

Number of bytes read from this file.

Definition at line 154 of file TFile.h.

◆ fBytesReadExtra

Long64_t TFile::fBytesReadExtra {0}
protectedinherited

Number of extra bytes (overhead) read by the readahead buffer.

Definition at line 155 of file TFile.h.

◆ fBytesWrite

Long64_t TFile::fBytesWrite {0}
protectedinherited

Number of bytes written to this file.

Definition at line 153 of file TFile.h.

◆ fCacheRead

TFileCacheRead* TFile::fCacheRead {nullptr}
protectedinherited

!Pointer to the read cache (if any)

Definition at line 176 of file TFile.h.

◆ fCacheReadMap

TMap* TFile::fCacheReadMap {nullptr}
protectedinherited

!Pointer to the read cache (if any)

Definition at line 177 of file TFile.h.

◆ fCacheWrite

TFileCacheWrite* TFile::fCacheWrite {nullptr}
protectedinherited

!Pointer to the write cache (if any)

Definition at line 178 of file TFile.h.

◆ fClassIndex

TArrayC* TFile::fClassIndex {nullptr}
protectedinherited

!Index of TStreamerInfo classes written to this file

Definition at line 172 of file TFile.h.

◆ fCompress

Int_t TFile::fCompress {0}
protectedinherited

Compression level and algorithm.

Definition at line 162 of file TFile.h.

◆ fContext

TContext* TDirectory::fContext {nullptr}
protectedinherited

! Pointer to a list of TContext object pointing to this TDirectory

Definition at line 145 of file TDirectory.h.

◆ fContextPeg

std::atomic<size_t> TDirectory::fContextPeg {0}
protectedinherited

! Counter delaying the TDirectory destructor from finishing.

Definition at line 153 of file TDirectory.h.

◆ fD

Int_t TFile::fD {-1}
protectedinherited

File descriptor.

Definition at line 160 of file TFile.h.

◆ fDatimeC

TDatime TDirectoryFile::fDatimeC
protectedinherited

Date and time when directory is created.

Definition at line 37 of file TDirectoryFile.h.

◆ fDatimeM

TDatime TDirectoryFile::fDatimeM
protectedinherited

Date and time of last modification.

Definition at line 38 of file TDirectoryFile.h.

◆ fDoc

XMLDocPointer_t TXMLFile::fDoc {nullptr}
protected

!

Definition at line 130 of file TXMLFile.h.

◆ fEND

Long64_t TFile::fEND {0}
protectedinherited

Last used byte in file.

Definition at line 157 of file TFile.h.

◆ fFile

TFile* TDirectoryFile::fFile {nullptr}
protectedinherited

Pointer to current file in memory.

Definition at line 45 of file TDirectoryFile.h.

◆ fFree

TList* TFile::fFree {nullptr}
protectedinherited

Free segments linked list table.

Definition at line 171 of file TFile.h.

◆ fgAddDirectory

Bool_t TDirectory::fgAddDirectory = false
inlinestaticprotectedinherited

!

Deprecated
This flag has no effect in ROOT.

Definition at line 157 of file TDirectory.h.

◆ fgAsyncOpenRequests

TList* TFile::fgAsyncOpenRequests
staticprotectedinherited

Definition at line 200 of file TFile.h.

◆ fgBytesRead

std::atomic<Long64_t> TFile::fgBytesRead
staticprotectedinherited

Number of bytes read by all TFile objects.

Definition at line 209 of file TFile.h.

◆ fgBytesWrite

std::atomic<Long64_t> TFile::fgBytesWrite
staticprotectedinherited

Number of bytes written by all TFile objects.

Definition at line 208 of file TFile.h.

◆ fgCacheFileDir

TString TFile::fgCacheFileDir
staticprotectedinherited

Directory where to locally stage files.

Definition at line 202 of file TFile.h.

◆ fgCacheFileDisconnected

Bool_t TFile::fgCacheFileDisconnected
staticprotectedinherited

Indicates, we trust in the files in the cache dir without stat on the cached file.

Definition at line 203 of file TFile.h.

◆ fgCacheFileForce

Bool_t TFile::fgCacheFileForce
staticprotectedinherited

Indicates, to force all READ to CACHEREAD.

Definition at line 204 of file TFile.h.

◆ fGDirectories

std::vector<SharedGDirectory_t> TDirectory::fGDirectories
protectedinherited

! thread local gDirectory pointing to this object.

Definition at line 151 of file TDirectory.h.

◆ fgDtorOnly

Longptr_t TObject::fgDtorOnly = 0
staticprivateinherited

object for which to call dtor only (i.e. no delete)

Definition at line 49 of file TObject.h.

◆ fgFileCounter

std::atomic<Long64_t> TFile::fgFileCounter
staticprotectedinherited

Counter for all opened files.

Definition at line 210 of file TFile.h.

◆ fGlobalRegistration

bool TFile::fGlobalRegistration = true
protectedinherited

! if true, bypass use of global lists

Definition at line 193 of file TFile.h.

◆ fgNameSpaceBase

TString TXMLSetup::fgNameSpaceBase = fgROOTDocNameSpaceBase
staticprotectedinherited

Definition at line 134 of file TXMLSetup.h.

◆ fgObjectStat

Bool_t TObject::fgObjectStat = kTRUE
staticprivateinherited

if true keep track of objects in TObjectTable

Definition at line 50 of file TObject.h.

◆ fgOnlyStaged

Bool_t TFile::fgOnlyStaged
staticprotectedinherited

Before the file is opened, it is checked, that the file is staged, if not, the open fails.

Definition at line 206 of file TFile.h.

◆ fgOpenTimeout

UInt_t TFile::fgOpenTimeout
staticprotectedinherited

Timeout for open operations in ms - 0 corresponds to blocking i/o.

Definition at line 205 of file TFile.h.

◆ fgReadaheadSize

Int_t TFile::fgReadaheadSize
staticprotectedinherited

Readahead buffer size.

Definition at line 212 of file TFile.h.

◆ fgReadCalls

std::atomic<Int_t> TFile::fgReadCalls
staticprotectedinherited

Number of bytes read from all TFile objects.

Definition at line 211 of file TFile.h.

◆ fgReadInfo

Bool_t TFile::fgReadInfo
staticprotectedinherited

if true (default) ReadStreamerInfo is called when opening a file

Definition at line 213 of file TFile.h.

◆ fgTsSIHashes

ROOT::Internal::RConcurrentHashColl TFile::fgTsSIHashes
staticprotectedinherited

!TS Set of hashes built from read streamer infos

Definition at line 198 of file TFile.h.

◆ fInfoCache

TList* TFile::fInfoCache {nullptr}
protectedinherited

!Cached list of the streamer infos in this file

Definition at line 190 of file TFile.h.

◆ fInitDone

Bool_t TFile::fInitDone {kFALSE}
protectedinherited

!True if the file has been initialized

Definition at line 183 of file TFile.h.

◆ fIOVersion

Int_t TXMLFile::fIOVersion {0}
protected

! indicates format of ROOT xml file

Definition at line 136 of file TXMLFile.h.

◆ fIsArchive

Bool_t TFile::fIsArchive {kFALSE}
protectedinherited

!True if this is a pure archive file

Definition at line 180 of file TFile.h.

◆ fIsPcmFile

Bool_t TFile::fIsPcmFile {kFALSE}
protectedinherited

!True if the file is a ROOT pcm file.

Definition at line 185 of file TFile.h.

◆ fIsRootFile

Bool_t TFile::fIsRootFile {kTRUE}
protectedinherited

!True is this is a ROOT file, raw file otherwise

Definition at line 182 of file TFile.h.

◆ fKeyCounter

Long64_t TXMLFile::fKeyCounter {0}
protected

! counter of created keys, used for keys id

Definition at line 138 of file TXMLFile.h.

◆ fKeys

TList* TDirectoryFile::fKeys {nullptr}
protectedinherited

Pointer to keys list in memory.

Definition at line 46 of file TDirectoryFile.h.

◆ fList

TList* TDirectory::fList {nullptr}
protectedinherited

List of objects in memory.

Definition at line 142 of file TDirectory.h.

◆ fModified

Bool_t TDirectoryFile::fModified {kFALSE}
protectedinherited

True if directory has been modified.

Definition at line 35 of file TDirectoryFile.h.

◆ fMother

TObject* TDirectory::fMother {nullptr}
protectedinherited

pointer to mother of the directory

Definition at line 141 of file TDirectory.h.

◆ fMustFlush

Bool_t TFile::fMustFlush {kTRUE}
protectedinherited

!True if the file buffers must be flushed

Definition at line 184 of file TFile.h.

◆ fName

TString TNamed::fName
protectedinherited

Definition at line 32 of file TNamed.h.

◆ fNbytesFree

Int_t TFile::fNbytesFree {0}
protectedinherited

Number of bytes for free segments structure.

Definition at line 163 of file TFile.h.

◆ fNbytesInfo

Int_t TFile::fNbytesInfo {0}
protectedinherited

Number of bytes for StreamerInfo record.

Definition at line 164 of file TFile.h.

◆ fNbytesKeys

Int_t TDirectoryFile::fNbytesKeys {0}
protectedinherited

Number of bytes for the keys.

Definition at line 39 of file TDirectoryFile.h.

◆ fNbytesName

Int_t TDirectoryFile::fNbytesName {0}
protectedinherited

Number of bytes in TNamed at creation time.

Definition at line 40 of file TDirectoryFile.h.

◆ fNoAnchorInName

Bool_t TFile::fNoAnchorInName {kFALSE}
protectedinherited

!True if we don't want to force the anchor to be appended to the file name

Definition at line 181 of file TFile.h.

◆ fNProcessIDs

Int_t TFile::fNProcessIDs {0}
protectedinherited

Number of TProcessID written to this file.

Definition at line 166 of file TFile.h.

◆ fOffset

Long64_t TFile::fOffset {0}
protectedinherited

!Seek offset cache

Definition at line 174 of file TFile.h.

◆ fOpenPhases

TList* TFile::fOpenPhases {nullptr}
protectedinherited

!Time info about open phases

Definition at line 191 of file TFile.h.

◆ fOption

TString TFile::fOption
protectedinherited

File options.

Definition at line 169 of file TFile.h.

◆ fPathBuffer

TString TDirectory::fPathBuffer
mutableprotectedinherited

! Buffer for GetPath() function

Definition at line 144 of file TDirectory.h.

◆ fProcessIDs

TObjArray* TFile::fProcessIDs {nullptr}
protectedinherited

!Array of pointers to TProcessIDs

Definition at line 173 of file TFile.h.

◆ fReadCalls

Int_t TFile::fReadCalls {0}
protectedinherited

Number of read calls ( not counting the cache calls ).

Definition at line 167 of file TFile.h.

◆ fRealName

TString TFile::fRealName
protectedinherited

Effective real file name (not original url).

Definition at line 168 of file TFile.h.

◆ fRefCounter

Int_t TXMLSetup::fRefCounter {0}
protectedinherited

! counter , used to build id of xml references

Definition at line 130 of file TXMLSetup.h.

◆ fSeekDir

Long64_t TDirectoryFile::fSeekDir {0}
protectedinherited

Location of directory on file.

Definition at line 42 of file TDirectoryFile.h.

◆ fSeekFree

Long64_t TFile::fSeekFree {0}
protectedinherited

Location on disk of free segments structure.

Definition at line 158 of file TFile.h.

◆ fSeekInfo

Long64_t TFile::fSeekInfo {0}
protectedinherited

Location on disk of StreamerInfo record.

Definition at line 159 of file TFile.h.

◆ fSeekKeys

Long64_t TDirectoryFile::fSeekKeys {0}
protectedinherited

Location of Keys record on file.

Definition at line 44 of file TDirectoryFile.h.

◆ fSeekParent

Long64_t TDirectoryFile::fSeekParent {0}
protectedinherited

Location of parent directory on file.

Definition at line 43 of file TDirectoryFile.h.

◆ fSpinLock

std::atomic_flag TDirectory::fSpinLock
mutableprotectedinherited

! MSVC doesn't support = ATOMIC_FLAG_INIT;

Definition at line 154 of file TDirectory.h.

◆ fStoreStreamerInfos

Bool_t TXMLSetup::fStoreStreamerInfos {kTRUE}
protectedinherited

Definition at line 126 of file TXMLSetup.h.

◆ fStrBuf

TString TXMLSetup::fStrBuf
protectedinherited

! buffer, used in XmlDefineClass() function

Definition at line 132 of file TXMLSetup.h.

◆ fStreamerInfoNode

XMLNodePointer_t TXMLFile::fStreamerInfoNode {nullptr}
protected

! pointer of node with streamer info data

Definition at line 132 of file TXMLFile.h.

◆ fSum2Buffer

Double_t TFile::fSum2Buffer {0}
protectedinherited

Sum of squares of buffer sizes of objects written so far.

Definition at line 152 of file TFile.h.

◆ fSumBuffer

Double_t TFile::fSumBuffer {0}
protectedinherited

Sum of buffer sizes of objects written so far.

Definition at line 151 of file TFile.h.

◆ fTitle

TString TNamed::fTitle
protectedinherited

Definition at line 33 of file TNamed.h.

◆ fUniqueID

UInt_t TObject::fUniqueID
privateinherited

object unique identifier

Definition at line 46 of file TObject.h.

◆ fUnits

Char_t TFile::fUnits {0}
protectedinherited

Number of bytes for file pointers.

Definition at line 170 of file TFile.h.

◆ fUrl

TUrl TFile::fUrl
protectedinherited

!URL of file

Definition at line 188 of file TFile.h.

◆ fUseDtd

Bool_t TXMLSetup::fUseDtd {kFALSE}
protectedinherited

Definition at line 127 of file TXMLSetup.h.

◆ fUseNamespaces

Bool_t TXMLSetup::fUseNamespaces {kFALSE}
protectedinherited

Definition at line 128 of file TXMLSetup.h.

◆ fUUID

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

Unique identifier.

Definition at line 143 of file TDirectory.h.

◆ fVersion

Int_t TFile::fVersion {0}
protectedinherited

File format version.

Definition at line 161 of file TFile.h.

◆ fWritable

Bool_t TDirectoryFile::fWritable {kFALSE}
protectedinherited

True if directory is writable.

Definition at line 36 of file TDirectoryFile.h.

◆ fWriteMutex

std::mutex TFile::fWriteMutex
protectedinherited

!Lock for writing baskets / keys into the file.

Definition at line 196 of file TFile.h.

◆ fWritten

Int_t TFile::fWritten {0}
protectedinherited

Number of objects written so far.

Definition at line 165 of file TFile.h.

◆ fXML

std::unique_ptr<TXMLEngine> TXMLFile::fXML
protected

! object for interface with xml library

Definition at line 134 of file TXMLFile.h.

◆ fXmlLayout

EXMLLayout TXMLSetup::fXmlLayout {kSpecialized}
protectedinherited

Definition at line 125 of file TXMLSetup.h.