Draw inheritance tree and their relations for a list of classes.
The following options are supported
The list of classes is specified:
Note that the ClassTree viewer can also be started from the canvas pull down menu "Classes".
In the list of classes, class names are separated by a ":" wildcarding is supported. The following formats are supported, eg in TClassTree::Draw
Draw("ClassA")
Draw("*ClassB")
Draw(">ClassC")
Draw("ClassD<")
Draw("Cla*")
Draw("ClassA:ClassB<")
Example: Draw("TTree<")
By default, only direct inheritance is drawn. Use TClassTree::ShowLinks(option) to show additional references
The following picture is produced directly by:
It shows all the classes derived from the base class TH1.
The TClassTree class uses the services of the class TPaveClass to show the class names. By clicking with the right mouse button in one TPaveClass object, one can invoke the following functions of TClassTree:
The following picture has been generated with the following statements
Note that in case of embedded classes or pointers to classes, the corresponding dashed lines or arrows respectively start in the TPaveClass object at an X position reflecting the position in the list of data members.
Use TClassTree::SetSourceDir to specify the search path for source files. By default the search path includes the $ROOTSYS
directory, the current directory and the subdirectory src
.
The first time TClassTree::Draw is invoked, all the classes in the current application are processed, including the parsing of the code to find all classes referenced by the include statements. This process may take a few seconds. The following commands will be much faster.
A TClassTree object may be saved in a Root file. This object can be processed later by a Root program that ignores the original classes. This interesting possibility allows to send the class structure of an application to a colleague who does not have your classes.
Example:
You can send at this point the file myClass.root to a colleague who can run the following Root basic session
At this point, one has still access to all the classes present in the original session and select any combination of these classes to be displayed.
Definition at line 22 of file TClassTree.h.
Public Member Functions | |
TClassTree () | |
TClassTree default constructor. | |
TClassTree (const char *name, const char *classes="") | |
TClassTree constructor. | |
virtual | ~TClassTree () |
TClassTree default destructor. | |
virtual void | Draw (const char *classes="") |
Draw the inheritance tree and relations for the list of classes see this class header for the syntax and examples. | |
virtual Int_t | FindClass (const char *classname) |
Find class number corresponding to classname in list of local classes. | |
const char * | GetClasses () const |
virtual const char * | GetSourceDir () const |
virtual void | ls (Option_t *option="") const |
list classes names and titles | |
virtual void | Paint (Option_t *option="") |
Draw the current class setting in fClasses and fStatus. | |
virtual void | SaveAs (const char *filename="", Option_t *option="") const |
save current configuration in a Root file if filename is blank, the name of the file will be the current objectname.root all the current settings are preserved the Root file produced can be looked at by a another Root session with no access to the original classes. | |
virtual void | SetClasses (const char *classes, Option_t *option="ID") |
Set the list of classes for which the hierarchy is to be drawn See Paint for the syntax. | |
virtual void | SetLabelDx (Float_t labeldx=0.15) |
Set the size along x of the TPaveLabel showing the class name. | |
virtual void | SetSourceDir (const char *dir="src") |
virtual void | SetYoffset (Float_t offset=0) |
Set the offset at the top of the picture The default offset is computed automatically taking into account classes not inheriting from TObject. | |
virtual void | ShowClassesUsedBy (const char *classes) |
mark classes used by the list of classes in classes | |
virtual void | ShowClassesUsing (const char *classes) |
mark classes using any class in the list of classes in classes | |
virtual void | ShowLinks (Option_t *option="HMR") |
Set link options in the ClassTree object. | |
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 TObject * | Clone (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 |
TNamed & | operator= (const TNamed &rhs) |
TNamed assignment operator. | |
virtual void | Print (Option_t *option="") const |
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. | |
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 | DrawClass () const |
Draw class inheritance tree of the class to which this object belongs. | |
virtual TObject * | DrawClone (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 TObject * | FindObject (const char *name) const |
Must be redefined in derived classes. | |
virtual TObject * | FindObject (const TObject *obj) const |
Must be redefined in derived classes. | |
virtual Option_t * | GetDrawOption () 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_t * | GetOption () 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 []. | |
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. | |
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 | 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. | |
Protected Member Functions | |
virtual void | FindClassesUsedBy (Int_t iclass) |
Select all classes used/referenced by the class number iclass. | |
virtual void | FindClassesUsing (Int_t iclass) |
Select all classes using/referencing the class number iclass. | |
virtual void | FindClassPosition (const char *classname, Float_t &x, Float_t &y) |
Search the TPaveClass object in the pad with label=classname returns the x and y position of the center of the pave. | |
virtual void | Init () |
Initialize the data structures. | |
TObjString * | Mark (const char *classname, TList *los, Int_t abit) |
set bit abit in class classname in list los | |
virtual void | PaintClass (Int_t iclass, Float_t xleft, Float_t y) |
Paint one class level. | |
virtual void | ScanClasses (Int_t iclass) |
Select all classes used by/referenced/referencing the class number iclass and build the list of these classes. | |
virtual void | ShowCod () |
Draw the Code References relationships. | |
virtual void | ShowHas () |
Draw the "Has a" relationships. | |
virtual void | ShowMul () |
Draw the Multiple inheritance relationships. | |
virtual void | ShowRef () |
Draw the References relationships (other than inheritance or composition) | |
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 | |
TString | fClasses |
List of classes to be drawn. | |
TString ** | fCnames |
![fNclasses] class names | |
Int_t * | fCparent |
!parent number of classes (temporary) | |
TClass ** | fCpointer |
![fNclasses] pointers to the TClass objects | |
Int_t * | fCstatus |
[fNclasses] classes status | |
TString ** | fCtitles |
![fNclasses] class titles | |
char ** | fDerived |
![fNclasses] table to indicate if i derives from j | |
Float_t | fLabelDx |
width along x of TPaveLabels in per cent of pad | |
TList ** | fLinks |
![fNclasses] for each class, the list of referenced(ing) classes | |
Int_t | fNclasses |
current number of classes | |
Int_t * | fNdata |
[fNclasses] Number of data members per class | |
std::vector< Int_t > | fNsons |
! internal variable, used during painting | |
std::vector< Int_t > | fNtsons |
! internal variable, used during painting | |
TString ** | fOptions |
![fNclasses] List of options per class | |
Int_t * | fParents |
[fNclasses] parent number of classes (permanent) | |
Int_t | fShowCod |
if 1 show classes referenced by implementation | |
Int_t | fShowHas |
if 1 show "has a" relationship | |
Int_t | fShowMul |
if 1 show multiple inheritance | |
Int_t | fShowRef |
if 1 show classes relationship other than inheritance | |
TString | fSourceDir |
Concatenated source directories. | |
Float_t | fYoffset |
offset at top of picture in per cent of pad | |
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 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) } |
#include <TClassTree.h>
TClassTree::TClassTree | ( | ) |
TClassTree default constructor.
Definition at line 180 of file TClassTree.cxx.
TClassTree::TClassTree | ( | const char * | name, |
const char * | classes = "" |
||
) |
TClassTree constructor.
Definition at line 205 of file TClassTree.cxx.
|
virtual |
TClassTree default destructor.
Definition at line 237 of file TClassTree.cxx.
|
virtual |
Draw the inheritance tree and relations for the list of classes see this class header for the syntax and examples.
Reimplemented from TObject.
Definition at line 261 of file TClassTree.cxx.
|
virtual |
Find class number corresponding to classname in list of local classes.
Definition at line 278 of file TClassTree.cxx.
Select all classes used/referenced by the class number iclass.
Definition at line 289 of file TClassTree.cxx.
Select all classes using/referencing the class number iclass.
Definition at line 313 of file TClassTree.cxx.
|
protectedvirtual |
Search the TPaveClass object in the pad with label=classname returns the x and y position of the center of the pave.
Definition at line 339 of file TClassTree.cxx.
|
inline |
Definition at line 65 of file TClassTree.h.
|
inlinevirtual |
Definition at line 66 of file TClassTree.h.
|
protectedvirtual |
Initialize the data structures.
Definition at line 360 of file TClassTree.cxx.
list classes names and titles
Reimplemented from TNamed.
Definition at line 425 of file TClassTree.cxx.
|
protected |
set bit abit in class classname in list los
Definition at line 439 of file TClassTree.cxx.
Draw the current class setting in fClasses and fStatus.
Reimplemented from TObject.
Definition at line 454 of file TClassTree.cxx.
Paint one class level.
Definition at line 635 of file TClassTree.cxx.
save current configuration in a Root file if filename is blank, the name of the file will be the current objectname.root all the current settings are preserved the Root file produced can be looked at by a another Root session with no access to the original classes.
By default a message is printed. Specify option "Q" to remove the message
Reimplemented from TObject.
Definition at line 683 of file TClassTree.cxx.
Select all classes used by/referenced/referencing the class number iclass and build the list of these classes.
Definition at line 692 of file TClassTree.cxx.
Set the list of classes for which the hierarchy is to be drawn See Paint for the syntax.
Definition at line 859 of file TClassTree.cxx.
Set the size along x of the TPaveLabel showing the class name.
Definition at line 873 of file TClassTree.cxx.
|
inlinevirtual |
Definition at line 71 of file TClassTree.h.
Set the offset at the top of the picture The default offset is computed automatically taking into account classes not inheriting from TObject.
Definition at line 884 of file TClassTree.cxx.
|
virtual |
mark classes used by the list of classes in classes
Definition at line 893 of file TClassTree.cxx.
|
virtual |
mark classes using any class in the list of classes in classes
Definition at line 924 of file TClassTree.cxx.
|
protectedvirtual |
Draw the Code References relationships.
Definition at line 955 of file TClassTree.cxx.
|
protectedvirtual |
Draw the "Has a" relationships.
Definition at line 993 of file TClassTree.cxx.
Set link options in the ClassTree object.
Definition at line 1038 of file TClassTree.cxx.
|
protectedvirtual |
Draw the Multiple inheritance relationships.
Definition at line 1053 of file TClassTree.cxx.
|
protectedvirtual |
Draw the References relationships (other than inheritance or composition)
Definition at line 1091 of file TClassTree.cxx.
|
protected |
List of classes to be drawn.
Definition at line 25 of file TClassTree.h.
|
protected |
![fNclasses] class names
Definition at line 39 of file TClassTree.h.
|
protected |
!parent number of classes (temporary)
Definition at line 36 of file TClassTree.h.
|
protected |
![fNclasses] pointers to the TClass objects
Definition at line 38 of file TClassTree.h.
|
protected |
[fNclasses] classes status
Definition at line 33 of file TClassTree.h.
|
protected |
![fNclasses] class titles
Definition at line 40 of file TClassTree.h.
|
protected |
![fNclasses] table to indicate if i derives from j
Definition at line 37 of file TClassTree.h.
|
protected |
width along x of TPaveLabels in per cent of pad
Definition at line 27 of file TClassTree.h.
|
protected |
![fNclasses] for each class, the list of referenced(ing) classes
Definition at line 43 of file TClassTree.h.
|
protected |
current number of classes
Definition at line 28 of file TClassTree.h.
|
protected |
[fNclasses] Number of data members per class
Definition at line 34 of file TClassTree.h.
|
protected |
! internal variable, used during painting
Definition at line 44 of file TClassTree.h.
|
protected |
! internal variable, used during painting
Definition at line 45 of file TClassTree.h.
|
protected |
![fNclasses] List of options per class
Definition at line 41 of file TClassTree.h.
|
protected |
[fNclasses] parent number of classes (permanent)
Definition at line 35 of file TClassTree.h.
|
protected |
if 1 show classes referenced by implementation
Definition at line 29 of file TClassTree.h.
|
protected |
if 1 show "has a" relationship
Definition at line 31 of file TClassTree.h.
|
protected |
if 1 show multiple inheritance
Definition at line 30 of file TClassTree.h.
|
protected |
if 1 show classes relationship other than inheritance
Definition at line 32 of file TClassTree.h.
|
protected |
Concatenated source directories.
Definition at line 42 of file TClassTree.h.
|
protected |
offset at top of picture in per cent of pad
Definition at line 26 of file TClassTree.h.