libosmscout  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups
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 <Route.h>

Classes

class  CrossingWaysDescription
 List the names of allways, 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  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  RoundaboutEnterDescription
 Signals entering a roundabout. More...
 
class  RoundaboutLeaveDescription
 Signals leaving a roundabout. More...
 
class  StartDescription
 Start of the route. More...
 
class  TargetDescription
 Target of the route. More...
 
class  TurnDescription
 Signals an explicit turn. More...
 
class  TypeNameDescription
 Something has a type name. More...
 

Public Types

typedef std::shared_ptr
< CrossingWaysDescription
CrossingWaysDescriptionRef
 
typedef std::shared_ptr
< Description
DescriptionRef
 
typedef std::shared_ptr
< DestinationDescription
DestinationDescriptionRef
 
typedef std::shared_ptr
< DirectionDescription
DirectionDescriptionRef
 
typedef std::shared_ptr
< MaxSpeedDescription
MaxSpeedDescriptionRef
 
typedef std::shared_ptr
< MotorwayChangeDescription
MotorwayChangeDescriptionRef
 
typedef std::shared_ptr
< MotorwayEnterDescription
MotorwayEnterDescriptionRef
 
typedef std::shared_ptr
< MotorwayJunctionDescription
MotorwayJunctionDescriptionRef
 
typedef std::shared_ptr
< MotorwayLeaveDescription
MotorwayLeaveDescriptionRef
 
typedef std::shared_ptr
< NameChangedDescription
NameChangedDescriptionRef
 
typedef std::shared_ptr
< NameDescription
NameDescriptionRef
 
typedef std::shared_ptr
< RoundaboutEnterDescription
RoundaboutEnterDescriptionRef
 
typedef std::shared_ptr
< RoundaboutLeaveDescription
RoundaboutLeaveDescriptionRef
 
typedef std::shared_ptr
< StartDescription
StartDescriptionRef
 
typedef std::shared_ptr
< TargetDescription
TargetDescriptionRef
 
typedef std::shared_ptr
< TurnDescription
TurnDescriptionRef
 
typedef std::shared_ptr
< TypeNameDescription
TypeNameDescriptionRef
 

Public Member Functions

void AddNode (size_t currentNodeIndex, const std::vector< ObjectFileRef > &objects, const ObjectFileRef &pathObject, size_t targetNodeIndex)
 
void Clear ()
 
std::list< Node > & Nodes ()
 
const std::list< Node > & Nodes () const
 
 RouteDescription ()
 
virtual ~RouteDescription ()
 

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 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 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 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

Constructor & Destructor Documentation

osmscout::RouteDescription::RouteDescription ( )
osmscout::RouteDescription::~RouteDescription ( )
virtual

Member Function Documentation

void osmscout::RouteDescription::AddNode ( size_t  currentNodeIndex,
const std::vector< ObjectFileRef > &  objects,
const ObjectFileRef &  pathObject,
size_t  targetNodeIndex 
)
void osmscout::RouteDescription::Clear ( )
const std::list<Node>& osmscout::RouteDescription::Nodes ( ) const
inline

Member Data Documentation

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::RoutePostprocessor::DestinationPostprocessor::Process().

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::RoutePostprocessor::CrossingWaysPostprocessor::Process().

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::RoutePostprocessor::DirectionPostprocessor::Process().

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

Constant for a description of changing a motorway (MotorwayChangeDescription)

Referenced by osmscout::RoutePostprocessor::InstructionPostprocessor::Process().

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

Constant for a description of entering a motorway (MotorwayEnterDescription)

Referenced by osmscout::RoutePostprocessor::InstructionPostprocessor::Process().

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::RoutePostprocessor::MotorwayJunctionPostprocessor::Process().

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

Constant for a description of leaving a motorway (MotorwayLeaveDescription)

Referenced by osmscout::RoutePostprocessor::InstructionPostprocessor::Process().

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

Constant for a description of the start node (StartDescription)

Referenced by osmscout::RoutePostprocessor::StartPostprocessor::Process().

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

Constant for a description of the target node (TargetDescription)

Referenced by osmscout::RoutePostprocessor::TargetPostprocessor::Process().

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

Constant for a description of entering a roundabout (RoundaboutEnterDescription)

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)

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)

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::RoutePostprocessor::MaxSpeedPostprocessor::Process().

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

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

const char *const osmscout::RouteDescription::WAY_NAME_DESC = "WayName"
static
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::RoutePostprocessor::WayTypePostprocessor::Process().


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