osmscout::RouteDescription Class Reference

#include <libosmscout/include/osmscout/routing/RouteDescription.h>

Classes
class	Description
class	StartDescription
class	TargetDescription
class	NameDescription
class	NameChangedDescription
class	CrossingWaysDescription
class	DirectionDescription
class	TurnDescription
class	RoundaboutEnterDescription
class	RoundaboutLeaveDescription
class	MotorwayEnterDescription
class	MotorwayChangeDescription
class	MotorwayLeaveDescription
class	MotorwayJunctionDescription
class	DestinationDescription
class	MaxSpeedDescription
class	TypeNameDescription
class	POIAtRouteDescription
class	LaneDescription
class	SuggestedLaneDescription
class	ViaDescription
class	Node

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

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

Static Public Attributes
static const char *const	NODE_START_DESC
static const char *const	NODE_TARGET_DESC
static const char *const	WAY_NAME_DESC
static const char *const	WAY_NAME_CHANGED_DESC
static const char *const	CROSSING_WAYS_DESC
static const char *const	DIRECTION_DESC
static const char *const	TURN_DESC
static const char *const	ROUNDABOUT_ENTER_DESC
static const char *const	ROUNDABOUT_LEAVE_DESC
static const char *const	MOTORWAY_ENTER_DESC
static const char *const	MOTORWAY_CHANGE_DESC
static const char *const	MOTORWAY_LEAVE_DESC
static const char *const	MOTORWAY_JUNCTION_DESC
static const char *const	CROSSING_DESTINATION_DESC
static const char *const	WAY_MAXSPEED_DESC
static const char *const	WAY_TYPE_NAME_DESC
static const char *const	POI_AT_ROUTE_DESC
static const char *const	LANES_DESC
static const char *const	SUGGESTED_LANES_DESC
static const char *const	NODE_VIA_DESC

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

Nodes() [2/2]

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

inline

SetDatabaseMapping()

void osmscout::RouteDescription::SetDatabaseMapping

(

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

databaseMapping

)

Member Data Documentation

CROSSING_DESTINATION_DESC

const char* const osmscout::RouteDescription::CROSSING_DESTINATION_DESC

static

Constant for a description of a destination to choose at a junction

CROSSING_WAYS_DESC

const char* const osmscout::RouteDescription::CROSSING_WAYS_DESC

static

Constant for a description of list of way name crossing a node (CrossingWaysDescription)

DIRECTION_DESC

const char* const osmscout::RouteDescription::DIRECTION_DESC

static

Constant for a description of drive direction (DirectionDescription)

LANES_DESC

const char* const osmscout::RouteDescription::LANES_DESC

static

Constant for a description of route lanes (LaneDescription)

MOTORWAY_CHANGE_DESC

const char* const osmscout::RouteDescription::MOTORWAY_CHANGE_DESC

static

Constant for a description of changing a motorway (MotorwayChangeDescription)

MOTORWAY_ENTER_DESC

const char* const osmscout::RouteDescription::MOTORWAY_ENTER_DESC

static

Constant for a description of entering a motorway (MotorwayEnterDescription)

MOTORWAY_JUNCTION_DESC

const char* const osmscout::RouteDescription::MOTORWAY_JUNCTION_DESC

static

Constant for a description of node describing a motorway junction

MOTORWAY_LEAVE_DESC

const char* const osmscout::RouteDescription::MOTORWAY_LEAVE_DESC

static

Constant for a description of leaving a motorway (MotorwayLeaveDescription)

NODE_START_DESC

const char* const osmscout::RouteDescription::NODE_START_DESC

static

Constant for a description of the start node (StartDescription)

NODE_TARGET_DESC

const char* const osmscout::RouteDescription::NODE_TARGET_DESC

static

Constant for a description of the target node (TargetDescription)

NODE_VIA_DESC

const char* const osmscout::RouteDescription::NODE_VIA_DESC

static

Constant for a description of the first node of a route section

POI_AT_ROUTE_DESC

const char* const osmscout::RouteDescription::POI_AT_ROUTE_DESC

static

Constant for a description of pois at the route (POIAtRouteDescription)

ROUNDABOUT_ENTER_DESC

const char* const osmscout::RouteDescription::ROUNDABOUT_ENTER_DESC

static

Constant for a description of entering a roundabout (RoundaboutEnterDescription)

ROUNDABOUT_LEAVE_DESC

const char* const osmscout::RouteDescription::ROUNDABOUT_LEAVE_DESC

static

Constant for a description of leaving a roundabout (RoundaboutLeaveDescription)

SUGGESTED_LANES_DESC

const char* const osmscout::RouteDescription::SUGGESTED_LANES_DESC

static

Constant for a description of suggested route lanes (SuggestedLaneDescription)

TURN_DESC

const char* const osmscout::RouteDescription::TURN_DESC

static

Constant for a description of an explicit turn (TurnDescription)

WAY_MAXSPEED_DESC

const char* const osmscout::RouteDescription::WAY_MAXSPEED_DESC

static

Constant for a description of the maximum speed for the given way

WAY_NAME_CHANGED_DESC

const char* const osmscout::RouteDescription::WAY_NAME_CHANGED_DESC

static

Constant for a description of a change of way name (NameChangedDescription)

WAY_NAME_DESC

const char* const osmscout::RouteDescription::WAY_NAME_DESC

static

Constant for a description of name of the way (NameDescription)

WAY_TYPE_NAME_DESC

const char* const osmscout::RouteDescription::WAY_TYPE_NAME_DESC

static

Constant for a description of type name of the way (TypeNameDescription)

---

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

• libosmscout/include/osmscout/routing/RouteDescription.h