NetTopologySuite.Planargraph.Edge Class Reference

Represents an undirected edge of a {PlanarGraph}. An undirected edge in fact simply acts as a central point of reference for two opposite DirectedEdges. Usually a client using a PlanarGraph will subclass Edge to add its own application-specific data and methods. More...

Inheritance diagram for NetTopologySuite.Planargraph.Edge:

Public Member Functions
	Edge ()
	Constructs an Edge whose DirectedEdges are not yet set. Be sure to call SetDirectedEdges(DirectedEdge, DirectedEdge). More...
	Edge (DirectedEdge de0, DirectedEdge de1)
	Constructs an Edge initialized with the given DirectedEdges, and for each DirectedEdge: sets the Edge, sets the symmetric DirectedEdge, and adds this Edge to its from-Node. More...
void	SetDirectedEdges (DirectedEdge de0, DirectedEdge de1)
	Initializes this Edge's two DirectedEdges, and for each DirectedEdge: sets the Edge, sets the symmetric DirectedEdge, and adds this Edge to its from-Node. More...
DirectedEdge	GetDirEdge (int i)
	Returns one of the DirectedEdges associated with this Edge. More...
DirectedEdge	GetDirEdge (Node fromNode)
	Returns the DirectedEdge that starts from the given node, or null if the node is not one of the two nodes associated with this Edge. More...
Node	GetOppositeNode (Node node)
	If node is one of the two nodes associated with this Edge, returns the other node; otherwise returns null. More...

Protected Attributes
DirectedEdge[]	dirEdge
	The two DirectedEdges associated with this Edge. More...

Properties
override bool	IsRemoved [get]
	Tests whether this component has been removed from its containing graph. More...
Properties inherited from NetTopologySuite.Planargraph.GraphComponent
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...

Additional Inherited Members
Static Public Member Functions inherited from NetTopologySuite.Planargraph.GraphComponent
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...

Detailed Description

Represents an undirected edge of a {PlanarGraph}. An undirected edge in fact simply acts as a central point of reference for two opposite DirectedEdges. Usually a client using a PlanarGraph will subclass Edge to add its own application-specific data and methods.

Constructor & Destructor Documentation

NetTopologySuite.Planargraph.Edge.Edge

(

)

Constructs an Edge whose DirectedEdges are not yet set. Be sure to call SetDirectedEdges(DirectedEdge, DirectedEdge).

NetTopologySuite.Planargraph.Edge.Edge	(	DirectedEdge	de0,
		DirectedEdge	de1
	)

Constructs an Edge initialized with the given DirectedEdges, and for each DirectedEdge: sets the Edge, sets the symmetric DirectedEdge, and adds this Edge to its from-Node.

Parameters

de0
de1

Member Function Documentation

DirectedEdge NetTopologySuite.Planargraph.Edge.GetDirEdge

(

int

i

)

Returns one of the DirectedEdges associated with this Edge.

Parameters

i

0 or 1.

Returns

DirectedEdge NetTopologySuite.Planargraph.Edge.GetDirEdge

(

Node

fromNode

)

Returns the DirectedEdge that starts from the given node, or null if the node is not one of the two nodes associated with this Edge.

Parameters

fromNode

Returns

Node NetTopologySuite.Planargraph.Edge.GetOppositeNode

(

Node

node

)

If node is one of the two nodes associated with this Edge, returns the other node; otherwise returns null.

Parameters

node

Returns

void NetTopologySuite.Planargraph.Edge.SetDirectedEdges	(	DirectedEdge	de0,
		DirectedEdge	de1
	)

Initializes this Edge's two DirectedEdges, and for each DirectedEdge: sets the Edge, sets the symmetric DirectedEdge, and adds this Edge to its from-Node.

Parameters

de0
de1

Member Data Documentation

DirectedEdge [] NetTopologySuite.Planargraph.Edge.dirEdge

protected

The two DirectedEdges associated with this Edge.

Property Documentation

override bool NetTopologySuite.Planargraph.Edge.IsRemoved

get

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

---

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

• NetTopologySuite/NetTopologySuite/Planargraph/Edge.cs