osmscout::RouteDescriptionBuilder::Callback Class Reference

#include <RouteDescriptionBuilder.h>

Inheritance diagram for osmscout::RouteDescriptionBuilder::Callback:

Public Member Functions
void	BeforeNode (const RouteDescription::Node &node) override
	Always called before we analyse a node.
	Callback (QList< RouteStep > &routeSteps, const Distance &stopAfter=Distance::Lowest(), bool skipInformative=false)
bool	Continue () const override
	If postprocessor should continue.
RouteStep	MkStep (const QString &name)
void	OnMotorwayChange (const RouteDescription::MotorwayChangeDescriptionRef &motorwayChangeDescription, const RouteDescription::MotorwayJunctionDescriptionRef &motorwayJunctionDescription, const RouteDescription::DirectionDescriptionRef &directionDescription, const RouteDescription::DestinationDescriptionRef &crossingDestinationDescription) override
	Called if we already on a motorway and switch to another motorway.
void	OnMotorwayEnter (const RouteDescription::MotorwayEnterDescriptionRef &motorwayEnterDescription, const RouteDescription::CrossingWaysDescriptionRef &crossingWaysDescription) override
	Called if we enter a motorway.
void	OnMotorwayLeave (const RouteDescription::MotorwayLeaveDescriptionRef &motorwayLeaveDescription, const RouteDescription::MotorwayJunctionDescriptionRef &motorwayJunctionDescription, const RouteDescription::DirectionDescriptionRef &directionDescription, const RouteDescription::NameDescriptionRef &nameDescription, const RouteDescription::DestinationDescriptionRef &destinationDescription) override
	Called if we are on a motorway an leave it to a non-motorway way.
void	OnPathNameChange (const RouteDescription::NameChangedDescriptionRef &nameChangedDescription) override
	Called anytime the way we are on changes its name.
void	OnRoundaboutEnter (const RouteDescription::RoundaboutEnterDescriptionRef &roundaboutEnterDescription, const RouteDescription::CrossingWaysDescriptionRef &crossingWaysDescription) override
	Called if we enter a roundabout.
void	OnRoundaboutLeave (const RouteDescription::RoundaboutLeaveDescriptionRef &roundaboutLeaveDescription, const RouteDescription::NameDescriptionRef &nameDescription) override
	Called if we leave a roundabout entered before.
void	OnStart (const RouteDescription::StartDescriptionRef &startDescription, const RouteDescription::TypeNameDescriptionRef &typeNameDescription, const RouteDescription::NameDescriptionRef &nameDescription) override
	Called one for the start node.
void	OnTargetReached (const RouteDescription::TargetDescriptionRef &targetDescription) override
	Called once for the target node reached.
void	OnTurn (const RouteDescription::TurnDescriptionRef &turnDescription, const RouteDescription::CrossingWaysDescriptionRef &crossingWaysDescription, const RouteDescription::DirectionDescriptionRef &directionDescription, const RouteDescription::TypeNameDescriptionRef &typeNameDescription, const RouteDescription::NameDescriptionRef &nameDescription) override
	Call everytime a turn is necessary.
void	PushStreetName (const RouteDescription::NameDescriptionRef &nameDescription)
	~Callback () override=default
Public Member Functions inherited from osmscout::RouteDescriptionPostprocessor::Callback
virtual void	AfterNode (const RouteDescription::Node &node)
	Called after all possible callback methods for a node are called.
virtual void	BeforeRoute ()
	Call once before evaluation the the RouteDescription starts.
virtual void	OnMaxSpeed (const RouteDescription::MaxSpeedDescriptionRef &maxSpeedDescription)
	Called everytime we have max speed information for a route segment.
virtual void	OnPOIAtRoute (const RouteDescription::POIAtRouteDescriptionRef &poiAtRouteDescription)
	Called everytime we have a POI at the route.
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.

Constructor & Destructor Documentation

Callback()

osmscout::RouteDescriptionBuilder::Callback::Callback	(	QList< RouteStep > &	routeSteps,
		const Distance &	stopAfter = Distance::Lowest(),
		bool	skipInformative = false
	)

~Callback()

osmscout::RouteDescriptionBuilder::Callback::~Callback ( )

overridevirtualdefault

Reimplemented from osmscout::RouteDescriptionPostprocessor::Callback.

Member Function Documentation

BeforeNode()

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

overridevirtual

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 from osmscout::RouteDescriptionPostprocessor::Callback.

References osmscout::RouteDescription::Node::GetDistance(), osmscout::RouteDescription::Node::GetLocation(), and osmscout::RouteDescription::Node::GetTime().

Continue()

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

overridevirtual

If postprocessor should continue.

Returns

continue

Reimplemented from osmscout::RouteDescriptionPostprocessor::Callback.

References osmscout::RouteStep::distance.

MkStep()

RouteStep osmscout::RouteDescriptionBuilder::Callback::MkStep

(

const QString &

name

)

OnMotorwayChange()

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

overridevirtual

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 from osmscout::RouteDescriptionPostprocessor::Callback.

References osmscout::RouteStep::description, osmscout::RouteStep::destinations, osmscout::FormatMotorwayJunctionName(), osmscout::FormatName(), osmscout::RouteStep::shortDescription, and osmscout::SplitDestinations().

OnMotorwayEnter()

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

overridevirtual

Called if we enter a motorway.

Parameters

motorwayEnterDescription
crossingWaysDescription

Reimplemented from osmscout::RouteDescriptionPostprocessor::Callback.

References osmscout::CrossingWaysDescriptionToString(), osmscout::RouteStep::description, osmscout::FormatName(), and osmscout::RouteStep::shortDescription.

OnMotorwayLeave()

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

overridevirtual

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 from osmscout::RouteDescriptionPostprocessor::Callback.

References osmscout::RouteStep::description, osmscout::RouteStep::destinations, osmscout::FormatMotorwayJunctionName(), osmscout::FormatName(), osmscout::RouteStep::shortDescription, and osmscout::SplitDestinations().

OnPathNameChange()

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

overridevirtual

Called anytime the way we are on changes its name.

Parameters

nameChangedDescription

Reimplemented from osmscout::RouteDescriptionPostprocessor::Callback.

References osmscout::RouteStep::description, osmscout::FormatName(), and osmscout::RouteStep::shortDescription.

OnRoundaboutEnter()

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

overridevirtual

Called if we enter a roundabout.

Parameters

roundaboutEnterDescription
crossingWaysDescription

Reimplemented from osmscout::RouteDescriptionPostprocessor::Callback.

References osmscout::CrossingWaysDescriptionToString(), osmscout::RouteStep::description, osmscout::RouteStep::roundaboutClockwise, and osmscout::RouteStep::shortDescription.

OnRoundaboutLeave()

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

overridevirtual

Called if we leave a roundabout entered before.

Parameters

roundaboutLeaveDescription
nameDescription

Reimplemented from osmscout::RouteDescriptionPostprocessor::Callback.

References osmscout::RouteStep::description, osmscout::FormatName(), osmscout::RouteStep::roundaboutClockwise, osmscout::RouteStep::roundaboutExit, and osmscout::RouteStep::shortDescription.

OnStart()

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

overridevirtual

Called one for the start node.

Parameters

startDescription
typeNameDescription
nameDescription

Reimplemented from osmscout::RouteDescriptionPostprocessor::Callback.

References osmscout::RouteStep::description, osmscout::FormatName(), and osmscout::RouteStep::shortDescription.

OnTargetReached()

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

overridevirtual

Called once for the target node reached.

Parameters

targetDescription

Reimplemented from osmscout::RouteDescriptionPostprocessor::Callback.

References osmscout::RouteStep::description, and osmscout::RouteStep::shortDescription.

OnTurn()

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

overridevirtual

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 from osmscout::RouteDescriptionPostprocessor::Callback.

References osmscout::CrossingWaysDescriptionToString(), osmscout::RouteStep::description, osmscout::FormatName(), osmscout::FullTurnCommand(), osmscout::RouteStep::shortDescription, osmscout::ShortTurnCommand(), osmscout::TurnCommandType(), and osmscout::TurnCommandWithList().

PushStreetName()

void osmscout::RouteDescriptionBuilder::Callback::PushStreetName

(

const RouteDescription::NameDescriptionRef &

nameDescription

)

References osmscout::FormatName().

---

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

• RouteDescriptionBuilder.h
• RouteDescriptionBuilder.cpp