Class GraphRendererBase<TVertex, TEdge>

Base class for Graph to DOT renderer.

Inheritance
System.Object
GraphRendererBase<TVertex, TEdge>
CondensatedGraphRenderer<TVertex, TEdge, TGraph>
EdgeMergeCondensatedGraphRenderer<TVertex, TEdge>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: QuikGraph.Graphviz
Assembly: QuikGraph.Graphviz.dll
Syntax
public abstract class GraphRendererBase<TVertex, TEdge>
    where TEdge : IEdge<TVertex>
Type Parameters
Name Description
TVertex

Vertex type.
TEdge

Edge type.

Constructors

| Improve this Doc View Source

GraphRendererBase(IEdgeListGraph<TVertex, TEdge>)

Initializes a new instance of the GraphvizAlgorithm<TVertex, TEdge> class.

Declaration
protected GraphRendererBase(IEdgeListGraph<TVertex, TEdge> graph)
Parameters
Type Name Description
IEdgeListGraph<TVertex, TEdge> graph

Graph to convert to DOT.
Exceptions
Type Condition
System.ArgumentNullException

graph is null.

Properties

| Improve this Doc View Source

Graphviz

Graph to DOT algorithm.

Declaration
public GraphvizAlgorithm<TVertex, TEdge> Graphviz { get; }
Property Value
Type Description
GraphvizAlgorithm<TVertex, TEdge>
| Improve this Doc View Source

VisitedGraph

Graph to convert.

Declaration
public IEdgeListGraph<TVertex, TEdge> VisitedGraph { get; }
Property Value
Type Description
IEdgeListGraph<TVertex, TEdge>
Exceptions
Type Condition
System.ArgumentNullException

Set value is null.

Methods

| Improve this Doc View Source

Clean()

Cleans renderer after generation.

Declaration
protected virtual void Clean()
| Improve this Doc View Source

Generate(IDotEngine, String)

Generates the DOT corresponding to VisitedGraph using dot engine and puts result in outputFilePath.

Declaration
public string Generate(IDotEngine dot, string outputFilePath)
Parameters
Type Name Description
IDotEngine dot
System.String outputFilePath
Returns
Type Description
System.String

File path containing DOT serialization of VisitedGraph.
Exceptions
Type Condition
System.ArgumentNullException

dot is null.
System.ArgumentException

outputFilePath is null or empty.
| Improve this Doc View Source

Initialize()

Initializes renderer for generation.

Declaration
protected virtual void Initialize()

Extension Methods