The Graph Structure is an interface to the graphviz package.

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

TGraphStruct: holds the graph structure. It uses the graphviz library to layout the graphs and the ROOT graphics to paint them.
TGraphNode: Is a graph node object which can be added in a TGraphStruct.
TGraphEdge: Is an edge object connecting two nodes which can be added in a TGraphStruct.

 
TCanvas* graphstruct()
{
   #if __has_include("TGraphStruct.h") // handy check on whether gviz was installed
   TGraphStruct *gs = new TGraphStruct();
 
   // 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;
   #else
   return new TCanvas("c","c",800,600);
   #endif
}

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.

	~TGraphStruct () override
	Graph Structure default destructor.

void	AddEdge (TGraphEdge *edge)
	Add the edge "edge" in this TGraphStruct.

TGraphEdge *	AddEdge (TGraphNode n1, TGraphNode n2)
	Create an edge between n1 and n2 and put it in this graph.

TGraphNode *	AddNode (const char name, const char title="")
	Create the node "name" if it does not exist and add it to this TGraphStruct.

void	AddNode (TGraphNode *node)
	Add the node "node" in this TGraphStruct.

void	Draw (Option_t *option="") override
	Draw the graph.

void	DumpAsDotFile (const char *filename)
	Dump this graph structure as a "dot" file.

TList *	GetListOfEdges () const

TList *	GetListOfNodes () const

TClass *	IsA () const override

Int_t	Layout ()
	Layout the graph into a GraphViz data structure.

void	SavePrimitive (std::ostream &out, Option_t *option="") override
	Save primitive as a C++ statement(s) on output stream out.

void	SetMargin (Double_t m=10)

void	Streamer (TBuffer &) override
	Stream an object of class TObject.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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	Clear (Option_t *="")

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 abstract method.

virtual void	Copy (TObject &object) const
	Copy this to obj.

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 with: `gROOT->SetSelectedPad(c1)`.

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=nullptr)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)
	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 const char *	GetName () const
	Returns 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 const char *	GetTitle () const
	Returns title of object.

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.

virtual ULong_t	Hash () const
	Return hash value for this object.

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

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.

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 (the base implementation is no-op).

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, void vp)
	Only called by placement new when throwing an exception.

void	operator delete[] (void *ptr)
	Operator delete [].

void	operator delete[] (void ptr, void vp)
	Only called by placement new[] when throwing an exception.

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	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.

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	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

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.

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

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=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

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 Attributes
TList *	fEdges
	List of edges in this TGraphStruct.

GVC_s *	fGVC
	Graphviz context.

GVizAgraph_t *	fGVGraph
	Graphviz graph.

Double_t	fMargin
	Margin around the graph (in dots)

TList *	fNodes
	List of nodes in this TGraphStruct.

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }

enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }

enum	EStatusBits { kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) , kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

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

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

override

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.

◆ Class()

static TClass * TGraphStruct::Class ( )

static

Returns: TClass describing this class

◆ Class_Name()

static const char * TGraphStruct::Class_Name ( )

static

Returns: Name of this class

◆ Class_Version()

static constexpr Version_t TGraphStruct::Class_Version ( )

inlinestaticconstexpr

Returns: Version of this class

Definition at line 51 of file TGraphStruct.h.

◆ DeclFileName()

static const char * TGraphStruct::DeclFileName ( )

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 51 of file TGraphStruct.h.

◆ Draw()

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

overridevirtual

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.

◆ IsA()

TClass * TGraphStruct::IsA ( ) const

inlineoverridevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 51 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 = `""`
	)

overridevirtual

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.

◆ Streamer()

void TGraphStruct::Streamer ( TBuffer & R__b )

overridevirtual

Stream an object of class TObject.

Reimplemented from TObject.

Definition at line 326 of file TGraphStruct.cxx.

◆ StreamerNVirtual()

void TGraphStruct::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b )

inline

Definition at line 51 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:

graf2d/gviz/inc/TGraphStruct.h
graf2d/gviz/src/TGraphStruct.cxx

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TGraphStruct()

◆ ~TGraphStruct()

Member Function Documentation

◆ AddEdge() [1/2]

◆ AddEdge() [2/2]

◆ AddNode() [1/2]

◆ AddNode() [2/2]

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ Draw()

◆ DumpAsDotFile()

◆ GetListOfEdges()

◆ GetListOfNodes()

◆ IsA()

◆ Layout()

◆ SavePrimitive()

◆ SetMargin()

◆ Streamer()

◆ StreamerNVirtual()

Member Data Documentation

◆ fEdges

◆ fGVC

◆ fGVGraph

◆ fMargin

◆ fNodes