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. More...

Inheritance diagram for NetTopologySuite.Planargraph.GraphComponent:

Static Public Member Functions
static void	SetVisited (IEnumerator i, bool visited)
	Sets the GraphComponent.Visited state for all GraphComponents in an IEnumerator. More...

static void	SetMarked (IEnumerator i, bool marked)
	Sets the GraphComponent.Marked state for all GraphComponents in an IEnumerator. More...

static GraphComponent	GetComponentWithVisitedState (IEnumerator i, bool visitedState)
	Finds the first GraphComponent in a IEnumerator set which has the specified GraphComponent.Visited state. More...

Properties
bool	IsVisited `[get]`
	Tests if a component has been visited during the course of a graph algorithm. More...

bool	Visited `[get, set]`
	Gets/Sets the visited flag for this component. More...

bool	IsMarked `[get]`
	Tests if a component has been marked at some point during the processing involving this graph. More...

bool	Marked `[get, set]`
	Gets/Sets the marked flag for this component. More...

abstract bool	IsRemoved `[get]`
	Tests whether this component has been removed from its containing graph. More...

Detailed Description

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.

Member Function Documentation

static GraphComponent NetTopologySuite.Planargraph.GraphComponent.GetComponentWithVisitedState	(	IEnumerator	i,
		bool	visitedState
	)

static

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

Parameters

i	A IEnumerator to scan.
visitedState	The GraphComponent.Visited state to test.

Returns: The first GraphComponent found, or null if none found.

static void NetTopologySuite.Planargraph.GraphComponent.SetMarked	(	IEnumerator	i,
		bool	marked
	)

static

Sets the GraphComponent.Marked state for all GraphComponents in an IEnumerator.

Parameters

i	A IEnumerator to scan.
marked	The state to set the GraphComponent.Marked flag to.

static void NetTopologySuite.Planargraph.GraphComponent.SetVisited	(	IEnumerator	i,
		bool	visited
	)

static

Sets the GraphComponent.Visited state for all GraphComponents in an IEnumerator.

Parameters

i	A IEnumerator to scan.
visited	The state to set the GraphComponent.Visited flag to.

Property Documentation

bool NetTopologySuite.Planargraph.GraphComponent.IsMarked

get

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

abstract bool NetTopologySuite.Planargraph.GraphComponent.IsRemoved

get

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

bool NetTopologySuite.Planargraph.GraphComponent.IsVisited

get

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

bool NetTopologySuite.Planargraph.GraphComponent.Marked

getset

Gets/Sets the marked flag for this component.

bool NetTopologySuite.Planargraph.GraphComponent.Visited

getset

Gets/Sets the visited flag for this component.

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

NetTopologySuite/NetTopologySuite/Planargraph/GraphComponent.cs

Static Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation