RiverSoftAVG Products Help

Create(TGCustomGraph)

Creates and allocates the node. It also connects the node to its   Graph owner. (Inherited from GGraph.TGGraphNode.)

Destroy

Represents the destructor of the TWeightedNode class. (Overrides GGraph.TGGraphNode.Destroy.)

Caption

Specifies a label for the node.

Depending on the graph, the Caption may need to be unique over all the nodes. The GGraph.TGLabelGraph class requires the caption to be unique; however, this allows the graph to find a node by its caption in a constant amount of time no matter how many nodes are in the graph.

EdgeCount

Returns the number of edges going out from this node.. The   Edge and EdgeCount property provide access to all the edges leading from, or out of, this node.
 (Inherited from GGraph.TGGraphNode.)

Edges

Maintains a list of edges that either come into the current node or go out to other nodes. (Inherited from GGraph.TGGraphNode.)

Edge[Integer]

Returns the edge specified by the index. The   Edge and EdgeCount property provide access to all the edges leading from, or out of, this node.
 (Inherited from GGraph.TGGraphNode.)

Graph

Specifies the owner of the node. Change the Graph property to move the node from one graph to another (it loses all of its edges though since the other nodes stay in the old graph). (Inherited from GGraph.TGGraphNode.)

InDegree

Returns the number of nodes connected to the current node (as opposed to which nodes this node points to).
 (Inherited from GGraph.TGGraphNode.)

OutDegree

Returns the number of nodes that this node points to.
 (Inherited from GGraph.TGGraphNode.)

ShortestPath

Contains a list of nodes (in the Objects property) defining the shortest path between the node at index 0 and the current node.

This property is filled in by the     EnumerateShortestPaths method of the TGCustomGraph class. After calling the EnumerateShortestPaths method, you can use this property to find the shortest path between the first node and this node. The Weight property will be filled in with the length or cost of getting from the start node to this node.

This property may be nil (if the EnumerateShortestPaths method is not called, directly or indirectly). When the node is destroyed, it will free the TStrings property if it is not nil.
 

UpdateCount

Maintains a count of how many   BeginUpdate calls have occurred without an equivalent   EndUpdate call. (Inherited from GGraph.TGGraphNode.)

Visited

The Visited property is used by some the TGCustomGraph object methods when traversing the graph. This property specifies the node has previously been visited by the traversal. (Inherited from GGraph.TGGraphNode.)

Weight

The Weight property is used by the GGraph.TGCustomGraph class to hold the length or cost to get to this node from another start node. The weight is calculated based on a start node when you call the   EnumerateShortestPaths or   ShortestPath methods.
 

WorkTag

The WorkTag property is used by some the TGCustomGraph object methods when traversing the graph. It can hold any integer the graph needs, such as the minimum current cost found to get to this node from another node. (Inherited from GGraph.TGGraphNode.)

AddEdge(TGGraphNode)

Creates an edge from the current node to the ANode parameter and returns the edge.

The current node will be assigned to the     FromNode property of the edge, and the ANode parameter will be assigned to the ToNode property of the edge. The edge is added to the current node's list of edges (accessible with the     Edge and EdgeCount properties). If the graph is undirected, the edge is also added to the ANode edge list.

AddingEdgeFrom(TGGraphNode,TGGraphEdge)

Called when a node is adding an edge from itself to this node. (Inherited from GGraph.TGGraphNode.)

AddingEdgeTo(TGGraphNode,TGGraphEdge)

Called when a node is adding an edge to another node. (Inherited from GGraph.TGGraphNode.)

Assign(TPersistent)

Represents method Assign(TPersistent). (Overrides GGraph.TGGraphNode.Assign(TPersistent).)

BeginUpdate

The BeginUpdate method prevents the node from reporting changes until the EndUpdate method is called.

Call BeginUpdate before adding, removing, or modifying edges or otherwise modifying the node. BeginUpdate speeds processing time by deferring OnChange events until EndUpdate is called.
 

Change

Called when the node changes. (Inherited from GGraph.TGGraphNode.)

Clear

Clears the node, in this case, this means to delete all edges from the node to other nodes. Other node descendants can override this behavior to also clear other information. (Inherited from GGraph.TGGraphNode.)

ClosestNode(Boolean)

Finds the closest, directly connected node to the current node. This method examines the node's list of connected nodes and finds the edge that has the smallest weight and whose node's Visited property equals the Visited parameter.

If there is no directly connected nodes, this function returns nil.

EndUpdate

The EndUpdate method reports the changes deferred by a call to     BeginUpdate.

Call EndUpdate at the end of a segment of code that began with a call to BeginUpdate. Every time BeginUpdate is called, an internal counter is incremented. When EndUpdate is called, the counter is decremented. When every call to BeginUpdate has been matched by a call to EndUpdate, EndUpdate signals an     OnChange event.
 

FastClear

FastClear is called by the graph when it knows it is deleting all nodes, so no events or anything else need to be passed around
 (Inherited from GGraph.TGGraphNode.)

GetEnumerator

Returns an enumerator to enumerate over all the edges in the node. (Inherited from GGraph.TGGraphNode.)

IndexOfEdge(TGGraphEdge)

Returns the index of the AnEdge parameter in the current node's edge list. This index may then be passed to the Edge property or the RemoveEdge method. The function returns -1 if the edge is not in the list of edges. (Inherited from GGraph.TGGraphNode.)

IndexOfEdgeTo(TGGraphNode)

Finds the first edge in the current node's edge list that goes to the specified ANode parameter. If no edge goes to the node, the function returns -1. (Inherited from GGraph.TGGraphNode.)

NewEdge(TGGraphNode,TGGraphNode)

Creates a new edge from one node to another. (Overrides GGraph.TGGraphNode.NewEdge(TGGraphNode,TGGraphNode).)

ReadData(TReader)

Reads the node from the TReader stream (Overrides GGraph.TGGraphNode.ReadData(TReader).)

RemoveEdge(Integer)

Overloaded.  Removes the edge at the position given by the Index parameter. Call RemoveEdge to remove the edge at a specific position from the node's out-bound edge list. The index is zero-based, so the first edge has an Index value of 0, the second edge has an Index value of 1, and so on. Calling RemoveEdge moves up all edges in the Edge array that follow the deleted edge, and reduces the     EdgeCount.

RemoveEdge(TGGraphEdge)

Overloaded. Removes the specified edge from the node's out-bound edge list.

RemovePredecessors

Overloaded. Removes all predecessors, i.e., remove all edges from other nodes which point to the current node. (Inherited from GGraph.TGGraphNode.)

RemovePredecessors(TGGraphNode)

Overloaded. Remove all edges to the input node from the current node's list of edges. (Inherited from GGraph.TGGraphNode.)

RemovingEdgeFrom(TGGraphNode,TGGraphEdge)

Remove the edge from ANode to the current node (Inherited from GGraph.TGGraphNode.)

RemovingEdgeTo(TGGraphNode,TGGraphEdge)

Remove our out edge connected to the other node (Inherited from GGraph.TGGraphNode.)

TextChange(String)

Called when the Caption is about to change. (Inherited from GGraph.TGGraphNode.)

WriteData(TWriter)

Writes the node to the TWriter stream (Overrides GGraph.TGGraphNode.WriteData(TWriter).)

OnChange

Occurs when the node is changed, i.e., edges are added or deleted, weight is changed, etc. The OnChange event occurs after every change.

Write an OnChange event handler to execute some code every time the node changes. The OnChange event can be deferred by calling the BeginUpdate method.