com.visioglobe.libVisioDevKit

Class VgIRoutingSolver

java.lang.Object

com.visioglobe.libVisioDevKit.VgIRoutingSolver

public class VgIRoutingSolver
extends java.lang.Object

VgIRoutingSolver will calculate a route between several waypoints.

Interface:

VgRoutingModule::VgIRoutingSolver

Date:

25/02/2011

Method Summary

Methods

Modifier and Type	Method and Description
VgIRouteRequest	computeRoute(VgIRouteRequestParameters pParameters) Computes a route given some parameters.
void	delete()
VgIRoutingNodeRefPtr	getRoutingNode(java.lang.String pPoiID) Gets the virtual node associated with a given poi.
VgIRoutingNodeRefPtr	getRoutingNode(VgPosition pPosition) Gets the closest node to a given position.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

delete

public void delete()

computeRoute

public VgIRouteRequest computeRoute(VgIRouteRequestParameters pParameters)

Computes a route given some parameters.

Parameters:

pParameters - Parameters to determine the route to be computed. A notify function will be called on callback within pParameters once the route has been computed.

Returns:

VgRoutingModule::VgIRouteRequest, NULL if request is handled synchronously.

Remark:

The caller is responsible for deallocating VgRoutingModule::VgIRouteRequest

Note:

Currently, all requests are handled synchronously.

getRoutingNode

public VgIRoutingNodeRefPtr getRoutingNode(VgPosition pPosition)

Gets the closest node to a given position. Note the altitude/height of the position is used to determine the layer of the returned routing node. Example:

Parameters:

pPosition - A const reference on the position.

Returns:

A valid opaque pointer on a VgRoutingNode, or NULL if no node was found.

getRoutingNode

public VgIRoutingNodeRefPtr getRoutingNode(java.lang.String pPoiID)

Gets the virtual node associated with a given poi. Note: A poi may have several access nodes. The poi's virtual node represents all these access nodes when a route is requested. However the computed route will use only one of the access nodes and never the virtual node.

Parameters:

pPoiID - A const reference on a string containing the poi's ID.

Returns:

A valid VgIRoutingNode pointer, or NULL if no node was found.