CartoType::Router::CRoute Class Reference

#include <cartotype_router.h>

List of all members.

Public Member Functions
void	Clear ()
CT_IMPORT TResult	ReadFromXml (MInputStream &aInput, const CMapDataBase *aMapDataBase)
CT_IMPORT TResult	WriteAsXml (MOutputStream &aOutput, const CMapDataBase *aMapDataBase) const
CT_IMPORT void	GetNearestSegment (const TPoint &aPoint, TNearestSegmentInfo &aInfo) const
CT_IMPORT TResult	Append (const CRoute &aRoute)
Public Attributes
CPointerArray< CRouteSegment >	iRouteSegment
int32	iDistance
int32	iCost
CContour	iPath

---

Detailed Description

Information about an entire route.

---

Member Function Documentation

CT_EXPORT TResult CRoute::Append

(

const CRoute &

aRoute

)

Append one route to another.

CT_EXPORT void CRoute::GetNearestSegment	(	const TPoint &	aPoint,
		TNearestSegmentInfo &	aInfo
	)		const

Get information about the nearest route segment to a point given in map coordinates.

CT_EXPORT TResult CRoute::ReadFromXml	(	MInputStream &	aInput,
		const CMapDataBase *	aMapDataBase
	)

Read a route from an XML <CartoTypeRoute> element. If aMapDataBase is non-null, use its projection and point format to project the points from latitude and longitude.

CT_EXPORT TResult CRoute::WriteAsXml	(	MOutputStream &	aOutput,
		const CMapDataBase *	aMapDataBase
	)		const

Write a route as an XML <CartoTypeRoute> element. If aMapDataBase is non-null, use its projection and point format to inverse-project the points back to latitude and longitude.

---

Member Data Documentation

int32 CartoType::Router::CRoute::iCost

The cost of the route in arbitrary units.

int32 CartoType::Router::CRoute::iDistance

The distance of the route in map units (usually metres or 64ths of metres).

CContour CartoType::Router::CRoute::iPath

The path along the entire route in map units (usually metres or 64ths of metres).

CPointerArray<CRouteSegment> CartoType::Router::CRoute::iRouteSegment

An array of route segments representing the route.

---

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

• cartotype_router.h
• cartotype_router.cpp