ROOT  6.06/09
Reference Guide
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TClassTree Class Reference

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

  1. Draw("ClassA")
    • Draw inheritance tree for ClassA
    • Show all classes referenced by ClassA
  2. Draw("*ClassB")
    • Draw inheritance tree for ClassB and all the classes deriving from ClassB
  3. Draw("\>ClassC")
    • Draw inheritance tree for ClassC
    • Show classes referencing ClassC
  4. Draw("ClassD\<")
    • Draw inheritance tree for ClassD
    • Show classes referenced by ClassD
    • Show all classes referencing ClassD
  5. Draw("Cla*")
    • Draw inheritance tree for all classes with name starting with "Cla"
    • Show classes referenced by these classes
  6. Draw("ClassA:ClassB\<")
    • Draw inheritance tree for ClassA
    • Show all classes referenced by ClassA
    • Draw inheritance tree for ClassB
    • Show classes referenced by ClassB
    • Show all classes referencing 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:

TClassTree ct("ct","*TH1")

It shows all the classes derived from the base class TH1.

gpad_classtree1.png

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

TClassTree tc1("tc1","TH1");
tc1.ShowLinks("HMR");
gpad_classtree2.png

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:

TFile f("myClasses.root","recreate")
TClassTree *ct = new TClassTree("ct","ATLF*")
ct->Write();

You can send at this point the file myClass.root to a colleague who can run the following Root basic session

TFile f("myClass.root"); //connect the file
tt.ls(); //to list all classes and titles
tt.Draw("ATLFDisplay") //show class ATLFDisplay with all its dependencies

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 31 of file TClassTree.h.

Public Member Functions

 TClassTree ()
 
 TClassTree (const char *name, const char *classes="")
 TClassTree constructor. More...
 
virtual ~TClassTree ()
 TClassTree default destructor. More...
 
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. More...
 
virtual Int_t FindClass (const char *classname)
 Find class number corresponding to classname in list of local classes. More...
 
const char * GetClasses () const
 
virtual const char * GetSourceDir () const
 
virtual void ls (Option_t *option="") const
 list classes names and titles More...
 
virtual void Paint (Option_t *option="")
 Draw the current class setting in fClasses and fStatus. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void SetLabelDx (Float_t labeldx=0.15)
 Set the size along x of the TPaveLabel showing the class name. More...
 
virtual void ShowClassesUsedBy (const char *classes)
 mark classes used by the list of classes in classes More...
 
virtual void ShowClassesUsing (const char *classes)
 mark classes using any class in the list of classes in classes More...
 
virtual void ShowLinks (Option_t *option="HMR")
 Set link options in the ClassTree object. More...
 
- Public Member Functions inherited from TNamed
 TNamed ()
 
 TNamed (const char *name, const char *title)
 
 TNamed (const TString &name, const TString &title)
 
 TNamed (const TNamed &named)
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual ~TNamed ()
 
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 SetName (const char *name)
 Change (i.e. More...
 
virtual void SetNameTitle (const char *name, const char *title)
 Change (i.e. set) all the TNamed parameters (name and title). More...
 
virtual void SetTitle (const char *title="")
 Change (i.e. set) the title of the TNamed. More...
 
virtual void Print (Option_t *option="") const
 Print TNamed name and title. More...
 
virtual Int_t Sizeof () const
 Return size of the TNamed part of the TObject. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual ~TObject ()
 TObject destructor. 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...
 
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 Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. 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 pad. More...
 
virtual void Dump () const
 Dump contents of object on stdout. 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 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 UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual Option_tGetOption () const
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. 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...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
Bool_t IsOnHeap () const
 
Bool_t IsZombie () const
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. 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...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". 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 UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. 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...
 
voidoperator new (size_t sz)
 
voidoperator new[] (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz, void *vp)
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
void ResetBit (UInt_t f)
 
Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
void InvertBit (UInt_t f)
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. 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...
 
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...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 

Protected Member Functions

virtual void FindClassPosition (const char *classname, Float_t &x, Float_t &y)
 [fNclasses] for each class, the list of referenced(ing) classes More...
 
virtual void FindClassesUsedBy (Int_t iclass)
 Select all classes used/referenced by the class number iclass. More...
 
virtual void FindClassesUsing (Int_t iclass)
 Select all classes using/referencing the class number iclass. More...
 
virtual void Init ()
 Initialize the data structures. More...
 
TObjStringMark (const char *classname, TList *los, Int_t abit)
 set bit abit in class classname in list los More...
 
virtual void PaintClass (Int_t iclass, Float_t xleft, Float_t y)
 Paint one class level. More...
 
virtual void ScanClasses (Int_t iclass)
 Select all classes used by/referenced/referencing the class number iclass and build the list of these classes. More...
 
virtual void ShowCod ()
 Draw the Code References relationships. More...
 
virtual void ShowHas ()
 Draw the "Has a" relationships. More...
 
virtual void ShowMul ()
 Draw the Multiple inheritance relationships. More...
 
virtual void ShowRef ()
 Draw the References relationships (other than inheritance or composition) More...
 
- Protected Member Functions inherited from TObject
void MakeZombie ()
 
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 

Protected Attributes

TString fClasses
 
Float_t fYoffset
 
Float_t fLabelDx
 
Int_t fNclasses
 
Int_t fShowCod
 
Int_t fShowMul
 
Int_t fShowHas
 
Int_t fShowRef
 
Int_tfCstatus
 
Int_tfNdata
 
Int_tfParents
 
Int_tfCparent
 
char ** fDerived
 parent number of classes (temporary) More...
 
TClass ** fCpointer
 [fNclasses] table to indicate if i derives from j More...
 
TString ** fCnames
 [fNclasses] pointers to the TClass objects More...
 
TString ** fCtitles
 [fNclasses] class names More...
 
TString ** fOptions
 [fNclasses] class titles More...
 
TString fSourceDir
 [fNclasses] List of options per class More...
 
TList ** fLinks
 
- Protected Attributes inherited from TNamed
TString fName
 
TString fTitle
 

Additional Inherited Members

- Public Types inherited from TObject
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kObjInCanvas = BIT(3), kIsReferenced = BIT(4),
  kHasUUID = BIT(5), kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
enum  { kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kBitMask = 0x00ffffff }
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 

#include <TClassTree.h>

+ Inheritance diagram for TClassTree:
+ Collaboration diagram for TClassTree:

Constructor & Destructor Documentation

TClassTree::TClassTree ( )
TClassTree::TClassTree ( const char *  name,
const char *  classes = "" 
)

TClassTree constructor.

Definition at line 208 of file TClassTree.cxx.

TClassTree::~TClassTree ( )
virtual

TClassTree default destructor.

Definition at line 244 of file TClassTree.cxx.

Member Function Documentation

void TClassTree::Draw ( const char *  classes = "")
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 268 of file TClassTree.cxx.

Referenced by TPaveClass::DrawClasses(), and TClassTree().

Int_t TClassTree::FindClass ( const char *  classname)
virtual

Find class number corresponding to classname in list of local classes.

Definition at line 285 of file TClassTree.cxx.

Referenced by FindClassesUsedBy(), FindClassesUsing(), Paint(), PaintClass(), ScanClasses(), ShowClassesUsedBy(), ShowClassesUsing(), ShowCod(), ShowHas(), ShowMul(), and ShowRef().

void TClassTree::FindClassesUsedBy ( Int_t  iclass)
protectedvirtual

Select all classes used/referenced by the class number iclass.

Definition at line 296 of file TClassTree.cxx.

Referenced by Paint(), and ShowClassesUsedBy().

void TClassTree::FindClassesUsing ( Int_t  iclass)
protectedvirtual

Select all classes using/referencing the class number iclass.

Definition at line 320 of file TClassTree.cxx.

Referenced by Paint(), and ShowClassesUsing().

void TClassTree::FindClassPosition ( const char *  classname,
Float_t x,
Float_t y 
)
protectedvirtual

[fNclasses] for each class, the list of referenced(ing) classes

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 346 of file TClassTree.cxx.

Referenced by ShowCod(), ShowHas(), ShowMul(), and ShowRef().

const char* TClassTree::GetClasses ( ) const
inline

Definition at line 72 of file TClassTree.h.

Referenced by Paint().

virtual const char* TClassTree::GetSourceDir ( ) const
inlinevirtual

Definition at line 73 of file TClassTree.h.

void TClassTree::Init ( )
protectedvirtual

Initialize the data structures.

Definition at line 367 of file TClassTree.cxx.

Referenced by Draw().

void TClassTree::ls ( Option_t option = "") const
virtual

list classes names and titles

Reimplemented from TNamed.

Definition at line 432 of file TClassTree.cxx.

TObjString * TClassTree::Mark ( const char *  classname,
TList los,
Int_t  abit 
)
protected

set bit abit in class classname in list los

Definition at line 446 of file TClassTree.cxx.

Referenced by ScanClasses().

void TClassTree::Paint ( Option_t option = "")
virtual

Draw the current class setting in fClasses and fStatus.

Reimplemented from TObject.

Definition at line 461 of file TClassTree.cxx.

Referenced by Draw(), SetClasses(), SetLabelDx(), SetYoffset(), ShowClassesUsedBy(), ShowClassesUsing(), and ShowLinks().

void TClassTree::PaintClass ( Int_t  iclass,
Float_t  xleft,
Float_t  y 
)
protectedvirtual

Paint one class level.

Definition at line 642 of file TClassTree.cxx.

Referenced by Paint().

void TClassTree::SaveAs ( const char *  filename = "",
Option_t option = "" 
) const
virtual

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 690 of file TClassTree.cxx.

Referenced by TPaveClass::SaveAs().

void TClassTree::ScanClasses ( Int_t  iclass)
protectedvirtual

Select all classes used by/referenced/referencing the class number iclass and build the list of these classes.

Definition at line 699 of file TClassTree.cxx.

Referenced by Init().

void TClassTree::SetClasses ( const char *  classes,
Option_t option = "ID" 
)
virtual

Set the list of classes for which the hierarchy is to be drawn See Paint for the syntax.

Definition at line 865 of file TClassTree.cxx.

Referenced by TPaveClass::SetClasses().

void TClassTree::SetLabelDx ( Float_t  labeldx = 0.15)
virtual

Set the size along x of the TPaveLabel showing the class name.

Definition at line 879 of file TClassTree.cxx.

Referenced by TClassTree().

virtual void TClassTree::SetSourceDir ( const char *  dir = "src")
inlinevirtual

Definition at line 78 of file TClassTree.h.

Referenced by TClassTree().

void TClassTree::SetYoffset ( Float_t  offset = 0)
virtual

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 890 of file TClassTree.cxx.

Referenced by TClassTree().

void TClassTree::ShowClassesUsedBy ( const char *  classes)
virtual

mark classes used by the list of classes in classes

Definition at line 899 of file TClassTree.cxx.

Referenced by TPaveClass::ShowClassesUsedBy().

void TClassTree::ShowClassesUsing ( const char *  classes)
virtual

mark classes using any class in the list of classes in classes

Definition at line 930 of file TClassTree.cxx.

Referenced by TPaveClass::ShowClassesUsing().

void TClassTree::ShowCod ( )
protectedvirtual

Draw the Code References relationships.

Definition at line 961 of file TClassTree.cxx.

Referenced by Paint().

void TClassTree::ShowHas ( )
protectedvirtual

Draw the "Has a" relationships.

Definition at line 999 of file TClassTree.cxx.

Referenced by Paint().

void TClassTree::ShowLinks ( Option_t option = "HMR")
virtual

Set link options in the ClassTree object.

  • "C" show References from code
  • "H" show Has a relations
  • "M" show Multiple Inheritance
  • "R" show References from data members

Definition at line 1044 of file TClassTree.cxx.

Referenced by TPaveClass::ShowLinks().

void TClassTree::ShowMul ( )
protectedvirtual

Draw the Multiple inheritance relationships.

Definition at line 1059 of file TClassTree.cxx.

Referenced by Paint().

void TClassTree::ShowRef ( )
protectedvirtual

Draw the References relationships (other than inheritance or composition)

Definition at line 1097 of file TClassTree.cxx.

Referenced by Paint().

Member Data Documentation

TString TClassTree::fClasses
protected

Definition at line 34 of file TClassTree.h.

Referenced by Draw(), SetClasses(), and TClassTree().

TString** TClassTree::fCnames
protected

[fNclasses] pointers to the TClass objects

Definition at line 48 of file TClassTree.h.

Referenced by FindClass(), Init(), ls(), Paint(), PaintClass(), ScanClasses(), ShowClassesUsedBy(), ShowClassesUsing(), TClassTree(), and ~TClassTree().

Int_t* TClassTree::fCparent
protected

Definition at line 45 of file TClassTree.h.

Referenced by Draw(), Init(), Paint(), PaintClass(), SetClasses(), TClassTree(), and ~TClassTree().

TClass** TClassTree::fCpointer
protected

[fNclasses] table to indicate if i derives from j

Definition at line 47 of file TClassTree.h.

Referenced by Init(), ScanClasses(), TClassTree(), and ~TClassTree().

Int_t* TClassTree::fCstatus
protected
TString** TClassTree::fCtitles
protected

[fNclasses] class names

Definition at line 49 of file TClassTree.h.

Referenced by Init(), ls(), PaintClass(), TClassTree(), and ~TClassTree().

char** TClassTree::fDerived
protected

parent number of classes (temporary)

Definition at line 46 of file TClassTree.h.

Referenced by Init(), Paint(), PaintClass(), ScanClasses(), ShowClassesUsedBy(), ShowClassesUsing(), ShowCod(), ShowMul(), TClassTree(), and ~TClassTree().

Float_t TClassTree::fLabelDx
protected

Definition at line 36 of file TClassTree.h.

Referenced by Paint(), and SetLabelDx().

TList** TClassTree::fLinks
protected
Int_t TClassTree::fNclasses
protected
Int_t* TClassTree::fNdata
protected

Definition at line 43 of file TClassTree.h.

Referenced by Init(), ShowHas(), ShowRef(), TClassTree(), and ~TClassTree().

TString** TClassTree::fOptions
protected

[fNclasses] class titles

Definition at line 50 of file TClassTree.h.

Referenced by Init(), TClassTree(), and ~TClassTree().

Int_t* TClassTree::fParents
protected

Definition at line 44 of file TClassTree.h.

Referenced by Init(), Paint(), TClassTree(), and ~TClassTree().

Int_t TClassTree::fShowCod
protected

Definition at line 38 of file TClassTree.h.

Referenced by Paint(), ShowLinks(), and TClassTree().

Int_t TClassTree::fShowHas
protected

Definition at line 40 of file TClassTree.h.

Referenced by Paint(), ShowLinks(), and TClassTree().

Int_t TClassTree::fShowMul
protected

Definition at line 39 of file TClassTree.h.

Referenced by Paint(), ShowLinks(), and TClassTree().

Int_t TClassTree::fShowRef
protected

Definition at line 41 of file TClassTree.h.

Referenced by Paint(), ShowLinks(), and TClassTree().

TString TClassTree::fSourceDir
protected

[fNclasses] List of options per class

Definition at line 51 of file TClassTree.h.

Referenced by ScanClasses().

Float_t TClassTree::fYoffset
protected

Definition at line 35 of file TClassTree.h.

Referenced by Paint(), and SetYoffset().


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