Logo ROOT  
Reference Guide
TGraphStruct Class Reference

The Graph Structure is an interface to the graphviz package.

The graphviz package is a graph visualization system. This interface consists in three classes:

TCanvas* graphstruct()
{
// create some nodes and put them in the graph in one go ...
TGraphNode *n0 = gs->AddNode("n0","Node 0");
TGraphNode *n1 = gs->AddNode("n1","First node");
TGraphNode *n2 = gs->AddNode("n2","Second node");
TGraphNode *n3 = gs->AddNode("n3","Third node");
TGraphNode *n4 = gs->AddNode("n4","Fourth node");
TGraphNode *n5 = gs->AddNode("n5","5th node");
TGraphNode *n6 = gs->AddNode("n6","Node number six");
TGraphNode *n7 = gs->AddNode("n7","Node 7");
TGraphNode *n8 = gs->AddNode("n8","Node 8");
TGraphNode *n9 = gs->AddNode("n9","Node 9");
n4->SetTextSize(0.03);
n6->SetTextSize(0.03);
n2->SetTextSize(0.04);
n3->SetTextFont(132);
n0->SetTextColor(kRed);
n9->SetFillColor(kRed-10);
n0->SetFillColor(kYellow-9);
n7->SetFillColor(kViolet-9);
// some edges ...
gs->AddEdge(n0,n1)->SetLineColor(kRed);
TGraphEdge *e06 = gs->AddEdge(n0,n6);
e06->SetLineColor(kRed-3);
e06->SetLineWidth(4);
gs->AddEdge(n1,n7);
gs->AddEdge(n4,n6);
gs->AddEdge(n3,n9);
gs->AddEdge(n6,n8);
gs->AddEdge(n7,n2);
gs->AddEdge(n8,n3);
gs->AddEdge(n2,n3);
gs->AddEdge(n9,n0);
gs->AddEdge(n1,n4);
gs->AddEdge(n1,n6);
gs->AddEdge(n2,n5);
gs->AddEdge(n3,n6);
gs->AddEdge(n4,n5);
TCanvas *c = new TCanvas("c","c",800,600);
c->SetFillColor(38);
gs->Draw();
return c;
}

A graph structure can be dumped into a "dot" file using DumpAsDotFile.

Definition at line 24 of file TGraphStruct.h.

Public Member Functions

 TGraphStruct ()
 Graph Structure default constructor. More...
 
virtual ~TGraphStruct ()
 Graph Structure default destructor. More...
 
void AddEdge (TGraphEdge *edge)
 Add the edge "edge" in this TGraphStruct. More...
 
TGraphEdgeAddEdge (TGraphNode *n1, TGraphNode *n2)
 Create an edge between n1 and n2 and put it in this graph. More...
 
TGraphNodeAddNode (const char *name, const char *title="")
 Create the node "name" if it does not exist and add it to this TGraphStruct. More...
 
void AddNode (TGraphNode *node)
 Add the node "node" in this TGraphStruct. More...
 
void Draw (Option_t *option="")
 Draw the graph. More...
 
void DumpAsDotFile (const char *filename)
 Dump this graph structure as a "dot" file. More...
 
TListGetListOfEdges () const
 
TListGetListOfNodes () const
 
Int_t Layout ()
 Layout the graph into a GraphViz data structure. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save primitive as a C++ statement(s) on output stream out. More...
 
void SetMargin (Double_t m=10)
 
- 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 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 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 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 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 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 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_tGetOption () 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...
 
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 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...
 
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 Attributes

TListfEdges
 List of edges in this TGraphStruct. More...
 
GVC_s * fGVC
 Graphviz context. More...
 
GVizAgraph_t * fGVGraph
 Graphviz graph. More...
 
Double_t fMargin
 Margin around the graph (in dots) More...
 
TListfNodes
 List of nodes in this TGraphStruct. More...
 

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

#include <TGraphStruct.h>

Inheritance diagram for TGraphStruct:
[legend]

Constructor & Destructor Documentation

◆ TGraphStruct()

TGraphStruct::TGraphStruct ( )

Graph Structure default constructor.

Definition at line 61 of file TGraphStruct.cxx.

◆ ~TGraphStruct()

TGraphStruct::~TGraphStruct ( )
virtual

Graph Structure default destructor.

Definition at line 74 of file TGraphStruct.cxx.

Member Function Documentation

◆ AddEdge() [1/2]

void TGraphStruct::AddEdge ( TGraphEdge edge)

Add the edge "edge" in this TGraphStruct.

Definition at line 88 of file TGraphStruct.cxx.

◆ AddEdge() [2/2]

TGraphEdge * TGraphStruct::AddEdge ( TGraphNode n1,
TGraphNode n2 
)

Create an edge between n1 and n2 and put it in this graph.

Two edges can connect the same nodes the same way, so there is no need to check if an edge already exists.

Definition at line 101 of file TGraphStruct.cxx.

◆ AddNode() [1/2]

TGraphNode * TGraphStruct::AddNode ( const char *  name,
const char *  title = "" 
)

Create the node "name" if it does not exist and add it to this TGraphStruct.

Definition at line 124 of file TGraphStruct.cxx.

◆ AddNode() [2/2]

void TGraphStruct::AddNode ( TGraphNode node)

Add the node "node" in this TGraphStruct.

Definition at line 114 of file TGraphStruct.cxx.

◆ Draw()

void TGraphStruct::Draw ( Option_t option = "")
virtual

Draw the graph.

Reimplemented from TObject.

Definition at line 158 of file TGraphStruct.cxx.

◆ DumpAsDotFile()

void TGraphStruct::DumpAsDotFile ( const char *  filename)

Dump this graph structure as a "dot" file.

Definition at line 141 of file TGraphStruct.cxx.

◆ GetListOfEdges()

TList* TGraphStruct::GetListOfEdges ( ) const
inline

Definition at line 46 of file TGraphStruct.h.

◆ GetListOfNodes()

TList* TGraphStruct::GetListOfNodes ( ) const
inline

Definition at line 45 of file TGraphStruct.h.

◆ Layout()

Int_t TGraphStruct::Layout ( )

Layout the graph into a GraphViz data structure.

Definition at line 199 of file TGraphStruct.cxx.

◆ SavePrimitive()

void TGraphStruct::SavePrimitive ( std::ostream &  out,
Option_t option = "" 
)
virtual

Save primitive as a C++ statement(s) on output stream out.

Reimplemented from TObject.

Definition at line 273 of file TGraphStruct.cxx.

◆ SetMargin()

void TGraphStruct::SetMargin ( Double_t  m = 10)
inline

Definition at line 49 of file TGraphStruct.h.

Member Data Documentation

◆ fEdges

TList* TGraphStruct::fEdges
protected

List of edges in this TGraphStruct.

Definition at line 31 of file TGraphStruct.h.

◆ fGVC

GVC_s* TGraphStruct::fGVC
protected

Graphviz context.

Definition at line 29 of file TGraphStruct.h.

◆ fGVGraph

GVizAgraph_t* TGraphStruct::fGVGraph
protected

Graphviz graph.

Definition at line 28 of file TGraphStruct.h.

◆ fMargin

Double_t TGraphStruct::fMargin
protected

Margin around the graph (in dots)

Definition at line 32 of file TGraphStruct.h.

◆ fNodes

TList* TGraphStruct::fNodes
protected

List of nodes in this TGraphStruct.

Definition at line 30 of file TGraphStruct.h.

Libraries for TGraphStruct:
[legend]

The documentation for this class was generated from the following files:
c
#define c(i)
Definition: RSha256.hxx:119
TGraphEdge
Definition: TGraphEdge.h:25
kViolet
@ kViolet
Definition: Rtypes.h:67
TGraphStruct
Definition: TGraphStruct.h:24
TGraphStruct::AddNode
void AddNode(TGraphNode *node)
Add the node "node" in this TGraphStruct.
Definition: TGraphStruct.cxx:114
TGraphStruct::TGraphStruct
TGraphStruct()
Graph Structure default constructor.
Definition: TGraphStruct.cxx:61
kRed
@ kRed
Definition: Rtypes.h:66
TGraphNode
Definition: TGraphNode.h:27
TCanvas
Definition: TCanvas.h:23
TGraphStruct::AddEdge
void AddEdge(TGraphEdge *edge)
Add the edge "edge" in this TGraphStruct.
Definition: TGraphStruct.cxx:88
kYellow
@ kYellow
Definition: Rtypes.h:66
TGraphStruct::Draw
void Draw(Option_t *option="")
Draw the graph.
Definition: TGraphStruct.cxx:158