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

Class that contains a list of TFileInfo's and accumulated meta data information about its entries.

This class is used to describe file sets as stored by Grid file catalogs, by PROOF or any other collection of TFile names.

Definition at line 39 of file TFileCollection.h.

Public Types

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

Public Member Functions

 TFileCollection (const char *name=nullptr, const char *title=nullptr, const char *file=nullptr, Int_t nfiles=-1, Int_t firstfile=1)
 TFileCollection constructor.
 
virtual ~TFileCollection ()
 Cleanup.
 
Int_t Add (const char *path)
 Add all files matching the specified pattern to the collection.
 
Int_t Add (TFileCollection *coll)
 Add content of the TFileCollection to this collection.
 
Int_t Add (TFileInfo *info)
 Add TFileInfo to the collection.
 
Int_t AddFromFile (const char *file, Int_t nfiles=-1, Int_t firstfile=1)
 Add file names contained in the specified text file.
 
Bool_t AddMetaData (TObject *meta)
 Add's a meta data object to the file collection object.
 
TObjStringExportInfo (const char *name=0, Int_t popt=0)
 Export the relevant info as a string; use 'name' as collection name, if defined, else use GetName().
 
Float_t GetCorruptedPercentage () const
 
const char * GetDefaultTreeName () const
 Returns the tree set with SetDefaultTreeName if set Returns the name of the first tree in the meta data list.
 
TFileCollectionGetFilesOnServer (const char *server)
 Return the subset of files served by 'server'.
 
TMapGetFilesPerServer (const char *exclude=0, Bool_t curronly=kFALSE)
 Return a map of TFileCollections with the files on each data server, excluding servers in the comma-separated list 'exclude'.
 
THashListGetList ()
 
TFileInfoMetaGetMetaData (const char *meta=0) const
 Returns the meta data object with the specified meta name.
 
Long64_t GetNCorruptFiles () const
 
Long64_t GetNFiles () const
 
Long64_t GetNStagedFiles () const
 
Float_t GetStagedPercentage () const
 
TFileCollectionGetStagedSubset ()
 Creates a subset of the files that have the kStaged & !kCorrupted bit set.
 
Long64_t GetTotalEntries (const char *tree) const
 Returns the number of entries for the specified tree (retrieved from meta data).
 
Long64_t GetTotalSize () const
 
Long64_t Merge (TCollection *list)
 Merge all TFileCollection objects in li into this TFileCollection object.
 
void Print (Option_t *option="") const
 Prints the contents of the TFileCollection.
 
Int_t RemoveDuplicates ()
 Remove duplicates based on the UUID, typically after a verification.
 
void RemoveMetaData (const char *meta=0)
 Removes the indicated meta data object in all TFileInfos and this object If no name is given all metadata is removed.
 
void ResetBitAll (UInt_t f)
 Reset the bit for all TFileInfos.
 
void SetAnchor (const char *anchor)
 Calls TUrl::SetAnchor() for all URLs contained in all TFileInfos.
 
void SetBitAll (UInt_t f)
 Set the bit for all TFileInfos.
 
void SetDefaultMetaData (const char *meta)
 Moves the indicated meta data in the first position, so that it becomes effectively the default.
 
void SetDefaultTreeName (const char *treeName)
 
void SetList (THashList *list)
 
void Sort (Bool_t useindex=kFALSE)
 Sort the collection.
 
Int_t Update (Long64_t avgsize=-1)
 Update accumulated information about the elements of the collection (e.g.
 
- 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.
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings ("").
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility.
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects.
 
virtual void Copy (TObject &named) const
 Copy this to obj.
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer.
 
virtual const char * GetName () const
 Returns name of object.
 
virtual const char * GetTitle () const
 Returns title of object.
 
virtual ULong_t Hash () const
 Return hash value for this object.
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title.
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator.
 
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.
 
- 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 for instance with: gROOT->SetSelectedPad(gPad).
 
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=0)
 Execute method on this object with the given parameter string, e.g.
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 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.
 
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)
 Operator delete [].
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator 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.
 
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=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory.
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory.
 

Private Member Functions

 TFileCollection (const TFileCollection &)=delete
 
void FormatSize (Long64_t bytes, TString &um, Double_t &size) const
 Format size.
 
TFileCollectionoperator= (const TFileCollection &)=delete
 
void PrintDetailed (TString &showOnly) const
 Print detailed.
 

Private Attributes

TString fDefaultTree
 
THashListfList
 
TListfMetaDataList
 
Long64_t fNCorruptFiles
 
Long64_t fNFiles
 
Long64_t fNStagedFiles
 
Long64_t fTotalSize
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
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.
 
- Protected Types inherited from TObject
enum  { kOnlyPrepStep = BIT(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 <TFileCollection.h>

Inheritance diagram for TFileCollection:
[legend]

Member Enumeration Documentation

◆ EStatusBits

Enumerator
kRemoteCollection 

Definition at line 59 of file TFileCollection.h.

Constructor & Destructor Documentation

◆ TFileCollection() [1/2]

TFileCollection::TFileCollection ( const TFileCollection )
privatedelete

◆ TFileCollection() [2/2]

TFileCollection::TFileCollection ( const char *  name = nullptr,
const char *  title = nullptr,
const char *  textfile = nullptr,
Int_t  nfiles = -1,
Int_t  firstfile = 1 
)

TFileCollection constructor.

Specify a name and title describing the list. If textfile is specified the file is opened and a TFileCollection is created containing the files in the textfile.

Definition at line 47 of file TFileCollection.cxx.

◆ ~TFileCollection()

TFileCollection::~TFileCollection ( )
virtual

Cleanup.

Definition at line 64 of file TFileCollection.cxx.

Member Function Documentation

◆ Add() [1/3]

Int_t TFileCollection::Add ( const char *  dir)

Add all files matching the specified pattern to the collection.

'dir' can include wildcards after the last slash, which causes all matching files in that directory to be added. If dir is the full path of a file, only one element is added. Return value is the number of added files.

Definition at line 159 of file TFileCollection.cxx.

◆ Add() [2/3]

Int_t TFileCollection::Add ( TFileCollection coll)

Add content of the TFileCollection to this collection.

Definition at line 92 of file TFileCollection.cxx.

◆ Add() [3/3]

Int_t TFileCollection::Add ( TFileInfo info)

Add TFileInfo to the collection.

Definition at line 73 of file TFileCollection.cxx.

◆ AddFromFile()

Int_t TFileCollection::AddFromFile ( const char *  textfile,
Int_t  nfiles = -1,
Int_t  firstfile = 1 
)

Add file names contained in the specified text file.

The file should contain one url per line; empty lines or lines starting with '#' (commented lines) are ignored. If nfiles > 0 only nfiles files are added, starting from file 'firstfile' (>= 1). The method returns the number of added files.

Definition at line 116 of file TFileCollection.cxx.

◆ AddMetaData()

Bool_t TFileCollection::AddMetaData ( TObject meta)

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

The object will be adopted by the TFileCollection and should not be deleted by the user. Typically objects of class TFileInfoMeta or derivatives should be added, but any class is accepted.

NB : a call to TFileCollection::Update will remove these objects unless the bit TFileInfoMeta::kExternal is set. Returns kTRUE if successful, kFALSE otherwise.

Definition at line 998 of file TFileCollection.cxx.

◆ ExportInfo()

TObjString * TFileCollection::ExportInfo ( const char *  name = 0,
Int_t  popt = 0 
)

Export the relevant info as a string; use 'name' as collection name, if defined, else use GetName().

The output object must be destroyed by the caller

Definition at line 708 of file TFileCollection.cxx.

◆ FormatSize()

void TFileCollection::FormatSize ( Long64_t  bytes,
TString um,
Double_t size 
) const
private

Format size.

Definition at line 533 of file TFileCollection.cxx.

◆ GetCorruptedPercentage()

Float_t TFileCollection::GetCorruptedPercentage ( ) const
inline

Definition at line 91 of file TFileCollection.h.

◆ GetDefaultTreeName()

const char * TFileCollection::GetDefaultTreeName ( ) const

Returns the tree set with SetDefaultTreeName if set Returns the name of the first tree in the meta data list.

Returns 0 in case no trees are found in the meta data list.

Definition at line 602 of file TFileCollection.cxx.

◆ GetFilesOnServer()

TFileCollection * TFileCollection::GetFilesOnServer ( const char *  server)

Return the subset of files served by 'server'.

The syntax for 'server' is the standard URI one, i.e. [<scheme>://]<host>[:port]

Definition at line 771 of file TFileCollection.cxx.

◆ GetFilesPerServer()

TMap * TFileCollection::GetFilesPerServer ( const char *  exclude = 0,
Bool_t  curronly = kFALSE 
)

Return a map of TFileCollections with the files on each data server, excluding servers in the comma-separated list 'exclude'.

If curronly is kTRUE, only the URL flagged as current in the TFileInfo are considered.

Definition at line 865 of file TFileCollection.cxx.

◆ GetList()

THashList * TFileCollection::GetList ( )
inline

Definition at line 70 of file TFileCollection.h.

◆ GetMetaData()

TFileInfoMeta * TFileCollection::GetMetaData ( const char *  meta = 0) const

Returns the meta data object with the specified meta name.

Returns 0 in case specified meta data is not found.

Definition at line 641 of file TFileCollection.cxx.

◆ GetNCorruptFiles()

Long64_t TFileCollection::GetNCorruptFiles ( ) const
inline

Definition at line 88 of file TFileCollection.h.

◆ GetNFiles()

Long64_t TFileCollection::GetNFiles ( ) const
inline

Definition at line 86 of file TFileCollection.h.

◆ GetNStagedFiles()

Long64_t TFileCollection::GetNStagedFiles ( ) const
inline

Definition at line 87 of file TFileCollection.h.

◆ GetStagedPercentage()

Float_t TFileCollection::GetStagedPercentage ( ) const
inline

Definition at line 89 of file TFileCollection.h.

◆ GetStagedSubset()

TFileCollection * TFileCollection::GetStagedSubset ( )

Creates a subset of the files that have the kStaged & !kCorrupted bit set.

Definition at line 256 of file TFileCollection.cxx.

◆ GetTotalEntries()

Long64_t TFileCollection::GetTotalEntries ( const char *  tree) const

Returns the number of entries for the specified tree (retrieved from meta data).

If tree is not specified, use the default tree name. Returns -1 in case the specified tree is not found.

Definition at line 622 of file TFileCollection.cxx.

◆ GetTotalSize()

Long64_t TFileCollection::GetTotalSize ( ) const
inline

Definition at line 85 of file TFileCollection.h.

◆ Merge()

Long64_t TFileCollection::Merge ( TCollection li)

Merge all TFileCollection objects in li into this TFileCollection object.

Updates counters at the end. Returns the number of merged collections or -1 in case of error.

Definition at line 280 of file TFileCollection.cxx.

◆ operator=()

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

◆ Print()

void TFileCollection::Print ( Option_t option = "") const
virtual

Prints the contents of the TFileCollection.

If option contains:

  • 'M' print global meta information
  • 'F' print all the files in the collection in compact form (current url, default tree name|class|entries, md5)
  • 'L' together with 'F', print all the files in the collection in long form (uuid, md5, all URLs, all meta objects; on many lines)
  • "filter:[SsCc]" invokes PrintDetailed() which prints out dataset content in a formatted fashion by filtering on files which are (S)taged or not (s), (C)orrupted or not (c)

Reimplemented from TNamed.

Definition at line 404 of file TFileCollection.cxx.

◆ PrintDetailed()

void TFileCollection::PrintDetailed ( TString showOnly) const
private

Print detailed.

Definition at line 443 of file TFileCollection.cxx.

◆ RemoveDuplicates()

Int_t TFileCollection::RemoveDuplicates ( )

Remove duplicates based on the UUID, typically after a verification.

Return the number of entries removed.

Definition at line 227 of file TFileCollection.cxx.

◆ RemoveMetaData()

void TFileCollection::RemoveMetaData ( const char *  meta = 0)

Removes the indicated meta data object in all TFileInfos and this object If no name is given all metadata is removed.

Definition at line 666 of file TFileCollection.cxx.

◆ ResetBitAll()

void TFileCollection::ResetBitAll ( UInt_t  f)

Reset the bit for all TFileInfos.

Definition at line 586 of file TFileCollection.cxx.

◆ SetAnchor()

void TFileCollection::SetAnchor ( const char *  anchor)

Calls TUrl::SetAnchor() for all URLs contained in all TFileInfos.

Definition at line 553 of file TFileCollection.cxx.

◆ SetBitAll()

void TFileCollection::SetBitAll ( UInt_t  f)

Set the bit for all TFileInfos.

Definition at line 572 of file TFileCollection.cxx.

◆ SetDefaultMetaData()

void TFileCollection::SetDefaultMetaData ( const char *  meta)

Moves the indicated meta data in the first position, so that it becomes effectively the default.

Definition at line 653 of file TFileCollection.cxx.

◆ SetDefaultTreeName()

void TFileCollection::SetDefaultTreeName ( const char *  treeName)
inline

Definition at line 95 of file TFileCollection.h.

◆ SetList()

void TFileCollection::SetList ( THashList list)
inline

Definition at line 71 of file TFileCollection.h.

◆ Sort()

void TFileCollection::Sort ( Bool_t  useindex = kFALSE)

Sort the collection.

Definition at line 688 of file TFileCollection.cxx.

◆ Update()

Int_t TFileCollection::Update ( Long64_t  avgsize = -1)

Update accumulated information about the elements of the collection (e.g.

fTotalSize). If 'avgsize' > 0, use an average file size of 'avgsize' bytes when the size info is not available. Also updates the meta data information by summarizing the meta data of the contained objects. Return -1 in case of any failure, 0 if the total size is exact, 1 if incomplete, 2 if complete but (at least partially) estimated.

Definition at line 312 of file TFileCollection.cxx.

Member Data Documentation

◆ fDefaultTree

TString TFileCollection::fDefaultTree
private

Definition at line 45 of file TFileCollection.h.

◆ fList

THashList* TFileCollection::fList
private

Definition at line 42 of file TFileCollection.h.

◆ fMetaDataList

TList* TFileCollection::fMetaDataList
private

Definition at line 43 of file TFileCollection.h.

◆ fNCorruptFiles

Long64_t TFileCollection::fNCorruptFiles
private

Definition at line 50 of file TFileCollection.h.

◆ fNFiles

Long64_t TFileCollection::fNFiles
private

Definition at line 47 of file TFileCollection.h.

◆ fNStagedFiles

Long64_t TFileCollection::fNStagedFiles
private

Definition at line 49 of file TFileCollection.h.

◆ fTotalSize

Long64_t TFileCollection::fTotalSize
private

Definition at line 46 of file TFileCollection.h.

  • core/base/inc/TFileCollection.h
  • core/base/src/TFileCollection.cxx