libosmscout  0.1
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
osmscout::RouteDescription Class Reference
Routing based data structures and services

#include <RouteDescription.h>

Classes

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

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
 

Static Public Attributes

static const char *const CROSSING_DESTINATION_DESC = "CrossingDestination"
 Constant for a description of a destination to choose at a junction. More...
 
static const char *const CROSSING_WAYS_DESC = "CrossingWays"
 Constant for a description of list of way name crossing a node (CrossingWaysDescription) More...
 
static const char *const DIRECTION_DESC = "Direction"
 Constant for a description of drive direction (DirectionDescription) More...
 
static const char *const LANES_DESC = "Lanes"
 Constant for a description of route lanes (LaneDescription) More...
 
static const char *const MOTORWAY_CHANGE_DESC = "MotorwayChange"
 Constant for a description of changing a motorway (MotorwayChangeDescription) More...
 
static const char *const MOTORWAY_ENTER_DESC = "MotorwayEnter"
 Constant for a description of entering a motorway (MotorwayEnterDescription) More...
 
static const char *const MOTORWAY_JUNCTION_DESC = "MotorwayJunction"
 Constant for a description of node describing a motorway junction. More...
 
static const char *const MOTORWAY_LEAVE_DESC = "MotorwayLeave"
 Constant for a description of leaving a motorway (MotorwayLeaveDescription) More...
 
static const char *const NODE_START_DESC = "NodeStart"
 Constant for a description of the start node (StartDescription) More...
 
static const char *const NODE_TARGET_DESC = "NodeTarget"
 Constant for a description of the target node (TargetDescription) More...
 
static const char *const NODE_VIA_DESC = "NodeVia"
 Constant for a description of the first node of a route section. More...
 
static const char *const POI_AT_ROUTE_DESC = "POIAtRoute"
 Constant for a description of pois at the route (POIAtRouteDescription) More...
 
static const char *const ROUNDABOUT_ENTER_DESC = "RountaboutEnter"
 Constant for a description of entering a roundabout (RoundaboutEnterDescription) More...
 
static const char *const ROUNDABOUT_LEAVE_DESC = "RountaboutLeave"
 Constant for a description of leaving a roundabout (RoundaboutLeaveDescription) More...
 
static const char *const SUGGESTED_LANES_DESC = "SuggestedLanes"
 Constant for a description of suggested route lanes (SuggestedLaneDescription) More...
 
static const char *const TURN_DESC = "Turn"
 Constant for a description of an explicit turn (TurnDescription) More...
 
static const char *const WAY_MAXSPEED_DESC = "MaxSpeed"
 Constant for a description of the maximum speed for the given way. More...
 
static const char *const WAY_NAME_CHANGED_DESC = "WayChangedName"
 Constant for a description of a change of way name (NameChangedDescription) More...
 
static const char *const WAY_NAME_DESC = "WayName"
 Constant for a description of name of the way (NameDescription) More...
 
static const char *const WAY_TYPE_NAME_DESC = "TypeName"
 Constant for a description of type name of the way (TypeNameDescription) More...
 

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)

Member Data Documentation

◆ CROSSING_DESTINATION_DESC

const char *const osmscout::RouteDescription::CROSSING_DESTINATION_DESC = "CrossingDestination"
static

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

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription(), and osmscout::RoutePostprocessor::DestinationPostprocessor::Process().

◆ CROSSING_WAYS_DESC

const char *const osmscout::RouteDescription::CROSSING_WAYS_DESC = "CrossingWays"
static

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

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription(), and osmscout::RoutePostprocessor::CrossingWaysPostprocessor::Process().

◆ DIRECTION_DESC

const char *const osmscout::RouteDescription::DIRECTION_DESC = "Direction"
static

Constant for a description of drive direction (DirectionDescription)

Constant for a description of a turn (TurnDescription)

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription(), and osmscout::RoutePostprocessor::DirectionPostprocessor::Process().

◆ LANES_DESC

const char *const osmscout::RouteDescription::LANES_DESC = "Lanes"
static

Constant for a description of route lanes (LaneDescription)

Referenced by osmscout::LaneAgent::Process(), and osmscout::RoutePostprocessor::LanesPostprocessor::Process().

◆ MOTORWAY_CHANGE_DESC

const char *const osmscout::RouteDescription::MOTORWAY_CHANGE_DESC = "MotorwayChange"
static

Constant for a description of changing a motorway (MotorwayChangeDescription)

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription().

◆ MOTORWAY_ENTER_DESC

const char *const osmscout::RouteDescription::MOTORWAY_ENTER_DESC = "MotorwayEnter"
static

Constant for a description of entering a motorway (MotorwayEnterDescription)

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription().

◆ MOTORWAY_JUNCTION_DESC

const char *const osmscout::RouteDescription::MOTORWAY_JUNCTION_DESC = "MotorwayJunction"
static

Constant for a description of node describing a motorway junction.

Constant for a description of motorway junction (MotorwayJunctionDescription)

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription(), and osmscout::RoutePostprocessor::MotorwayJunctionPostprocessor::Process().

◆ MOTORWAY_LEAVE_DESC

const char *const osmscout::RouteDescription::MOTORWAY_LEAVE_DESC = "MotorwayLeave"
static

Constant for a description of leaving a motorway (MotorwayLeaveDescription)

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription().

◆ NODE_START_DESC

const char *const osmscout::RouteDescription::NODE_START_DESC = "NodeStart"
static

Constant for a description of the start node (StartDescription)

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription(), and osmscout::RoutePostprocessor::StartPostprocessor::Process().

◆ NODE_TARGET_DESC

const char *const osmscout::RouteDescription::NODE_TARGET_DESC = "NodeTarget"
static

Constant for a description of the target node (TargetDescription)

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription(), and osmscout::RoutePostprocessor::TargetPostprocessor::Process().

◆ NODE_VIA_DESC

const char *const osmscout::RouteDescription::NODE_VIA_DESC = "NodeVia"
static

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

Constant for a description of a via on the rote (first node of a route section)

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription(), and osmscout::RoutePostprocessor::SectionsPostprocessor::Process().

◆ POI_AT_ROUTE_DESC

const char *const osmscout::RouteDescription::POI_AT_ROUTE_DESC = "POIAtRoute"
static

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

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

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription().

◆ ROUNDABOUT_ENTER_DESC

const char *const osmscout::RouteDescription::ROUNDABOUT_ENTER_DESC = "RountaboutEnter"
static

Constant for a description of entering a roundabout (RoundaboutEnterDescription)

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription().

◆ ROUNDABOUT_LEAVE_DESC

const char *const osmscout::RouteDescription::ROUNDABOUT_LEAVE_DESC = "RountaboutLeave"
static

Constant for a description of leaving a roundabout (RoundaboutLeaveDescription)

Constant for a description of entering a roundabout (RoundaboutLeaveDescription)

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription().

◆ SUGGESTED_LANES_DESC

const char *const osmscout::RouteDescription::SUGGESTED_LANES_DESC = "SuggestedLanes"
static

Constant for a description of suggested route lanes (SuggestedLaneDescription)

Referenced by osmscout::LaneAgent::Process().

◆ TURN_DESC

const char *const osmscout::RouteDescription::TURN_DESC = "Turn"
static

Constant for a description of an explicit turn (TurnDescription)

Constant for doing description of an explicit turn (TurnDescription)

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription().

◆ WAY_MAXSPEED_DESC

const char *const osmscout::RouteDescription::WAY_MAXSPEED_DESC = "MaxSpeed"
static

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

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription(), and osmscout::RoutePostprocessor::MaxSpeedPostprocessor::Process().

◆ WAY_NAME_CHANGED_DESC

const char *const osmscout::RouteDescription::WAY_NAME_CHANGED_DESC = "WayChangedName"
static

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

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription().

◆ WAY_NAME_DESC

const char *const osmscout::RouteDescription::WAY_NAME_DESC = "WayName"
static

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

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription(), osmscout::RoutePostprocessor::WayNamePostprocessor::Process(), and osmscout::RoutePostprocessor::InstructionPostprocessor::Process().

◆ WAY_TYPE_NAME_DESC

const char *const osmscout::RouteDescription::WAY_TYPE_NAME_DESC = "TypeName"
static

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

Referenced by osmscout::RouteDescriptionPostprocessor::GenerateDescription(), and osmscout::RoutePostprocessor::WayTypePostprocessor::Process().

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