Logo ROOT  
Reference Guide
TFileDrawMap Class Reference

This class is automatically called by TFile::DrawMap. It draws a canvas showing the internal structure of a ROOT file. Each key or basket in a file is shown with a fill area drawn at the byte position of the key/basket in the file. The Y axis of the canvas shows the number of Kbytes/Mbytes. The X axis shows the bytes between y(i) and y(i+1). A color corresponding to the class in the key/basket is automatically selected using the class unique identifier.

When moving the mouse in the canvas, the "Event Status" panels shows the object corresponding to the mouse position. if the object is a key, it shows the class and object name as well as the file directory name if the file has sub-directories.

if the object is a basket, it shows:

  • the name of the Tree
  • the name of the branch
  • the basket number
  • the entry number in the basket

Special keys like the StreamerInfo record, the Keys List Record and the Free Blocks Record are also shown.

When clicking the right mouse button, a pop-up menu is shown with its title identifying the picked object and with the items:

  • DrawObject: in case of a key, the Draw function of the object is called in case of a basket, the branch is drawn for all entries
  • DumpObject: in case of a key, the Dump function of the object is called in case of a basket, tree->Show(entry) is called
  • InspectObject: the Inspect function is called for the object.

The normal axis zoom functionality can be used to zoom or unzoom One can also use the TCanvas context menu SetCanvasSize to make a larger canvas and use the canvas scroll bars.

When the class is built, it is possible to identify a subset of the objects to be shown. For example, to view only the keys with names starting with "abc", set the argument keys to "abc*". The default is to view all the objects. The argument options can also be used (only one option currently) When the option "same" is given, the new picture is suprimposed. The option "same" is useful, eg: to draw all keys with names = "abc" in a first pass then all keys with names = "uv*" in a second pass, etc.

Definition at line 32 of file TFileDrawMap.h.

Public Member Functions

 TFileDrawMap ()
 Default TreeFileMap constructor. More...
 
 TFileDrawMap (const TFile *file, const char *keys, Option_t *option)
 TFileDrawMap normal constructor. More...
 
virtual ~TFileDrawMap ()
 Tree destructor. More...
 
virtual void AnimateTree (const char *branches="")
 Show sequence of baskets reads for the list of baskets involved in the list of branches (separated by ",") More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Compute distance from point px,py to this TreeFileMap. More...
 
virtual void DrawObject ()
 Draw object at the mouse position. More...
 
virtual void DumpObject ()
 Dump object at the mouse position. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to one event. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Redefines TObject::GetObjectInfo. More...
 
virtual void InspectObject ()
 Inspect object at the mouse position. More...
 
virtual void Paint (Option_t *option)
 Paint this TFileDrawMap. 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 TObjectClone (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...
 
TNamedoperator= (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 Delete (Option_t *option="")
 Delete this 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 TObjectDrawClone (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 Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () 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 Option_tGetOption () const
 
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...
 
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
 
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). 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...
 
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. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. 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...
 

Protected Member Functions

virtual void DrawMarker (Int_t marker, Long64_t eseek)
 Draw marker. More...
 
virtual TObjectGetObject ()
 Retrieve object at the mouse position in memory. More...
 
virtual Bool_t GetObjectInfoDir (TDirectory *dir, Int_t px, Int_t py, TString &info) const
 Redefines TObject::GetObjectInfo. More...
 
virtual void PaintBox (TBox &box, Long64_t bseek, Int_t nbytes)
 Paint the object at bseek with nbytes using the box object. More...
 
virtual void PaintDir (TDirectory *dir, const char *keys)
 Paint keys in a directory. 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

TFilefFile
 
TH1fFrame
 
TString fKeys
 
TString fOption
 
Int_t fXsize
 
Int_t fYsize
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Additional Inherited Members

- 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)
}
 
- 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...
 

#include <TFileDrawMap.h>

Inheritance diagram for TFileDrawMap:
[legend]

Constructor & Destructor Documentation

◆ TFileDrawMap() [1/2]

TFileDrawMap::TFileDrawMap ( )

Default TreeFileMap constructor.

Definition at line 81 of file TFileDrawMap.cxx.

◆ TFileDrawMap() [2/2]

TFileDrawMap::TFileDrawMap ( const TFile file,
const char *  keys,
Option_t option 
)

TFileDrawMap normal constructor.

see descriptions of arguments above

Definition at line 93 of file TFileDrawMap.cxx.

◆ ~TFileDrawMap()

TFileDrawMap::~TFileDrawMap ( )
virtual

Tree destructor.

Definition at line 139 of file TFileDrawMap.cxx.

Member Function Documentation

◆ AnimateTree()

void TFileDrawMap::AnimateTree ( const char *  branches = "")
virtual

Show sequence of baskets reads for the list of baskets involved in the list of branches (separated by ",")

  • if branches="", the branch pointed by the mouse is taken.
  • if branches="*", all branches are taken Example:
    AnimateTree("x,y,u"); 
    

Definition at line 153 of file TFileDrawMap.cxx.

◆ DistancetoPrimitive()

Int_t TFileDrawMap::DistancetoPrimitive ( Int_t  px,
Int_t  py 
)
virtual

Compute distance from point px,py to this TreeFileMap.

Find the closest object to the mouse, save its path in the TFileDrawMap name.

Reimplemented from TObject.

Definition at line 227 of file TFileDrawMap.cxx.

◆ DrawMarker()

void TFileDrawMap::DrawMarker ( Int_t  marker,
Long64_t  eseek 
)
protectedvirtual

Draw marker.

Definition at line 243 of file TFileDrawMap.cxx.

◆ DrawObject()

void TFileDrawMap::DrawObject ( )
virtual

Draw object at the mouse position.

Definition at line 281 of file TFileDrawMap.cxx.

◆ DumpObject()

void TFileDrawMap::DumpObject ( )
virtual

Dump object at the mouse position.

Definition at line 318 of file TFileDrawMap.cxx.

◆ ExecuteEvent()

void TFileDrawMap::ExecuteEvent ( Int_t  event,
Int_t  px,
Int_t  py 
)
virtual

Execute action corresponding to one event.

Reimplemented from TObject.

Definition at line 341 of file TFileDrawMap.cxx.

◆ GetObject()

TObject * TFileDrawMap::GetObject ( )
protectedvirtual

Retrieve object at the mouse position in memory.

Definition at line 349 of file TFileDrawMap.cxx.

◆ GetObjectInfo()

char * TFileDrawMap::GetObjectInfo ( Int_t  px,
Int_t  py 
) const
virtual

Redefines TObject::GetObjectInfo.

Displays the keys info in the file corresponding to cursor position px,py in the canvas status bar info panel

Reimplemented from TObject.

Definition at line 371 of file TFileDrawMap.cxx.

◆ GetObjectInfoDir()

Bool_t TFileDrawMap::GetObjectInfoDir ( TDirectory dir,
Int_t  px,
Int_t  py,
TString info 
) const
protectedvirtual

Redefines TObject::GetObjectInfo.

Displays the keys info in the directory corresponding to cursor position px,py

Definition at line 385 of file TFileDrawMap.cxx.

◆ InspectObject()

void TFileDrawMap::InspectObject ( )
virtual

Inspect object at the mouse position.

Definition at line 480 of file TFileDrawMap.cxx.

◆ Paint()

void TFileDrawMap::Paint ( Option_t option)
virtual

Paint this TFileDrawMap.

Reimplemented from TObject.

Definition at line 489 of file TFileDrawMap.cxx.

◆ PaintBox()

void TFileDrawMap::PaintBox ( TBox box,
Long64_t  bseek,
Int_t  nbytes 
)
protectedvirtual

Paint the object at bseek with nbytes using the box object.

Definition at line 512 of file TFileDrawMap.cxx.

◆ PaintDir()

void TFileDrawMap::PaintDir ( TDirectory dir,
const char *  keys 
)
protectedvirtual

Paint keys in a directory.

Definition at line 542 of file TFileDrawMap.cxx.

Member Data Documentation

◆ fFile

TFile* TFileDrawMap::fFile
protected

Definition at line 35 of file TFileDrawMap.h.

◆ fFrame

TH1* TFileDrawMap::fFrame
protected

Definition at line 36 of file TFileDrawMap.h.

◆ fKeys

TString TFileDrawMap::fKeys
protected

Definition at line 37 of file TFileDrawMap.h.

◆ fOption

TString TFileDrawMap::fOption
protected

Definition at line 38 of file TFileDrawMap.h.

◆ fXsize

Int_t TFileDrawMap::fXsize
protected

Definition at line 39 of file TFileDrawMap.h.

◆ fYsize

Int_t TFileDrawMap::fYsize
protected

Definition at line 40 of file TFileDrawMap.h.

Libraries for TFileDrawMap:
[legend]

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