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

Inheritance diagram for osmscout::RouteDescriptionPostprocessor::Callback:

Public Member Functions
virtual	~Callback ()=default
virtual void	BeforeRoute ()
virtual void	OnStart (const RouteDescription::StartDescriptionRef &startDescription, const RouteDescription::TypeNameDescriptionRef &typeNameDescription, const RouteDescription::NameDescriptionRef &nameDescription)
virtual void	OnTargetReached (const RouteDescription::TargetDescriptionRef &targetDescription)
virtual void	OnTurn (const RouteDescription::TurnDescriptionRef &turnDescription, const RouteDescription::CrossingWaysDescriptionRef &crossingWaysDescription, const RouteDescription::DirectionDescriptionRef &directionDescription, const RouteDescription::TypeNameDescriptionRef &typeNameDescription, const RouteDescription::NameDescriptionRef &nameDescription)
virtual void	OnRoundaboutEnter (const RouteDescription::RoundaboutEnterDescriptionRef &roundaboutEnterDescription, const RouteDescription::CrossingWaysDescriptionRef &crossingWaysDescription)
virtual void	OnRoundaboutLeave (const RouteDescription::RoundaboutLeaveDescriptionRef &roundaboutLeaveDescription, const RouteDescription::NameDescriptionRef &nameDescription)
virtual void	OnMotorwayEnter (const RouteDescription::MotorwayEnterDescriptionRef &motorwayEnterDescription, const RouteDescription::CrossingWaysDescriptionRef &crossingWaysDescription)
virtual void	OnMotorwayChange (const RouteDescription::MotorwayChangeDescriptionRef &motorwayChangeDescription, const RouteDescription::MotorwayJunctionDescriptionRef &motorwayJunctionDescription, const RouteDescription::DirectionDescriptionRef &directionDescription, const RouteDescription::DestinationDescriptionRef &crossingDestinationDescription)
virtual void	OnMotorwayLeave (const RouteDescription::MotorwayLeaveDescriptionRef &motorwayLeaveDescription, const RouteDescription::MotorwayJunctionDescriptionRef &motorwayJunctionDescription, const RouteDescription::DirectionDescriptionRef &directionDescription, const RouteDescription::NameDescriptionRef &nameDescription, const RouteDescription::DestinationDescriptionRef &destinationDescription)
virtual void	OnPathNameChange (const RouteDescription::NameChangedDescriptionRef &nameChangedDescription)
virtual void	OnMaxSpeed (const RouteDescription::MaxSpeedDescriptionRef &maxSpeedDescription)
virtual void	OnPOIAtRoute (const RouteDescription::POIAtRouteDescriptionRef &poiAtRouteDescription)
virtual void	OnViaAtRoute (const RouteDescription::ViaDescriptionRef &viaDescription)
virtual void	BeforeNode (const RouteDescription::Node &node)
virtual void	AfterNode (const RouteDescription::Node &node)
virtual bool	Continue () const

Detailed Description

Callback class that gets call in various routing situations.

Constructor & Destructor Documentation

◆ ~Callback()

virtual osmscout::RouteDescriptionPostprocessor::Callback::~Callback ( )

virtualdefault

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

Member Function Documentation

◆ AfterNode()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::AfterNode ( const RouteDescription::Node & node )

virtual

Called after all possible callback methods for a node are called.

Parameters

node

◆ BeforeNode()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::BeforeNode ( const RouteDescription::Node & node )

virtual

Always called before we analyse a node. It may be that other callback methods are called or not (normally we only call other methods, if something relevant changes).

Parameters

node

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

◆ BeforeRoute()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::BeforeRoute ( )

virtual

Call once before evaluation the the RouteDescription starts

◆ Continue()

virtual bool osmscout::RouteDescriptionPostprocessor::Callback::Continue ( ) const

virtual

If postprocessor should continue

Returns: continue

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

◆ OnMaxSpeed()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::OnMaxSpeed ( const RouteDescription::MaxSpeedDescriptionRef & maxSpeedDescription )

virtual

Called everytime we have max speed information for a route segment

Parameters

maxSpeedDescription

◆ OnMotorwayChange()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::OnMotorwayChange	(	const RouteDescription::MotorwayChangeDescriptionRef &	motorwayChangeDescription,
		const RouteDescription::MotorwayJunctionDescriptionRef &	motorwayJunctionDescription,
		const RouteDescription::DirectionDescriptionRef &	directionDescription,
		const RouteDescription::DestinationDescriptionRef &	crossingDestinationDescription )

virtual

Called if we already on a motorway and switch to another motorway

Parameters

motorwayLeaveDescription	and and ref of leaving motorway
motorwayJunctionDescription	name and ref of the motorway exit
directionDescription	turn direction (right, left...)
crossingDestinationDescription	semicolon separated list of exit destinations

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

◆ OnMotorwayEnter()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::OnMotorwayEnter	(	const RouteDescription::MotorwayEnterDescriptionRef &	motorwayEnterDescription,
		const RouteDescription::CrossingWaysDescriptionRef &	crossingWaysDescription )

virtual

Called if we enter a motorway

Parameters

motorwayEnterDescription
crossingWaysDescription

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

◆ OnMotorwayLeave()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::OnMotorwayLeave	(	const RouteDescription::MotorwayLeaveDescriptionRef &	motorwayLeaveDescription,
		const RouteDescription::MotorwayJunctionDescriptionRef &	motorwayJunctionDescription,
		const RouteDescription::DirectionDescriptionRef &	directionDescription,
		const RouteDescription::NameDescriptionRef &	nameDescription,
		const RouteDescription::DestinationDescriptionRef &	destinationDescription )

virtual

Called if we are on a motorway an leave it to a non-motorway way.

Parameters

motorwayLeaveDescription	and and ref of leaving motorway
motorwayJunctionDescription	name and ref of the motorway exit
directionDescription	turn direction (right, left...)
nameDescription	name of the way used for leaving
destinationDescription	semicolon separated list of exit destinations

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

◆ OnPathNameChange()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::OnPathNameChange ( const RouteDescription::NameChangedDescriptionRef & nameChangedDescription )

virtual

Called anytime the way we are on changes its name.

Parameters

nameChangedDescription

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

◆ OnPOIAtRoute()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::OnPOIAtRoute ( const RouteDescription::POIAtRouteDescriptionRef & poiAtRouteDescription )

virtual

Called everytime we have a POI at the route

Parameters

poiAtRouteDescription The POI information

◆ OnRoundaboutEnter()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::OnRoundaboutEnter	(	const RouteDescription::RoundaboutEnterDescriptionRef &	roundaboutEnterDescription,
		const RouteDescription::CrossingWaysDescriptionRef &	crossingWaysDescription )

virtual

Called if we enter a roundabout

Parameters

roundaboutEnterDescription
crossingWaysDescription

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

◆ OnRoundaboutLeave()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::OnRoundaboutLeave	(	const RouteDescription::RoundaboutLeaveDescriptionRef &	roundaboutLeaveDescription,
		const RouteDescription::NameDescriptionRef &	nameDescription )

virtual

Called if we leave a roundabout entered before

Parameters

roundaboutLeaveDescription
nameDescription

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

◆ OnStart()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::OnStart	(	const RouteDescription::StartDescriptionRef &	startDescription,
		const RouteDescription::TypeNameDescriptionRef &	typeNameDescription,
		const RouteDescription::NameDescriptionRef &	nameDescription )

virtual

Called one for the start node

Parameters

startDescription
typeNameDescription
nameDescription

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

◆ OnTargetReached()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::OnTargetReached ( const RouteDescription::TargetDescriptionRef & targetDescription )

virtual

Called once for the target node reached

Parameters

targetDescription

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

◆ OnTurn()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::OnTurn	(	const RouteDescription::TurnDescriptionRef &	turnDescription,
		const RouteDescription::CrossingWaysDescriptionRef &	crossingWaysDescription,
		const RouteDescription::DirectionDescriptionRef &	directionDescription,
		const RouteDescription::TypeNameDescriptionRef &	typeNameDescription,
		const RouteDescription::NameDescriptionRef &	nameDescription )

virtual

Call everytime a turn is necessary. Call with all information available regarding the turn and the way turned into and its direction.

Parameters

turnDescription
crossingWaysDescription
directionDescription
typeNameDescription
nameDescription

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

◆ OnViaAtRoute()

virtual void osmscout::RouteDescriptionPostprocessor::Callback::OnViaAtRoute ( const RouteDescription::ViaDescriptionRef & viaDescription )

virtual

Called everytime we have a new section at the route when routing with some via points between start and target

Parameters

viaDescription The via information

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

libosmscout/include/osmscout/routing/RouteDescriptionPostprocessor.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~Callback()

Member Function Documentation

◆ AfterNode()

◆ BeforeNode()

◆ BeforeRoute()

◆ Continue()

◆ OnMaxSpeed()

◆ OnMotorwayChange()

◆ OnMotorwayEnter()

◆ OnMotorwayLeave()

◆ OnPathNameChange()

◆ OnPOIAtRoute()

◆ OnRoundaboutEnter()

◆ OnRoundaboutLeave()

◆ OnStart()

◆ OnTargetReached()

◆ OnTurn()

◆ OnViaAtRoute()