dk.deepthought.sidious.planner.graph
Interface Graph

All Known Implementing Classes:

AStarGraph

public interface Graph

This is the general interface for a graph used for pathfinding.

Author:

Deepthought

Method Summary

java.util.Collection<Edge>	getEdges(Vertex v) Gets the edges with the specified Vertex as starting point.
Vertex	getGoalVertex() Gets the goal Vertex of this Graph.
SuperLinkID	getId() Returns the id of the owner/requester for this graph.
Vertex	getSourceVertex() Gets the source Vertex of this Graph.
void	setApproximateGoal(Vertex v) Method sets the goalVertex to this vertex if all the goal state descriptors are contained in the input vertex.

Method Detail

getEdges

java.util.Collection<Edge> getEdges(Vertex v)

Gets the edges with the specified Vertex as starting point.

Parameters:

v - the starting Vertex

Returns:

all edges starting in the specified Vertex

getSourceVertex

Vertex getSourceVertex()

Gets the source Vertex of this Graph. The source vertex is defined as the starting point of any path in this graph.

The implementing graph class must guarantee that any preconditions for the source vertex of the Pathfinder are not violated.

Returns:

the source vertex of this graph

getGoalVertex

Vertex getGoalVertex()

Gets the goal Vertex of this Graph. The goal vertex is defined as the ending point of any path in this graph.

The implementing graph class must guarantee that any preconditions for the goal vertex of the Pathfinder are not violated.

Returns:

the goal vertex of this graph

setApproximateGoal

void setApproximateGoal(Vertex v)

Method sets the goalVertex to this vertex if all the goal state descriptors are contained in the input vertex.

Parameters:

v - the approximate goal candidate

Throws:

java.lang.IllegalArgumentException - thrown if the input vertex is not a valid approximate goal

getId

SuperLinkID getId()

Returns the id of the owner/requester for this graph.

Returns:

the id of the requester