Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
TFileInfo Class Reference

Class describing a generic file including meta information.

Definition at line 39 of file TFileInfo.h.

Public Types

enum  EStatusBits { kStaged = (1ULL << ( 15 )) , kCorrupted = (1ULL << ( 16 )) , kSortWithIndex = (1ULL << ( 17 )) }
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
 
enum  EStatusBits {
  kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,
  kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 ))
}
 

Public Member Functions

 TFileInfo (const char *url=nullptr, Long64_t size=-1, const char *uuid=nullptr, const char *md5=nullptr, TObject *meta=nullptr)
 Constructor.
 
 TFileInfo (const TFileInfo &)
 Copy constructor.
 
virtual ~TFileInfo ()
 Destructor.
 
Bool_t AddMetaData (TObject *meta)
 Add's a meta data object to the file info object.
 
Bool_t AddUrl (const char *url, Bool_t infront=kFALSE)
 Add a new URL.
 
Int_t Compare (const TObject *obj) const override
 Compare TFileInfo object by their first urls.
 
TUrlFindByUrl (const char *url, Bool_t withDeflt=kFALSE)
 Find an element from a URL. Returns 0 if not found.
 
TUrlGetCurrentUrl () const
 Return the current url.
 
TUrlGetFirstUrl () const
 
Int_t GetIndex () const
 
TMD5GetMD5 () const
 
TFileInfoMetaGetMetaData (const char *meta=nullptr) const
 Get meta data object with specified name.
 
TListGetMetaDataList () const
 
Int_t GetNUrls () const
 
Long64_t GetSize () const
 
TUrlGetUrlAt (Int_t i) const
 
TUUIDGetUUID () const
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
TUrlNextUrl ()
 Iterator function, start iteration by calling ResetUrl().
 
void Print (Option_t *options="") const override
 Print information about this object.
 
Bool_t RemoveMetaData (const char *meta=nullptr)
 Remove the metadata object.
 
Bool_t RemoveUrl (const char *url)
 Remove an URL. Returns kTRUE if successful, kFALSE otherwise.
 
Bool_t RemoveUrlAt (Int_t i)
 Remove URL at given position. Returns kTRUE on success, kFALSE on error.
 
void ResetUrl ()
 
Bool_t SetCurrentUrl (const char *url)
 Set 'url' as current URL, if in the list Return kFALSE if not in the list.
 
Bool_t SetCurrentUrl (TUrl *url)
 Set 'url' as current URL, if in the list Return kFALSE if not in the list.
 
void SetIndex (Int_t idx)
 
void SetSize (Long64_t size)
 
void SetUUID (const char *uuid)
 Set the UUID to the value associated to the string 'uuid'.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TNamed &named)
 TNamed copy ctor.
 
 TNamed (const TString &name, const TString &title)
 
virtual ~TNamed ()
 TNamed destructor.
 
void Clear (Option_t *option="") override
 Set name and title to empty strings ("").
 
TObjectClone (const char *newname="") const override
 Make a clone of an object using the Streamer facility.
 
Int_t Compare (const TObject *obj) const override
 Compare two TNamed objects.
 
void Copy (TObject &named) const override
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
const char * GetName () const override
 Returns name of object.
 
const char * GetTitle () const override
 Returns title of object.
 
ULong_t Hash () const override
 Return hash value for this object.
 
TClassIsA () const override
 
Bool_t IsSortable () const override
 
void ls (Option_t *option="") const override
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
void Print (Option_t *option="") const override
 Print TNamed name and title.
 
virtual void SetName (const char *name)
 Set the name of the TNamed.
 
virtual void SetNameTitle (const char *name, const char *title)
 Set all the TNamed parameters (name and title).
 
virtual void SetTitle (const char *title="")
 Set the title of the TNamed.
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject.
 
void Streamer (TBuffer &) override
 Stream an object of class TObject.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor.
 
 TObject (const TObject &object)
 TObject copy ctor.
 
virtual ~TObject ()
 TObject destructor.
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract.
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad.
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action.
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs.
 
virtual void Delete (Option_t *option="")
 Delete this object.
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object.
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects.
 
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).
 
virtual void Dump () const
 Dump contents of object on stdout.
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message.
 
virtual void Execute (const char *method, const char *params, Int_t *error=nullptr)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
 Execute method on this object with parameters stored in the TObjArray.
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py).
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message.
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes.
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes.
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object.
 
virtual const char * GetIconName () const
 Returns mime type name of object.
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py).
 
virtual Option_tGetOption () const
 
virtual UInt_t GetUniqueID () const
 Return the unique object id.
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out.
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message.
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname".
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl.
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas.
 
void InvertBit (UInt_t f)
 
Bool_t IsDestructed () const
 IsDestructed.
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory).
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification (the base implementation is no-op).
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete.
 
void operator delete (void *ptr)
 Operator delete.
 
void operator delete (void *ptr, void *vp)
 Only called by placement new when throwing an exception.
 
void operator delete[] (void *ptr)
 Operator delete [].
 
void operator delete[] (void *ptr, void *vp)
 Only called by placement new[] when throwing an exception.
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *vp)
 
void * operator new[] (size_t sz)
 
void * operator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator.
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself.
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list.
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory.
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list.
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename.
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out".
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f.
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object.
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id.
 
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message.
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Static Public Member Functions

static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TNamed
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
- Static Public Member Functions inherited from TObject
static TClassClass ()
 
static const char * Class_Name ()
 
static constexpr Version_t Class_Version ()
 
static const char * DeclFileName ()
 
static Longptr_t GetDtorOnly ()
 Return destructor only flag.
 
static Bool_t GetObjectStat ()
 Get status of object stat flag.
 
static void SetDtorOnly (void *obj)
 Set destructor only flag.
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable.
 

Private Member Functions

TFileInfooperator= (const TFileInfo &)=delete
 
void ParseInput (const char *in)
 Parse the input line to extract init information from 'in'; the input string is tokenized on ' '; the tokens can be prefixed by the following keys:
 

Private Attributes

TUrlfCurrentUrl
 
Int_t fIndex
 
TMD5fMD5
 
TListfMetaDataList
 
Long64_t fSize
 
TListfUrlList
 current URL to access the file, points to URL
 
TUUIDfUUID
 

Additional Inherited Members

- Protected Types inherited from TObject
enum  { kOnlyPrepStep = (1ULL << ( 3 )) }
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected).
 
void MakeZombie ()
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

#include <TFileInfo.h>

Inheritance diagram for TFileInfo:
[legend]

Member Enumeration Documentation

◆ EStatusBits

Enumerator
kStaged 
kCorrupted 
kSortWithIndex 

Definition at line 57 of file TFileInfo.h.

Constructor & Destructor Documentation

◆ TFileInfo() [1/2]

TFileInfo::TFileInfo ( const char *  url = nullptr,
Long64_t  size = -1,
const char *  uuid = nullptr,
const char *  md5 = nullptr,
TObject meta = nullptr 
)

Constructor.

Definition at line 32 of file TFileInfo.cxx.

◆ TFileInfo() [2/2]

TFileInfo::TFileInfo ( const TFileInfo fi)

Copy constructor.

Definition at line 74 of file TFileInfo.cxx.

◆ ~TFileInfo()

TFileInfo::~TFileInfo ( )
virtual

Destructor.

Definition at line 120 of file TFileInfo.cxx.

Member Function Documentation

◆ AddMetaData()

Bool_t TFileInfo::AddMetaData ( TObject meta)

Add's a meta data object to the file info object.

The object will be adopted by the TFileInfo and should not be deleted by the user. Typically objects of class TFileInfoMeta or derivatives should be added, but any class is accepted. Returns kTRUE if successful, kFALSE otherwise.

Definition at line 385 of file TFileInfo.cxx.

◆ AddUrl()

Bool_t TFileInfo::AddUrl ( const char *  url,
Bool_t  infront = kFALSE 
)

Add a new URL.

If 'infront' is TRUE the new url is pushed at the beginning of the list; otherwise is pushed back. Returns kTRUE if successful, kFALSE otherwise.

Definition at line 296 of file TFileInfo.cxx.

◆ Class()

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

◆ Class_Name()

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

◆ Class_Version()

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

Definition at line 104 of file TFileInfo.h.

◆ Compare()

Int_t TFileInfo::Compare ( const TObject obj) const
overridevirtual

Compare TFileInfo object by their first urls.

Reimplemented from TObject.

Definition at line 444 of file TFileInfo.cxx.

◆ DeclFileName()

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

Definition at line 104 of file TFileInfo.h.

◆ FindByUrl()

TUrl * TFileInfo::FindByUrl ( const char *  url,
Bool_t  withDeflt = kFALSE 
)

Find an element from a URL. Returns 0 if not found.

Definition at line 277 of file TFileInfo.cxx.

◆ GetCurrentUrl()

TUrl * TFileInfo::GetCurrentUrl ( ) const

Return the current url.

Definition at line 249 of file TFileInfo.cxx.

◆ GetFirstUrl()

TUrl * TFileInfo::GetFirstUrl ( ) const
inline

Definition at line 72 of file TFileInfo.h.

◆ GetIndex()

Int_t TFileInfo::GetIndex ( ) const
inline

Definition at line 99 of file TFileInfo.h.

◆ GetMD5()

TMD5 * TFileInfo::GetMD5 ( ) const
inline

Definition at line 82 of file TFileInfo.h.

◆ GetMetaData()

TFileInfoMeta * TFileInfo::GetMetaData ( const char *  meta = nullptr) const

Get meta data object with specified name.

If meta is 0 get first meta data object. Returns 0 in case no suitable meta data object is found.

Definition at line 425 of file TFileInfo.cxx.

◆ GetMetaDataList()

TList * TFileInfo::GetMetaDataList ( ) const
inline

Definition at line 83 of file TFileInfo.h.

◆ GetNUrls()

Int_t TFileInfo::GetNUrls ( ) const
inline

Definition at line 75 of file TFileInfo.h.

◆ GetSize()

Long64_t TFileInfo::GetSize ( ) const
inline

Definition at line 80 of file TFileInfo.h.

◆ GetUrlAt()

TUrl * TFileInfo::GetUrlAt ( Int_t  i) const
inline

Definition at line 73 of file TFileInfo.h.

◆ GetUUID()

TUUID * TFileInfo::GetUUID ( ) const
inline

Definition at line 81 of file TFileInfo.h.

◆ IsA()

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

Reimplemented from TObject.

Definition at line 104 of file TFileInfo.h.

◆ IsSortable()

Bool_t TFileInfo::IsSortable ( ) const
inlineoverridevirtual

Reimplemented from TObject.

Definition at line 96 of file TFileInfo.h.

◆ NextUrl()

TUrl * TFileInfo::NextUrl ( )

Iterator function, start iteration by calling ResetUrl().

The first call to NextUrl() will return the 1st element, the seconde the 2nd element etc. Returns 0 in case no more urls.

Definition at line 261 of file TFileInfo.cxx.

◆ operator=()

TFileInfo & TFileInfo::operator= ( const TFileInfo )
privatedelete

◆ ParseInput()

void TFileInfo::ParseInput ( const char *  in)
private

Parse the input line to extract init information from 'in'; the input string is tokenized on ' '; the tokens can be prefixed by the following keys:

  • url:<url1>,<url2>,... URLs for the file; stored in the order given
  • sz:<size> size of the file in bytes
  • md5:<md5_ascii> MD5 sum of the file in ASCII form
  • uuid:<uuid> UUID of the file
  • tree:<name>,<entries>,<first>,<last> meta-information about a tree in the file; the should be in the form "<subdir>/tree-name";'entries' is the number of entries in the tree; 'first' and 'last' define the entry range.
  • obj:<name>,<class>,<entries> meta-information about a generic object in the file; the should be in the form "<subdir>/obj-name"; 'class' is the object class; 'entries' is the number of occurrences for this object.
  • idx:<index> Index of this file if sorting with index

Multiple occurrences of 'tree:' or 'obj:' can be specified. The initializations done via the input string are super-seeded by the ones by other parameters in the constructor, if any. If no key is given, the token is interpreted as URL(s).

Definition at line 157 of file TFileInfo.cxx.

◆ Print()

void TFileInfo::Print ( Option_t option = "") const
overridevirtual

Print information about this object.

If option contains 'L' a long listing will be printed (on multiple lines). Otherwise one line is printed with the following information: current url, default tree name|class|entries, md5; the default tree name is passed via the option ("T:<default_tree>") by the owning TFileCollection.

Reimplemented from TObject.

Definition at line 478 of file TFileInfo.cxx.

◆ RemoveMetaData()

Bool_t TFileInfo::RemoveMetaData ( const char *  meta = nullptr)

Remove the metadata object.

If meta is 0 remove all meta data objects. Returns kTRUE if successful, kFALSE otherwise.

Definition at line 402 of file TFileInfo.cxx.

◆ RemoveUrl()

Bool_t TFileInfo::RemoveUrl ( const char *  url)

Remove an URL. Returns kTRUE if successful, kFALSE otherwise.

Definition at line 321 of file TFileInfo.cxx.

◆ RemoveUrlAt()

Bool_t TFileInfo::RemoveUrlAt ( Int_t  i)

Remove URL at given position. Returns kTRUE on success, kFALSE on error.

Definition at line 337 of file TFileInfo.cxx.

◆ ResetUrl()

void TFileInfo::ResetUrl ( )
inline

Definition at line 69 of file TFileInfo.h.

◆ SetCurrentUrl() [1/2]

Bool_t TFileInfo::SetCurrentUrl ( const char *  url)

Set 'url' as current URL, if in the list Return kFALSE if not in the list.

Definition at line 355 of file TFileInfo.cxx.

◆ SetCurrentUrl() [2/2]

Bool_t TFileInfo::SetCurrentUrl ( TUrl url)

Set 'url' as current URL, if in the list Return kFALSE if not in the list.

Definition at line 369 of file TFileInfo.cxx.

◆ SetIndex()

void TFileInfo::SetIndex ( Int_t  idx)
inline

Definition at line 100 of file TFileInfo.h.

◆ SetSize()

void TFileInfo::SetSize ( Long64_t  size)
inline

Definition at line 86 of file TFileInfo.h.

◆ SetUUID()

void TFileInfo::SetUUID ( const char *  uuid)

Set the UUID to the value associated to the string 'uuid'.

This is useful to set the UUID to the one of the ROOT file during verification.

NB: we do not change the name in here, because this would screw up lists of these objects hashed on the name. Those lists need to be rebuild. TFileCollection does that in RemoveDuplicates.

Definition at line 238 of file TFileInfo.cxx.

◆ Streamer()

void TFileInfo::Streamer ( TBuffer R__b)
overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

void TFileInfo::StreamerNVirtual ( TBuffer ClassDef_StreamerNVirtual_b)
inline

Definition at line 104 of file TFileInfo.h.

Member Data Documentation

◆ fCurrentUrl

TUrl* TFileInfo::fCurrentUrl
private

Definition at line 42 of file TFileInfo.h.

◆ fIndex

Int_t TFileInfo::fIndex
private

Definition at line 50 of file TFileInfo.h.

◆ fMD5

TMD5* TFileInfo::fMD5
private

Definition at line 47 of file TFileInfo.h.

◆ fMetaDataList

TList* TFileInfo::fMetaDataList
private

Definition at line 48 of file TFileInfo.h.

◆ fSize

Long64_t TFileInfo::fSize
private

Definition at line 45 of file TFileInfo.h.

◆ fUrlList

TList* TFileInfo::fUrlList
private

current URL to access the file, points to URL

Definition at line 44 of file TFileInfo.h.

◆ fUUID

TUUID* TFileInfo::fUUID
private

Definition at line 46 of file TFileInfo.h.

Libraries for TFileInfo:

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