NetTopologySuite
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
NetTopologySuite.Planargraph.Node Class Reference

A node in a PlanarGraph is a location where 0 or more Edges meet. A node is connected to each of its incident Edges via an outgoing DirectedEdge. Some clients using a PlanarGraph may want to subclass Node to add their own application-specific data and methods. More...

Inheritance diagram for NetTopologySuite.Planargraph.Node:
NetTopologySuite.Planargraph.GraphComponent

Public Member Functions

 Node (Coordinate pt)
 Constructs a Node with the given location. More...
 
 Node (Coordinate pt, DirectedEdgeStar deStar)
 Constructs a Node with the given location and collection of outgoing DirectedEdges. More...
 
void AddOutEdge (DirectedEdge de)
 Adds an outgoing DirectedEdge to this Node. More...
 
int GetIndex (Edge edge)
 Returns the zero-based index of the given Edge, after sorting in ascending order by angle with the positive x-axis. More...
 
void Remove (DirectedEdge de)
 
override string ToString ()
 

Static Public Member Functions

static IList< DirectedEdgeGetEdgesBetween (Node node0, Node node1)
 Returns all Edges that connect the two nodes (which are assumed to be different). More...
 
- 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...
 

Protected Attributes

Coordinate pt
 The location of this Node. More...
 
DirectedEdgeStar deStar
 The collection of DirectedEdges that leave this Node. More...
 

Properties

Coordinate Coordinate [get]
 Returns the location of this Node. More...
 
DirectedEdgeStar OutEdges [get]
 Returns the collection of DirectedEdges that leave this Node. More...
 
int Degree [get]
 Returns the number of edges around this Node. More...
 
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...
 

Detailed Description

A node in a PlanarGraph is a location where 0 or more Edges meet. A node is connected to each of its incident Edges via an outgoing DirectedEdge. Some clients using a PlanarGraph may want to subclass Node to add their own application-specific data and methods.

Constructor & Destructor Documentation

NetTopologySuite.Planargraph.Node.Node ( Coordinate  pt)

Constructs a Node with the given location.

Parameters
pt
NetTopologySuite.Planargraph.Node.Node ( Coordinate  pt,
DirectedEdgeStar  deStar 
)

Constructs a Node with the given location and collection of outgoing DirectedEdges.

Parameters
pt
deStar

Member Function Documentation

void NetTopologySuite.Planargraph.Node.AddOutEdge ( DirectedEdge  de)

Adds an outgoing DirectedEdge to this Node.

Parameters
de
static IList<DirectedEdge> NetTopologySuite.Planargraph.Node.GetEdgesBetween ( Node  node0,
Node  node1 
)
static

Returns all Edges that connect the two nodes (which are assumed to be different).

Parameters
node0
node1
Returns
int NetTopologySuite.Planargraph.Node.GetIndex ( Edge  edge)

Returns the zero-based index of the given Edge, after sorting in ascending order by angle with the positive x-axis.

Parameters
edge
Returns

summary> Removes a DirectedEdge incident on this node. Does not change the state of the directed edge. /summary>

override string NetTopologySuite.Planargraph.Node.ToString ( )

Returns

Member Data Documentation

DirectedEdgeStar NetTopologySuite.Planargraph.Node.deStar
protected

The collection of DirectedEdges that leave this Node.

Coordinate NetTopologySuite.Planargraph.Node.pt
protected

The location of this Node.

Property Documentation

Coordinate NetTopologySuite.Planargraph.Node.Coordinate
get

Returns the location of this Node.

int NetTopologySuite.Planargraph.Node.Degree
get

Returns the number of edges around this Node.

override bool NetTopologySuite.Planargraph.Node.IsRemoved
get

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

DirectedEdgeStar NetTopologySuite.Planargraph.Node.OutEdges
get

Returns the collection of DirectedEdges that leave this Node.


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