DotNode Class Reference

A node in a dot graph. More...

#include <dot.h>

List of all members.

Public Types

enum  GraphType {
  Dependency, Inheritance, Collaboration, Hierarchy,
  CallGraph
}
enum  TruncState { Unknown, Truncated, Untruncated }

Public Member Functions

 DotNode (int n, const char *lab, const char *tip, const char *url, bool rootNode=FALSE, ClassDef *cd=0)
 ~DotNode ()
void addChild (DotNode *n, int edgeColor=EdgeInfo::Purple, int edgeStyle=EdgeInfo::Solid, const char *edgeLab=0, const char *edgeURL=0, int edgeLabCol=-1)
void addParent (DotNode *n)
void deleteNode (DotNodeList &deletedList, SDict< DotNode > *skipNodes=0)
void removeChild (DotNode *n)
void removeParent (DotNode *n)
int findParent (DotNode *n)
void write (QTextStream &t, GraphType gt, GraphOutputFormat f, bool topDown, bool toChildren, bool backArrows, bool reNumber)
void clearWriteFlag ()
void writeXML (QTextStream &t, bool isClassGraph)
void writeDEF (QTextStream &t)
QCString label () const
int number () const
bool isVisible () const
TruncState isTruncated () const
int distance () const

Public Attributes

int m_subgraphId

Friends

class DotGfxHierarchyTable
class DotClassGraph
class DotInclDepGraph
class DotNodeList
class DotCallGraph
class DotGroupCollaboration
QCString computeMd5Signature (DotNode *root, GraphType gt, GraphOutputFormat f, bool lrRank, bool renderParents, bool backArrows, QCString &graphStr)


Detailed Description

A node in a dot graph.

Definition at line 55 of file dot.h.


Member Enumeration Documentation

enum DotNode::GraphType

Enumerator:
Dependency 
Inheritance 
Collaboration 
Hierarchy 
CallGraph 

Definition at line 58 of file dot.h.

enum DotNode::TruncState

Enumerator:
Unknown 
Truncated 
Untruncated 

Definition at line 59 of file dot.h.


Constructor & Destructor Documentation

DotNode::DotNode ( int  n,
const char *  lab,
const char *  tip,
const char *  url,
bool  rootNode = FALSE,
ClassDef cd = 0 
)

Definition at line 407 of file dot.cpp.

DotNode::~DotNode (  ) 

Definition at line 428 of file dot.cpp.


Member Function Documentation

void DotNode::addChild ( DotNode n,
int  edgeColor = EdgeInfo::Purple,
int  edgeStyle = EdgeInfo::Solid,
const char *  edgeLab = 0,
const char *  edgeURL = 0,
int  edgeLabCol = -1 
)

Definition at line 435 of file dot.cpp.

References EdgeInfo::m_color, EdgeInfo::m_labColor, EdgeInfo::m_label, EdgeInfo::m_style, and EdgeInfo::m_url.

Referenced by DotCallGraph::buildGraph().

void DotNode::addParent ( DotNode n  ) 

Definition at line 462 of file dot.cpp.

Referenced by DotCallGraph::buildGraph().

void DotNode::deleteNode ( DotNodeList deletedList,
SDict< DotNode > *  skipNodes = 0 
)

Definition at line 481 of file dot.cpp.

References deleteNode(), and SDict< T >::find().

Referenced by deleteNode().

void DotNode::removeChild ( DotNode n  ) 

Definition at line 471 of file dot.cpp.

void DotNode::removeParent ( DotNode n  ) 

Definition at line 476 of file dot.cpp.

int DotNode::findParent ( DotNode n  )  [inline]

Definition at line 129 of file dot.h.

void DotNode::write ( QTextStream &  t,
GraphType  gt,
GraphOutputFormat  f,
bool  topDown,
bool  toChildren,
bool  backArrows,
bool  reNumber 
)

Definition at line 727 of file dot.cpp.

References isVisible(), m_children, m_edgeInfo, Truncated, and write().

Referenced by computeMd5Signature(), write(), DotGroupCollaboration::writeGraph(), and DotGfxHierarchyTable::writeGraph().

void DotNode::clearWriteFlag (  ) 

Definition at line 918 of file dot.cpp.

References clearWriteFlag(), and m_written.

Referenced by clearWriteFlag(), computeMd5Signature(), DotGroupCollaboration::writeGraph(), and DotGfxHierarchyTable::writeGraph().

void DotNode::writeXML ( QTextStream &  t,
bool  isClassGraph 
)

Definition at line 785 of file dot.cpp.

References EdgeInfo::Blue, convertToXML(), EdgeInfo::Green, EdgeInfo::Grey, EdgeInfo::m_color, EdgeInfo::m_label, m_number, EdgeInfo::Orange, EdgeInfo::Purple, and EdgeInfo::Red.

Referenced by DotInclDepGraph::writeXML(), and DotClassGraph::writeXML().

void DotNode::writeDEF ( QTextStream &  t  ) 

Definition at line 854 of file dot.cpp.

References EdgeInfo::Blue, EdgeInfo::Green, EdgeInfo::Grey, EdgeInfo::m_color, EdgeInfo::m_label, m_number, EdgeInfo::Orange, EdgeInfo::Purple, and EdgeInfo::Red.

Referenced by DotClassGraph::writeDEF().

QCString DotNode::label (  )  const [inline]

Definition at line 81 of file dot.h.

int DotNode::number (  )  const [inline]

Definition at line 82 of file dot.h.

Referenced by DotGroupCollaboration::Edge::write().

bool DotNode::isVisible (  )  const [inline]

Definition at line 83 of file dot.h.

Referenced by computeMd5Signature(), DotCallGraph::determineTruncatedNodes(), DotCallGraph::determineVisibleNodes(), and write().

TruncState DotNode::isTruncated (  )  const [inline]

Definition at line 84 of file dot.h.

Referenced by DotCallGraph::determineTruncatedNodes().

int DotNode::distance (  )  const [inline]

Definition at line 85 of file dot.h.

Referenced by DotCallGraph::determineVisibleNodes().


Friends And Related Function Documentation

friend class DotGfxHierarchyTable [friend]

Definition at line 113 of file dot.h.

friend class DotClassGraph [friend]

Definition at line 114 of file dot.h.

friend class DotInclDepGraph [friend]

Definition at line 115 of file dot.h.

friend class DotNodeList [friend]

Definition at line 116 of file dot.h.

friend class DotCallGraph [friend]

Definition at line 117 of file dot.h.

friend class DotGroupCollaboration [friend]

Definition at line 118 of file dot.h.

QCString computeMd5Signature ( DotNode root,
DotNode::GraphType  gt,
GraphOutputFormat  f,
bool  lrRank,
bool  renderParents,
bool  backArrows,
QCString &  graphStr 
) [friend]

Computes a 16 byte md5 checksum for a given dot graph. The md5 checksum is returned as a 32 character ASCII string.

Definition at line 1680 of file dot.cpp.


Member Data Documentation

int DotNode::m_subgraphId

Definition at line 77 of file dot.h.

Referenced by DotGfxHierarchyTable::DotGfxHierarchyTable(), and DotGfxHierarchyTable::writeGraph().


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



Generated on Mon Mar 31 10:58:59 2008 by  doxygen 1.5.1