CartoType::Router::CRouter Class Reference

#include <cartotype_router.h>

List of all members.

Public Member Functions
CT_IMPORT	CRouter (CRouterInfo &aRouterInfo, const TPoint &aStart, const TPoint &aEnd)
CT_IMPORT TResult	CalculateRoute ()
CT_IMPORT bool	CalculateRouteStep (TResult &aError)
int32	RouteNodes () const
const CNode *	RouteNode (int32 aIndex) const
CT_IMPORT COutline *	CreateRouteOutline (TResult &aError)
CT_IMPORT CRoute *	CreateRoute (TResult &aError)

---

Detailed Description

The router. It calculates routes through cyclic directed graphs using data supplied by an abstract interface. It uses the A-star algorithm.

A router object can be used incrementally as part of a cooperative multitasking system by calling CalculateRouteStep repeatedly.

---

Constructor & Destructor Documentation

CT_EXPORT CRouter::CRouter	(	CRouterInfo &	aRouterInfo,
		const TPoint &	aStart,
		const TPoint &	aEnd
	)

Create a router object that gets its nodes and arcs from aRouterInfo.

---

Member Function Documentation

CT_EXPORT TResult CRouter::CalculateRoute

(

)

Calculate the route.

CT_EXPORT bool CRouter::CalculateRouteStep

(

TResult &

aError

)

Perform another route calculation step. Return false if there is nothing more to be done or if an error has occurred.

CT_EXPORT CRoute * CRouter::CreateRoute

(

TResult &

aError

)

Create a CRoute object giving information about a route that has already been calculated.

CT_EXPORT COutline * CRouter::CreateRouteOutline

(

TResult &

aError

)

Create an outline containing the current route if any.

---

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

• cartotype_router.h
• cartotype_router.cpp