CartoTypeCore::RouteSegment Class Reference

#include <cartotype_navigation.h>

Public Member Functions
void	WriteAsXml (OutputStream &aOutput, const Projection &aProjection) const
std::unique_ptr< RouteSegment >	Copy () const
bool	IsPrivate () const

Public Attributes
CartoTypeCore::FeatureInfo	FeatureInfo
String	Name
String	Ref
double	Distance = 0
double	Time = 0
double	TurnTime = 0
OnCurveContour	Path
int32_t	Section = 0
CartoTypeCore::Turn	Turn

Detailed Description

Information about a route segment.

Member Function Documentation

Copy()

std::unique_ptr< RouteSegment > CartoTypeCore::RouteSegment::Copy

(

)

const

Creates a copy of this route segment.

IsPrivate()

bool CartoTypeCore::RouteSegment::IsPrivate ( ) const

inline

Returns true if this segment is not normally accessible.

WriteAsXml()

void CartoTypeCore::RouteSegment::WriteAsXml	(	OutputStream &	aOutput,
		const Projection &	aProjection
	)		const

Writes a route segment in XML as a segment element. Uses aProjection to convert the points to latitude and longitude.

Member Data Documentation

Distance

double CartoTypeCore::RouteSegment::Distance = 0

The distance in metres.

FeatureInfo

CartoTypeCore::FeatureInfo CartoTypeCore::RouteSegment::FeatureInfo

The feature info (road type, level, bridge, tunnel, etc.) of the object of which this segment is a part.

Name

String CartoTypeCore::RouteSegment::Name

The standard name of the object of which this segment is a part.

Path

OnCurveContour CartoTypeCore::RouteSegment::Path

The path of this segment in map units.

Ref

String CartoTypeCore::RouteSegment::Ref

The road reference of the object of which this segment is a part.

Section

int32_t CartoTypeCore::RouteSegment::Section = 0

The section number. Routes are divided into sections between waypoints. A simple route has one section, a route with an intermediate waypoint has two sections, and so on. Sections are numbered from zero upwards.

Time

double CartoTypeCore::RouteSegment::Time = 0

The estimated time in seconds, including iTurnTime, taken to traverse the segment.

Turn

CartoTypeCore::Turn CartoTypeCore::RouteSegment::Turn

Information about how to navigate the junction at the start of this segment.

TurnTime

double CartoTypeCore::RouteSegment::TurnTime = 0

The estimated time in seconds taken to navigate the junction at the start of the segment.

---

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

• cartotype_navigation.h