Class GraphComponent

The base class for all graph component classes. Maintains flags of use in generic graph algorithms. Provides two flags: marked - typically this is used to indicate a state that persists for the course of the graph's lifetime. For instance, it can be used to indicate that a component has been logically deleted from the graph. visited - this is used to indicate that a component has been processed or visited by an single graph algorithm. For instance, a breadth-first traversal of the graph might use this to indicate that a node has already been traversed. The visited flag may be set and cleared many times during the lifetime of a graph.

Inheritance

object

GraphComponent

DirectedEdge

Edge

Node

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: NetTopologySuite.Planargraph

Assembly: NetTopologySuite.dll

Syntax

public abstract class GraphComponent

Properties

Data

Gets or sets user defined data for this component

Declaration

public object Data { get; set; }

Property Value

Type	Description
object

IsMarked

Tests if a component has been marked at some point during the processing involving this graph.

Declaration

public bool IsMarked { get; }

Property Value

Type	Description
bool

IsRemoved

Tests whether this component has been removed from its containing graph.

Declaration

public abstract bool IsRemoved { get; }

Property Value

Type	Description
bool

IsVisited

Tests if a component has been visited during the course of a graph algorithm.

Declaration

public bool IsVisited { get; }

Property Value

Type	Description
bool

Marked

Gets/Sets the marked flag for this component.

Declaration

public bool Marked { get; set; }

Property Value

Type	Description
bool

Visited

Gets/Sets the visited flag for this component.

Declaration

public bool Visited { get; set; }

Property Value

Type	Description
bool

Methods

GetComponentWithVisitedState(IEnumerator, bool)

Finds the first GraphComponent in a IEnumerator set which has the specified Visited state.

Declaration

public static GraphComponent GetComponentWithVisitedState(IEnumerator i, bool visitedState)

Parameters

Type	Name	Description
IEnumerator	i	A IEnumerator to scan.
bool	visitedState	The Visited state to test.

Returns

Type	Description
GraphComponent	The first GraphComponent found, or null if none found.

SetMarked(IEnumerator, bool)

Sets the Marked state for all GraphComponents in an IEnumerator.

Declaration

public static void SetMarked(IEnumerator i, bool marked)

Parameters

Type	Name	Description
IEnumerator	i	A IEnumerator to scan.
bool	marked	The state to set the Marked flag to.

SetVisited(IEnumerator, bool)

Sets the Visited state for all GraphComponents in an IEnumerator.

Declaration

public static void SetVisited(IEnumerator i, bool visited)

Parameters

Type	Name	Description
IEnumerator	i	A IEnumerator to scan.
bool	visited	The state to set the Visited flag to.