CartoType API
Public Member Functions
CartoType::Router::CRouterInfo Class Reference

#include <cartotype_router.h>

Inheritance diagram for CartoType::Router::CRouterInfo:
CartoType::Router::CMapDataRouterInfo

List of all members.

Public Member Functions

virtual CNodeNode (TResult &aError, const TPoint &aPoint)=0
virtual int32 HeuristicWeight ()=0
virtual TPointFormat PointFormat ()=0

Detailed Description

An abstract base class to provide information needed by the routing system. Although nodes are writable, all nodes returned by the CRouterInfo object are owned and managed by that object and are destroyed when the object is destroyed.


Member Function Documentation

virtual int32 CartoType::Router::CRouterInfo::HeuristicWeight ( ) [pure virtual]

Return the weight by which distances are multiplied to get the lowest possible cost of traversing a distance. This must be the weight for the fastest road type in the data. It is called the 'heuristic weight' because the term 'heuristic' is used for the estimated cost in discussions of the A-star algorithm.

Implemented in CartoType::Router::CMapDataRouterInfo.

virtual CNode* CartoType::Router::CRouterInfo::Node ( TResult aError,
const TPoint aPoint 
) [pure virtual]

Return a pointer to the nearest node to aPoint.

Implemented in CartoType::Router::CMapDataRouterInfo.

virtual TPointFormat CartoType::Router::CRouterInfo::PointFormat ( ) [pure virtual]

Return the format of the map data points.

Implemented in CartoType::Router::CMapDataRouterInfo.


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