Logo ROOT  
Reference Guide
TFileInfo.h
Go to the documentation of this file.
1// @(#)root/base:$Id$
2// Author: Andreas-Joachim Peters 20/9/2005
3
4/*************************************************************************
5 * Copyright (C) 1995-2005, Rene Brun and Fons Rademakers. *
6 * All rights reserved. *
7 * *
8 * For the licensing terms see $ROOTSYS/LICENSE. *
9 * For the list of contributors see $ROOTSYS/README/CREDITS. *
10 *************************************************************************/
11
12#ifndef ROOT_TFileInfo
13#define ROOT_TFileInfo
14
15//////////////////////////////////////////////////////////////////////////
16// //
17// TFileInfo //
18// //
19// Class describing a generic file including meta information. //
20// //
21//////////////////////////////////////////////////////////////////////////
22
23#include "TNamed.h"
24#include "TList.h"
25
26#ifdef R__LESS_INCLUDES
27class TUrl;
28class TUUID;
29class TMD5;
30#else
31#include "TUrl.h"
32#include "TUUID.h"
33#include "TMD5.h"
34#endif
35
36class TFileInfoMeta;
37
38
39class TFileInfo : public TNamed {
40
41private:
42 TUrl *fCurrentUrl; //! current URL to access the file, points to URL
43 // in the fUrlList or 0, if the list end is reached
44 TList *fUrlList; // list of file URLs
45 Long64_t fSize; // file size
46 TUUID *fUUID; //-> uuid of the referenced file
47 TMD5 *fMD5; //-> md5 digest of the file
48 TList *fMetaDataList; // generic list of file meta data object(s)
49
50 Int_t fIndex; // Index to be used when sorting with index
51
52 void ParseInput(const char *in);
53
54 TFileInfo& operator=(const TFileInfo&) = delete;
55
56public:
58 kStaged = BIT(15),
60 kSortWithIndex = BIT(17) // Use index when sorting (in Compare)
61 };
62
63 TFileInfo(const char *url = 0, Long64_t size = -1, const char *uuid = 0,
64 const char *md5 = 0, TObject *meta = 0);
65 TFileInfo(const TFileInfo &);
66
67 virtual ~TFileInfo();
68
70 TUrl *NextUrl();
71 TUrl *GetCurrentUrl() const;
72 TUrl *GetFirstUrl() const { return (TUrl*)fUrlList->First(); }
73 TUrl *GetUrlAt(Int_t i) const { return (TUrl*)fUrlList->At(i); }
75 Int_t GetNUrls() const { return fUrlList->GetEntries(); }
76
77 Bool_t SetCurrentUrl(const char *url);
79
80 Long64_t GetSize() const { return fSize; }
81 TUUID *GetUUID() const { return fUUID; }
82 TMD5 *GetMD5() const { return fMD5; }
83 TList *GetMetaDataList() const { return fMetaDataList; }
84 TFileInfoMeta *GetMetaData(const char *meta = 0) const;
85
87 void SetUUID(const char *uuid);
88
89 TUrl *FindByUrl(const char *url, Bool_t withDeflt = kFALSE);
90
91 Bool_t AddUrl(const char *url, Bool_t infront = kFALSE);
92 Bool_t RemoveUrl(const char *url);
94 Bool_t RemoveMetaData(const char *meta = 0);
95
96 Bool_t IsSortable() const { return kTRUE; }
97 Int_t Compare(const TObject *obj) const;
98
99 Int_t GetIndex() const { return fIndex; }
100 void SetIndex(Int_t idx) { fIndex = idx; }
101
102 void Print(Option_t *options="") const;
103
104 ClassDef(TFileInfo,4) // Describes generic file info including meta data information
105};
106
107
108class TFileInfoMeta : public TNamed {
109
110private:
111 Long64_t fEntries; // number of entries in tree or number of objects
112 Long64_t fFirst; // first valid tree entry
113 Long64_t fLast; // last valid tree entry
114 Bool_t fIsTree; // true if type is a TTree (or TTree derived)
115 Long64_t fTotBytes; // uncompressed size in bytes
116 Long64_t fZipBytes; // compressed size in bytes
117
119
120public:
121 enum EStatusBits { kExternal = BIT(15) };
122
126 TFileInfoMeta(const char *objPath, const char *objClass = "TTree",
127 Long64_t entries = -1, Long64_t first = 0, Long64_t last = -1,
128 Long64_t totbytes = -1, Long64_t zipbytes = -1);
129 TFileInfoMeta(const char *objPath, const char *objDir,
130 const char *objClass, Long64_t entries = -1,
131 Long64_t first = 0, Long64_t last = -1,
132 Long64_t totbytes = -1, Long64_t zipbytes = -1);
134
135 virtual ~TFileInfoMeta() { }
136
137 const char *GetObject() const;
138 const char *GetClass() const { return GetTitle(); }
139 const char *GetDirectory() const;
140 Long64_t GetEntries() const { return fEntries; }
141 Long64_t GetFirst() const { return fFirst; }
142 Long64_t GetLast() const { return fLast; }
143 Bool_t IsTree() const { return fIsTree; }
144 Long64_t GetTotBytes() const { return fTotBytes; }
145 Long64_t GetZipBytes() const { return fZipBytes; }
146
147 void SetEntries(Long64_t entries) { fEntries = entries; }
149 void SetLast(Long64_t last) { fLast = last; }
150 void SetTotBytes(Long64_t tot) { fTotBytes = tot; }
151 void SetZipBytes(Long64_t zip) { fZipBytes = zip; }
152
153 void Print(Option_t *options="") const;
154
155 ClassDef(TFileInfoMeta,2) // Describes TFileInfo meta data
156};
157
158#endif
int Int_t
Definition: CPyCppyy.h:43
size_t size(const MatrixT &matrix)
retrieve the size of a square matrix
const Bool_t kFALSE
Definition: RtypesCore.h:101
bool Bool_t
Definition: RtypesCore.h:63
const Bool_t kTRUE
Definition: RtypesCore.h:100
const char Option_t
Definition: RtypesCore.h:66
#define ClassDef(name, id)
Definition: Rtypes.h:325
#define BIT(n)
Definition: Rtypes.h:85
virtual Int_t GetEntries() const
Definition: TCollection.h:177
Long64_t GetZipBytes() const
Definition: TFileInfo.h:145
TFileInfoMeta & operator=(const TFileInfoMeta &)=delete
Long64_t GetFirst() const
Definition: TFileInfo.h:141
Long64_t GetLast() const
Definition: TFileInfo.h:142
virtual ~TFileInfoMeta()
Definition: TFileInfo.h:135
Bool_t IsTree() const
Definition: TFileInfo.h:143
const char * GetDirectory() const
Get the object's directory in the ROOT file.
Definition: TFileInfo.cxx:581
void Print(Option_t *options="") const
Print information about this object.
Definition: TFileInfo.cxx:598
Long64_t GetTotBytes() const
Definition: TFileInfo.h:144
void SetFirst(Long64_t first)
Definition: TFileInfo.h:148
Bool_t fIsTree
Definition: TFileInfo.h:114
Long64_t fZipBytes
Definition: TFileInfo.h:116
Long64_t fFirst
Definition: TFileInfo.h:112
Long64_t fTotBytes
Definition: TFileInfo.h:115
void SetLast(Long64_t last)
Definition: TFileInfo.h:149
Long64_t fLast
Definition: TFileInfo.h:113
const char * GetObject() const
Get the object name, with path stripped off.
Definition: TFileInfo.cxx:590
void SetTotBytes(Long64_t tot)
Definition: TFileInfo.h:150
Long64_t fEntries
Definition: TFileInfo.h:111
Long64_t GetEntries() const
Definition: TFileInfo.h:140
const char * GetClass() const
Definition: TFileInfo.h:138
void SetZipBytes(Long64_t zip)
Definition: TFileInfo.h:151
void SetEntries(Long64_t entries)
Definition: TFileInfo.h:147
Class describing a generic file including meta information.
Definition: TFileInfo.h:39
virtual ~TFileInfo()
Destructor.
Definition: TFileInfo.cxx:120
Int_t Compare(const TObject *obj) const
Compare TFileInfo object by their first urls.
Definition: TFileInfo.cxx:444
TList * fUrlList
current URL to access the file, points to URL
Definition: TFileInfo.h:44
void Print(Option_t *options="") const
Print information about this object.
Definition: TFileInfo.cxx:478
Int_t GetIndex() const
Definition: TFileInfo.h:99
TUrl * fCurrentUrl
Definition: TFileInfo.h:42
TUUID * fUUID
Definition: TFileInfo.h:46
@ kSortWithIndex
Definition: TFileInfo.h:60
@ kCorrupted
Definition: TFileInfo.h:59
TUrl * NextUrl()
Iterator function, start iteration by calling ResetUrl().
Definition: TFileInfo.cxx:261
Bool_t AddUrl(const char *url, Bool_t infront=kFALSE)
Add a new URL.
Definition: TFileInfo.cxx:296
Bool_t RemoveUrlAt(Int_t i)
Remove URL at given position. Returns kTRUE on success, kFALSE on error.
Definition: TFileInfo.cxx:337
TList * GetMetaDataList() const
Definition: TFileInfo.h:83
Bool_t AddMetaData(TObject *meta)
Add's a meta data object to the file info object.
Definition: TFileInfo.cxx:385
Bool_t RemoveUrl(const char *url)
Remove an URL. Returns kTRUE if successful, kFALSE otherwise.
Definition: TFileInfo.cxx:321
TFileInfo & operator=(const TFileInfo &)=delete
Int_t fIndex
Definition: TFileInfo.h:50
TMD5 * GetMD5() const
Definition: TFileInfo.h:82
Bool_t RemoveMetaData(const char *meta=0)
Remove the metadata object.
Definition: TFileInfo.cxx:402
TUrl * GetFirstUrl() const
Definition: TFileInfo.h:72
Long64_t GetSize() const
Definition: TFileInfo.h:80
Long64_t fSize
Definition: TFileInfo.h:45
Int_t GetNUrls() const
Definition: TFileInfo.h:75
Bool_t SetCurrentUrl(const char *url)
Set 'url' as current URL, if in the list Return kFALSE if not in the list.
Definition: TFileInfo.cxx:355
Bool_t IsSortable() const
Definition: TFileInfo.h:96
TUrl * FindByUrl(const char *url, Bool_t withDeflt=kFALSE)
Find an element from a URL. Returns 0 if not found.
Definition: TFileInfo.cxx:277
void ResetUrl()
Definition: TFileInfo.h:69
TFileInfo(const char *url=0, Long64_t size=-1, const char *uuid=0, const char *md5=0, TObject *meta=0)
Constructor.
Definition: TFileInfo.cxx:32
void SetIndex(Int_t idx)
Definition: TFileInfo.h:100
TUrl * GetCurrentUrl() const
Return the current url.
Definition: TFileInfo.cxx:249
TFileInfoMeta * GetMetaData(const char *meta=0) const
Get meta data object with specified name.
Definition: TFileInfo.cxx:425
void SetUUID(const char *uuid)
Set the UUID to the value associated to the string 'uuid'.
Definition: TFileInfo.cxx:238
TUUID * GetUUID() const
Definition: TFileInfo.h:81
TList * fMetaDataList
Definition: TFileInfo.h:48
TUrl * GetUrlAt(Int_t i) const
Definition: TFileInfo.h:73
TMD5 * fMD5
Definition: TFileInfo.h:47
void ParseInput(const char *in)
Parse the input line to extract init information from 'in'; the input string is tokenized on ' '; the...
Definition: TFileInfo.cxx:157
void SetSize(Long64_t size)
Definition: TFileInfo.h:86
A doubly linked list.
Definition: TList.h:44
virtual TObject * At(Int_t idx) const
Returns the object at position idx. Returns 0 if idx is out of range.
Definition: TList.cxx:357
virtual TObject * First() const
Return the first object in the list. Returns 0 when list is empty.
Definition: TList.cxx:659
This code implements the MD5 message-digest algorithm.
Definition: TMD5.h:44
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
virtual const char * GetTitle() const
Returns title of object.
Definition: TNamed.h:48
Mother of all ROOT objects.
Definition: TObject.h:37
void ResetBit(UInt_t f)
Definition: TObject.h:186
This class defines a UUID (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDent...
Definition: TUUID.h:42
This class represents a WWW compatible URL.
Definition: TUrl.h:33
long long Long64_t
Definition: cpp_cppyy.h:13
Definition: first.py:1
auto * m
Definition: textangle.C:8