ROOT 6.18/05 Reference Guide |
Class describing a generic file including meta information.
Definition at line 38 of file TFileInfo.h.
Public Types | |
enum | EStatusBits { kStaged = BIT(15) , kCorrupted = BIT(16) , kSortWithIndex = BIT(17) } |
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 | |
TFileInfo (const char *url=0, Long64_t size=-1, const char *uuid=0, const char *md5=0, TObject *meta=0) | |
Constructor. More... | |
TFileInfo (const TFileInfo &) | |
Copy constructor. More... | |
virtual | ~TFileInfo () |
Destructor. More... | |
Bool_t | AddMetaData (TObject *meta) |
Add's a meta data object to the file info object. More... | |
Bool_t | AddUrl (const char *url, Bool_t infront=kFALSE) |
Add a new URL. More... | |
Int_t | Compare (const TObject *obj) const |
Compare TFileInfo object by their first urls. More... | |
TUrl * | FindByUrl (const char *url, Bool_t withDeflt=kFALSE) |
Find an element from a URL. Returns 0 if not found. More... | |
TUrl * | GetCurrentUrl () const |
Return the current url. More... | |
TUrl * | GetFirstUrl () const |
Int_t | GetIndex () const |
TMD5 * | GetMD5 () const |
TFileInfoMeta * | GetMetaData (const char *meta=0) const |
Get meta data object with specified name. More... | |
TList * | GetMetaDataList () const |
Int_t | GetNUrls () const |
Long64_t | GetSize () const |
TUrl * | GetUrlAt (Int_t i) const |
TUUID * | GetUUID () const |
Bool_t | IsSortable () const |
TUrl * | NextUrl () |
Iterator function, start iteration by calling ResetUrl(). More... | |
void | Print (Option_t *options="") const |
Print information about this object. More... | |
Bool_t | RemoveMetaData (const char *meta=0) |
Remove the metadata object. More... | |
Bool_t | RemoveUrl (const char *url) |
Remove an URL. Returns kTRUE if successful, kFALSE otherwise. More... | |
Bool_t | RemoveUrlAt (Int_t i) |
Remove URL at given position. Returns kTRUE on success, kFALSE on error. More... | |
void | ResetUrl () |
Bool_t | SetCurrentUrl (const char *url) |
Set 'url' as current URL, if in the list Return kFALSE if not in the list. More... | |
Bool_t | SetCurrentUrl (TUrl *url) |
Set 'url' as current URL, if in the list Return kFALSE if not in the list. More... | |
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'. More... | |
Public Member Functions inherited from TNamed | |
TNamed () | |
TNamed (const char *name, const char *title) | |
TNamed (const TNamed &named) | |
TNamed copy ctor. More... | |
TNamed (const TString &name, const TString &title) | |
virtual | ~TNamed () |
TNamed destructor. More... | |
virtual void | Clear (Option_t *option="") |
Set name and title to empty strings (""). More... | |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. More... | |
virtual Int_t | Compare (const TObject *obj) const |
Compare two TNamed objects. More... | |
virtual void | Copy (TObject &named) const |
Copy this to obj. More... | |
virtual void | FillBuffer (char *&buffer) |
Encode TNamed into output buffer. More... | |
virtual const char * | GetName () const |
Returns name of object. More... | |
virtual const char * | GetTitle () const |
Returns title of object. More... | |
virtual ULong_t | Hash () const |
Return hash value for this object. More... | |
virtual Bool_t | IsSortable () const |
virtual void | ls (Option_t *option="") const |
List TNamed name and title. More... | |
TNamed & | operator= (const TNamed &rhs) |
TNamed assignment operator. More... | |
virtual void | Print (Option_t *option="") const |
Print TNamed name and title. More... | |
virtual void | SetName (const char *name) |
Set the name of the TNamed. More... | |
virtual void | SetNameTitle (const char *name, const char *title) |
Set all the TNamed parameters (name and title). More... | |
virtual void | SetTitle (const char *title="") |
Set the title of the TNamed. More... | |
virtual Int_t | Sizeof () const |
Return size of the TNamed part of the TObject. More... | |
Public Member Functions inherited from TObject | |
TObject () | |
TObject constructor. More... | |
TObject (const TObject &object) | |
TObject copy ctor. More... | |
virtual | ~TObject () |
TObject destructor. More... | |
void | AbstractMethod (const char *method) const |
Use this method to implement an "abstract" method that you don't want to leave purely abstract. More... | |
virtual void | AppendPad (Option_t *option="") |
Append graphics object to current pad. More... | |
virtual void | Browse (TBrowser *b) |
Browse object. May be overridden for another default action. More... | |
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. More... | |
virtual const char * | ClassName () const |
Returns name of class to which the object belongs. More... | |
virtual void | Clear (Option_t *="") |
virtual TObject * | Clone (const char *newname="") const |
Make a clone of an object using the Streamer facility. More... | |
virtual Int_t | Compare (const TObject *obj) const |
Compare abstract method. More... | |
virtual void | Copy (TObject &object) const |
Copy this to obj. More... | |
virtual void | Delete (Option_t *option="") |
Delete this object. More... | |
virtual Int_t | DistancetoPrimitive (Int_t px, Int_t py) |
Computes distance from point (px,py) to the object. More... | |
virtual void | Draw (Option_t *option="") |
Default Draw method for all objects. More... | |
virtual void | DrawClass () const |
Draw class inheritance tree of the class to which this object belongs. More... | |
virtual TObject * | DrawClone (Option_t *option="") const |
Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad) . More... | |
virtual void | Dump () const |
Dump contents of object on stdout. More... | |
virtual void | Error (const char *method, const char *msgfmt,...) const |
Issue error message. More... | |
virtual void | Execute (const char *method, const char *params, Int_t *error=0) |
Execute method on this object with the given parameter string, e.g. More... | |
virtual void | Execute (TMethod *method, TObjArray *params, Int_t *error=0) |
Execute method on this object with parameters stored in the TObjArray. More... | |
virtual void | ExecuteEvent (Int_t event, Int_t px, Int_t py) |
Execute action corresponding to an event at (px,py). More... | |
virtual void | Fatal (const char *method, const char *msgfmt,...) const |
Issue fatal error message. More... | |
virtual TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. More... | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. More... | |
virtual Option_t * | GetDrawOption () const |
Get option used by the graphics system to draw this object. More... | |
virtual const char * | GetIconName () const |
Returns mime type name of object. More... | |
virtual const char * | GetName () const |
Returns name of object. More... | |
virtual char * | GetObjectInfo (Int_t px, Int_t py) const |
Returns string containing info about the object at position (px,py). More... | |
virtual Option_t * | GetOption () const |
virtual const char * | GetTitle () const |
Returns title of object. More... | |
virtual UInt_t | GetUniqueID () const |
Return the unique object id. More... | |
virtual Bool_t | HandleTimer (TTimer *timer) |
Execute action in response of a timer timing out. More... | |
virtual ULong_t | Hash () const |
Return hash value for this object. More... | |
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. More... | |
virtual void | Info (const char *method, const char *msgfmt,...) const |
Issue info message. More... | |
virtual Bool_t | InheritsFrom (const char *classname) const |
Returns kTRUE if object inherits from class "classname". More... | |
virtual Bool_t | InheritsFrom (const TClass *cl) const |
Returns kTRUE if object inherits from TClass cl. More... | |
virtual void | Inspect () const |
Dump contents of this object in a graphics canvas. More... | |
void | InvertBit (UInt_t f) |
virtual Bool_t | IsEqual (const TObject *obj) const |
Default equal comparison (objects are equal if they have the same address in memory). More... | |
virtual Bool_t | IsFolder () const |
Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More... | |
R__ALWAYS_INLINE Bool_t | IsOnHeap () const |
virtual Bool_t | IsSortable () const |
R__ALWAYS_INLINE Bool_t | IsZombie () const |
virtual void | ls (Option_t *option="") const |
The ls function lists the contents of a class on stdout. More... | |
void | MayNotUse (const char *method) const |
Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More... | |
virtual Bool_t | Notify () |
This method must be overridden to handle object notification. More... | |
void | Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const |
Use this method to declare a method obsolete. More... | |
void | operator delete (void *ptr) |
Operator delete. More... | |
void | operator delete[] (void *ptr) |
Operator delete []. More... | |
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) |
TObject & | operator= (const TObject &rhs) |
TObject assignment operator. More... | |
virtual void | Paint (Option_t *option="") |
This method must be overridden if a class wants to paint itself. More... | |
virtual void | Pop () |
Pop on object drawn in a pad to the top of the display list. More... | |
virtual void | Print (Option_t *option="") const |
This method must be overridden when a class wants to print itself. More... | |
virtual Int_t | Read (const char *name) |
Read contents of object with specified name from the current directory. More... | |
virtual void | RecursiveRemove (TObject *obj) |
Recursively remove this object from a list. More... | |
void | ResetBit (UInt_t f) |
virtual void | SaveAs (const char *filename="", Option_t *option="") const |
Save this object in the file specified by filename. More... | |
virtual void | SavePrimitive (std::ostream &out, Option_t *option="") |
Save a primitive as a C++ statement(s) on output stream "out". More... | |
void | SetBit (UInt_t f) |
void | SetBit (UInt_t f, Bool_t set) |
Set or unset the user status bits as specified in f. More... | |
virtual void | SetDrawOption (Option_t *option="") |
Set drawing option for object. More... | |
virtual void | SetUniqueID (UInt_t uid) |
Set the unique object id. More... | |
virtual void | SysError (const char *method, const char *msgfmt,...) const |
Issue system error message. More... | |
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. More... | |
virtual void | Warning (const char *method, const char *msgfmt,...) const |
Issue warning message. More... | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) |
Write this object to the current directory. More... | |
virtual Int_t | Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const |
Write this object to the current directory. More... | |
Private Member Functions | |
TFileInfo & | operator= (const TFileInfo &) |
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: More... | |
Private Attributes | |
TUrl * | fCurrentUrl |
Int_t | fIndex |
TMD5 * | fMD5 |
TList * | fMetaDataList |
Long64_t | fSize |
TList * | fUrlList |
current URL to access the file, points to URL More... | |
TUUID * | fUUID |
Additional Inherited Members | |
Static Public Member Functions inherited from TObject | |
static Long_t | GetDtorOnly () |
Return destructor only flag. More... | |
static Bool_t | GetObjectStat () |
Get status of object stat flag. More... | |
static void | SetDtorOnly (void *obj) |
Set destructor only flag. More... | |
static void | SetObjectStat (Bool_t stat) |
Turn on/off tracking of objects in the TObjectTable. More... | |
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). More... | |
void | MakeZombie () |
Protected Attributes inherited from TNamed | |
TString | fName |
TString | fTitle |
#include <TFileInfo.h>
Enumerator | |
---|---|
kStaged | |
kCorrupted | |
kSortWithIndex |
Definition at line 56 of file TFileInfo.h.
TFileInfo::TFileInfo | ( | const char * | url = 0 , |
Long64_t | size = -1 , |
||
const char * | uuid = 0 , |
||
const char * | md5 = 0 , |
||
TObject * | meta = 0 |
||
) |
Constructor.
Definition at line 31 of file TFileInfo.cxx.
TFileInfo::TFileInfo | ( | const TFileInfo & | fi | ) |
Copy constructor.
Definition at line 73 of file TFileInfo.cxx.
|
virtual |
Destructor.
Definition at line 119 of file TFileInfo.cxx.
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 384 of file TFileInfo.cxx.
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 295 of file TFileInfo.cxx.
Compare TFileInfo object by their first urls.
Reimplemented from TNamed.
Definition at line 443 of file TFileInfo.cxx.
Find an element from a URL. Returns 0 if not found.
Definition at line 276 of file TFileInfo.cxx.
TUrl * TFileInfo::GetCurrentUrl | ( | ) | const |
Return the current url.
Definition at line 248 of file TFileInfo.cxx.
|
inline |
Definition at line 71 of file TFileInfo.h.
|
inline |
Definition at line 98 of file TFileInfo.h.
|
inline |
Definition at line 81 of file TFileInfo.h.
TFileInfoMeta * TFileInfo::GetMetaData | ( | const char * | meta = 0 | ) | 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 424 of file TFileInfo.cxx.
|
inline |
Definition at line 82 of file TFileInfo.h.
|
inline |
Definition at line 74 of file TFileInfo.h.
|
inline |
Definition at line 79 of file TFileInfo.h.
Definition at line 72 of file TFileInfo.h.
|
inline |
Definition at line 80 of file TFileInfo.h.
|
inlinevirtual |
Reimplemented from TNamed.
Definition at line 95 of file TFileInfo.h.
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 260 of file TFileInfo.cxx.
|
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 givensz:<size>
size of the file in bytesmd5:<md5_ascii>
MD5 sum of the file in ASCII formuuid:<uuid>
UUID of the filetree:<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 indexMultiple 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 156 of file TFileInfo.cxx.
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 TNamed.
Definition at line 477 of file TFileInfo.cxx.
Bool_t TFileInfo::RemoveMetaData | ( | const char * | meta = 0 | ) |
Remove the metadata object.
If meta is 0 remove all meta data objects. Returns kTRUE if successful, kFALSE otherwise.
Definition at line 401 of file TFileInfo.cxx.
Bool_t TFileInfo::RemoveUrl | ( | const char * | url | ) |
Remove an URL. Returns kTRUE if successful, kFALSE otherwise.
Definition at line 320 of file TFileInfo.cxx.
Remove URL at given position. Returns kTRUE on success, kFALSE on error.
Definition at line 336 of file TFileInfo.cxx.
|
inline |
Definition at line 68 of file TFileInfo.h.
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 354 of file TFileInfo.cxx.
Set 'url' as current URL, if in the list Return kFALSE if not in the list.
Definition at line 368 of file TFileInfo.cxx.
Definition at line 99 of file TFileInfo.h.
Definition at line 85 of file TFileInfo.h.
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 237 of file TFileInfo.cxx.
|
private |
Definition at line 41 of file TFileInfo.h.
|
private |
Definition at line 49 of file TFileInfo.h.
|
private |
Definition at line 46 of file TFileInfo.h.
|
private |
Definition at line 47 of file TFileInfo.h.
|
private |
Definition at line 44 of file TFileInfo.h.
|
private |
current URL to access the file, points to URL
Definition at line 43 of file TFileInfo.h.
|
private |
Definition at line 45 of file TFileInfo.h.