Skip navigation links

Oracle® Spatial Java API Reference
11g Release 1 (11.1)

B28401-02


oracle.spatial.network.lod
Class EuclideanCostFunction

java.lang.Object
  extended by oracle.spatial.network.lod.EuclideanCostFunction

All Implemented Interfaces:
HeuristicCostFunction

public class EuclideanCostFunction
extends java.lang.Object
implements HeuristicCostFunction

This class implements the A* heuristic cost function as the 2D euclidean distance between the current node and the goal node.

Since:
11gR2

Constructor Summary
EuclideanCostFunction(java.lang.String geometryUserDataName, java.lang.String xCoordUserDataName, java.lang.String yCoordUserDataName)
          Creates a EuclideanCostFunction instance.

 

Method Summary
 double getHeuristicCost(double x1, double y1, double x2, double y2)
          The implementataion of this abstract method should return the heuristic cost between point (x1, y1) and (x2, y2).
 double getHeuristicCost(LogicalNode currentNode, LogicalNode goalNode)
          Returns the heuristic cost between the current node and the goal node.
 boolean requiresUserData()
           

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface oracle.spatial.network.lod.HeuristicCostFunction
getHeuristicCost, requiresUserData

 

Constructor Detail

EuclideanCostFunction

public EuclideanCostFunction(java.lang.String geometryUserDataName,
                             java.lang.String xCoordUserDataName,
                             java.lang.String yCoordUserDataName)
Creates a EuclideanCostFunction instance. The input parameters are interpreted as follows:
If neither xCoordUserDataName nor yCoordUserDataName is null, then the the heuristic cost is computed using the x and y coordinates stored as user data of the nodes;
Else if geometryUserDataName is not null, then the heuristic cost is computed using the JGeometry object stored as user data of the nodes;
If all of the input parameters are null, then the heuristic cost is computed using the JGeometry object obtained from the spatial node object. Note that in the last case, the input nodes must be of type SpatialNode or SpatialNetNode.
Parameters:
geometryUserDataName - user date name registered for geometries of the nodes
xCoordUserDataName - user data name registered for x coordinates of the nodes
yCoordUserDataName - user data name registered for y coordinates of the nodes

Method Detail

getHeuristicCost

public double getHeuristicCost(double x1,
                               double y1,
                               double x2,
                               double y2)
The implementataion of this abstract method should return the heuristic cost between point (x1, y1) and (x2, y2).
Parameters:
x1 - x coordinate of the current point
y1 - y coordinate of the current point
x2 - x coordinate of the goal point
y2 - y coordinate of the goal point
Returns:

getHeuristicCost

public double getHeuristicCost(LogicalNode currentNode,
                               LogicalNode goalNode)
Returns the heuristic cost between the current node and the goal node.
Parameters:
currentNode - current node
goalNode - goal node
Returns:

requiresUserData

public boolean requiresUserData()

Skip navigation links

Oracle® Spatial Java API Reference
11g Release 1 (11.1)

B28401-02


Copyright © 2007, 2008, Oracle. All Rights Reserved.