Callback class that gets call in various routing situations. More...

#include <RouteDescriptionPostprocessor.h>

Inheritance diagram for osmscout::RouteDescriptionPostprocessor::Callback:

Public Member Functions
virtual void	AfterNode (const RouteDescription::Node &node)
	Called after all possible callback methods for a node are called. More...

virtual void	BeforeNode (const RouteDescription::Node &node)
	Always called before we analyse a node. More...

virtual void	BeforeRoute ()
	Call once before evaluation the the RouteDescription starts. More...

virtual bool	Continue () const
	If postprocessor should continue. More...

virtual void	OnMaxSpeed (const RouteDescription::MaxSpeedDescriptionRef &maxSpeedDescription)
	Called everytime we have max speed information for a route segment. More...

virtual void	OnMotorwayChange (const RouteDescription::MotorwayChangeDescriptionRef &motorwayChangeDescription, const RouteDescription::MotorwayJunctionDescriptionRef &motorwayJunctionDescription, const RouteDescription::DirectionDescriptionRef &directionDescription, const RouteDescription::DestinationDescriptionRef &crossingDestinationDescription)
	Called if we already on a motorway and switch to another motorway. More...

virtual void	OnMotorwayEnter (const RouteDescription::MotorwayEnterDescriptionRef &motorwayEnterDescription, const RouteDescription::CrossingWaysDescriptionRef &crossingWaysDescription)
	Called if we enter a motorway. More...

virtual void	OnMotorwayLeave (const RouteDescription::MotorwayLeaveDescriptionRef &motorwayLeaveDescription, const RouteDescription::MotorwayJunctionDescriptionRef &motorwayJunctionDescription, const RouteDescription::DirectionDescriptionRef &directionDescription, const RouteDescription::NameDescriptionRef &nameDescription, const RouteDescription::DestinationDescriptionRef &destinationDescription)
	Called if we are on a motorway an leave it to a non-motorway way. More...

virtual void	OnPathNameChange (const RouteDescription::NameChangedDescriptionRef &nameChangedDescription)
	Called anytime the way we are on changes its name. More...

virtual void	OnPOIAtRoute (const RouteDescription::POIAtRouteDescriptionRef &poiAtRouteDescription)
	Called everytime we have a POI at the route. More...

virtual void	OnRoundaboutEnter (const RouteDescription::RoundaboutEnterDescriptionRef &roundaboutEnterDescription, const RouteDescription::CrossingWaysDescriptionRef &crossingWaysDescription)
	Called if we enter a roundabout. More...

virtual void	OnRoundaboutLeave (const RouteDescription::RoundaboutLeaveDescriptionRef &roundaboutLeaveDescription, const RouteDescription::NameDescriptionRef &nameDescription)
	Called if we leave a roundabout entered before. More...

virtual void	OnStart (const RouteDescription::StartDescriptionRef &startDescription, const RouteDescription::TypeNameDescriptionRef &typeNameDescription, const RouteDescription::NameDescriptionRef &nameDescription)
	Called one for the start node. More...

virtual void	OnTargetReached (const RouteDescription::TargetDescriptionRef &targetDescription)
	Called once for the target node reached. More...

virtual void	OnTurn (const RouteDescription::TurnDescriptionRef &turnDescription, const RouteDescription::CrossingWaysDescriptionRef &crossingWaysDescription, const RouteDescription::DirectionDescriptionRef &directionDescription, const RouteDescription::TypeNameDescriptionRef &typeNameDescription, const RouteDescription::NameDescriptionRef &nameDescription)
	Call everytime a turn is necessary. More...

virtual void	OnViaAtRoute (const RouteDescription::ViaDescriptionRef &viaDescription)
	Called everytime we have a new section at the route when routing with some via points between start and target. More...

virtual	~Callback ()=default

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

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

virtual

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

Parameters

node

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

◆ BeforeNode()

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.

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

◆ BeforeRoute()

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

virtual

Call once before evaluation the the RouteDescription starts.

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

◆ Continue()

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

virtual

If postprocessor should continue.

Returns: continue

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

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

◆ OnMaxSpeed()

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

virtual

Called everytime we have max speed information for a route segment.

Parameters

maxSpeedDescription

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

◆ OnMotorwayChange()

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.

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

◆ OnMotorwayEnter()

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.

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

◆ OnMotorwayLeave()

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.

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

◆ OnPathNameChange()

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.

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

◆ OnPOIAtRoute()

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

virtual

Called everytime we have a POI at the route.

Parameters

poiAtRouteDescription The POI information

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

◆ OnRoundaboutEnter()

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.

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

◆ OnRoundaboutLeave()

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.

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

◆ OnStart()

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.

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

◆ OnTargetReached()

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

virtual

Called once for the target node reached.

Parameters

targetDescription

Reimplemented in osmscout::RouteDescriptionBuilder::Callback.

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

◆ OnTurn()

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.

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

◆ OnViaAtRoute()

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

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

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

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