osmscout::RouteDescription Class Reference

Description of a route, enhanced with information that are required to give a human textual (or narrative) drive instructions;. More...

#include <RouteDescription.h>

Classes
class	CrossingWaysDescription
	List the names of all ways, that are crossing the current node. More...
class	Description
	Base class of all descriptions. More...
class	DestinationDescription
	Destination of the route. More...
class	DirectionDescription
	Describes the turn and the curve while getting from the previous node to the next node via the current node. More...
class	LaneDescription
	A route lane. More...
class	MaxSpeedDescription
	A motorway junction. More...
class	MotorwayChangeDescription
	Signals changing a motorway. More...
class	MotorwayEnterDescription
	Signals entering a motorway. More...
class	MotorwayJunctionDescription
	A motorway junction. More...
class	MotorwayLeaveDescription
	Signals leaving a motorway. More...
class	NameChangedDescription
	Something has a name. More...
class	NameDescription
	Something has a name. More...
class	Node
class	POIAtRouteDescription
	A motorway junction. More...
class	RoundaboutEnterDescription
	Signals entering a roundabout. More...
class	RoundaboutLeaveDescription
	Signals leaving a roundabout. More...
class	StartDescription
	Start of the route. More...
class	SuggestedLaneDescription
	A suggested route lanes. More...
class	TargetDescription
	Target of the route. More...
class	TurnDescription
	Signals an explicit turn. More...
class	TypeNameDescription
	Something has a type name. More...
class	ViaDescription
	Start of the route. More...

Public Types
using	CrossingWaysDescriptionRef = std::shared_ptr< CrossingWaysDescription >
using	DescriptionRef = std::shared_ptr< Description >
using	DestinationDescriptionRef = std::shared_ptr< DestinationDescription >
using	DirectionDescriptionRef = std::shared_ptr< DirectionDescription >
using	LaneDescriptionRef = std::shared_ptr< LaneDescription >
using	MaxSpeedDescriptionRef = std::shared_ptr< MaxSpeedDescription >
using	MotorwayChangeDescriptionRef = std::shared_ptr< MotorwayChangeDescription >
using	MotorwayEnterDescriptionRef = std::shared_ptr< MotorwayEnterDescription >
using	MotorwayJunctionDescriptionRef = std::shared_ptr< MotorwayJunctionDescription >
using	MotorwayLeaveDescriptionRef = std::shared_ptr< MotorwayLeaveDescription >
using	NameChangedDescriptionRef = std::shared_ptr< NameChangedDescription >
using	NameDescriptionRef = std::shared_ptr< NameDescription >
using	NodeIterator = std::list< RouteDescription::Node >::const_iterator
using	POIAtRouteDescriptionRef = std::shared_ptr< POIAtRouteDescription >
using	RoundaboutEnterDescriptionRef = std::shared_ptr< RoundaboutEnterDescription >
using	RoundaboutLeaveDescriptionRef = std::shared_ptr< RoundaboutLeaveDescription >
using	StartDescriptionRef = std::shared_ptr< StartDescription >
using	SuggestedLaneDescriptionRef = std::shared_ptr< SuggestedLaneDescription >
using	TargetDescriptionRef = std::shared_ptr< TargetDescription >
using	TurnDescriptionRef = std::shared_ptr< TurnDescription >
using	TypeNameDescriptionRef = std::shared_ptr< TypeNameDescription >
using	ViaDescriptionRef = std::shared_ptr< ViaDescription >

Public Member Functions
void	AddNode (DatabaseId database, size_t currentNodeIndex, const std::vector< ObjectFileRef > &objects, const ObjectFileRef &pathObject, size_t targetNodeIndex)
void	Clear ()
bool	Empty () const
std::map< DatabaseId, std::string >	GetDatabaseMapping () const
std::list< Node > &	Nodes ()
const std::list< Node > &	Nodes () const
	RouteDescription ()=default
void	SetDatabaseMapping (const std::map< DatabaseId, std::string > &databaseMapping)
virtual	~RouteDescription ()=default

Detailed Description

Description of a route, enhanced with information that are required to give a human textual (or narrative) drive instructions;.

A route consists of nodes. A Node can be the crossing point of a number of ways and is a route decision point (where the driver possibly has the change ways) that requires some potential action by the driver.

For each node you can pass a number of descriptions. For the way from the current node to the next node also a number of descriptions can get retrieved.

Descriptions are typed and must derive from class Description..

Member Typedef Documentation

CrossingWaysDescriptionRef

using osmscout::RouteDescription::CrossingWaysDescriptionRef = std::shared_ptr<CrossingWaysDescription>

DescriptionRef

using osmscout::RouteDescription::DescriptionRef = std::shared_ptr<Description>

DestinationDescriptionRef

using osmscout::RouteDescription::DestinationDescriptionRef = std::shared_ptr<DestinationDescription>

DirectionDescriptionRef

using osmscout::RouteDescription::DirectionDescriptionRef = std::shared_ptr<DirectionDescription>

LaneDescriptionRef

using osmscout::RouteDescription::LaneDescriptionRef = std::shared_ptr<LaneDescription>

MaxSpeedDescriptionRef

using osmscout::RouteDescription::MaxSpeedDescriptionRef = std::shared_ptr<MaxSpeedDescription>

MotorwayChangeDescriptionRef

using osmscout::RouteDescription::MotorwayChangeDescriptionRef = std::shared_ptr<MotorwayChangeDescription>

MotorwayEnterDescriptionRef

using osmscout::RouteDescription::MotorwayEnterDescriptionRef = std::shared_ptr<MotorwayEnterDescription>

MotorwayJunctionDescriptionRef

using osmscout::RouteDescription::MotorwayJunctionDescriptionRef = std::shared_ptr<MotorwayJunctionDescription>

MotorwayLeaveDescriptionRef

using osmscout::RouteDescription::MotorwayLeaveDescriptionRef = std::shared_ptr<MotorwayLeaveDescription>

NameChangedDescriptionRef

using osmscout::RouteDescription::NameChangedDescriptionRef = std::shared_ptr<NameChangedDescription>

NameDescriptionRef

using osmscout::RouteDescription::NameDescriptionRef = std::shared_ptr<NameDescription>

NodeIterator

using osmscout::RouteDescription::NodeIterator = std::list<RouteDescription::Node>::const_iterator

POIAtRouteDescriptionRef

using osmscout::RouteDescription::POIAtRouteDescriptionRef = std::shared_ptr<POIAtRouteDescription>

RoundaboutEnterDescriptionRef

using osmscout::RouteDescription::RoundaboutEnterDescriptionRef = std::shared_ptr<RoundaboutEnterDescription>

RoundaboutLeaveDescriptionRef

using osmscout::RouteDescription::RoundaboutLeaveDescriptionRef = std::shared_ptr<RoundaboutLeaveDescription>

StartDescriptionRef

using osmscout::RouteDescription::StartDescriptionRef = std::shared_ptr<StartDescription>

SuggestedLaneDescriptionRef

using osmscout::RouteDescription::SuggestedLaneDescriptionRef = std::shared_ptr<SuggestedLaneDescription>

TargetDescriptionRef

using osmscout::RouteDescription::TargetDescriptionRef = std::shared_ptr<TargetDescription>

TurnDescriptionRef

using osmscout::RouteDescription::TurnDescriptionRef = std::shared_ptr<TurnDescription>

TypeNameDescriptionRef

using osmscout::RouteDescription::TypeNameDescriptionRef = std::shared_ptr<TypeNameDescription>

ViaDescriptionRef

using osmscout::RouteDescription::ViaDescriptionRef = std::shared_ptr<ViaDescription>

Constructor & Destructor Documentation

RouteDescription()

osmscout::RouteDescription::RouteDescription ( )

default

~RouteDescription()

virtual osmscout::RouteDescription::~RouteDescription ( )

virtualdefault

Member Function Documentation

AddNode()

void osmscout::RouteDescription::AddNode	(	DatabaseId	database,
		size_t	currentNodeIndex,
		const std::vector< ObjectFileRef > &	objects,
		const ObjectFileRef &	pathObject,
		size_t	targetNodeIndex
	)

Clear()

void osmscout::RouteDescription::Clear

(

)

Empty()

bool osmscout::RouteDescription::Empty

(

)

const

GetDatabaseMapping()

std::map< DatabaseId, std::string > osmscout::RouteDescription::GetDatabaseMapping

(

)

const

Nodes() [1/2]

std::list< Node > & osmscout::RouteDescription::Nodes ( )

inline

Referenced by osmscout::Navigation< NodeDescriptionTmpl >::ClosestPointOnRoute(), osmscout::RouteDescriptionPostprocessor::GenerateDescription(), osmscout::RoutePostprocessor::StartPostprocessor::Process(), osmscout::RoutePostprocessor::TargetPostprocessor::Process(), osmscout::RoutePostprocessor::DistanceAndTimePostprocessor::Process(), osmscout::RoutePostprocessor::WayNamePostprocessor::Process(), osmscout::RoutePostprocessor::WayTypePostprocessor::Process(), osmscout::RoutePostprocessor::CrossingWaysPostprocessor::Process(), osmscout::RoutePostprocessor::DirectionPostprocessor::Process(), osmscout::RoutePostprocessor::MotorwayJunctionPostprocessor::Process(), osmscout::RoutePostprocessor::DestinationPostprocessor::Process(), osmscout::RoutePostprocessor::MaxSpeedPostprocessor::Process(), osmscout::RoutePostprocessor::InstructionPostprocessor::Process(), osmscout::RoutePostprocessor::POIsPostprocessor::Process(), osmscout::RoutePostprocessor::LanesPostprocessor::Process(), osmscout::RoutePostprocessor::SuggestedLanesPostprocessor::Process(), osmscout::RoutePostprocessor::SectionsPostprocessor::Process(), osmscout::Navigation< NodeDescriptionTmpl >::SetRoute(), and osmscout::Navigation< NodeDescriptionTmpl >::UpdateCurrentLocation().

Nodes() [2/2]

const std::list< Node > & osmscout::RouteDescription::Nodes ( ) const

inline

SetDatabaseMapping()

void osmscout::RouteDescription::SetDatabaseMapping

(

const std::map< DatabaseId, std::string > &

databaseMapping

)

---

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

• RouteDescription.h
• RouteDescription.cpp