osmscout::RouteDescriptionBuilder::Callback Class Reference

#include <libosmscout-client-qt/include/osmscout/RouteDescriptionBuilder.h>

Inheritance diagram for osmscout::RouteDescriptionBuilder::Callback:

Collaboration diagram for osmscout::RouteDescriptionBuilder::Callback:

Public Member Functions
	Callback (QList< RouteStep > &routeSteps, const Distance &stopAfter=Distance::Lowest(), bool skipInformative=false)
	~Callback () override
void	OnStart (const RouteDescription::StartDescriptionRef &startDescription, const RouteDescription::TypeNameDescriptionRef &typeNameDescription, const RouteDescription::NameDescriptionRef &nameDescription) override
void	OnTargetReached (const RouteDescription::TargetDescriptionRef &targetDescription) override
void	OnTurn (const RouteDescription::TurnDescriptionRef &turnDescription, const RouteDescription::CrossingWaysDescriptionRef &crossingWaysDescription, const RouteDescription::DirectionDescriptionRef &directionDescription, const RouteDescription::TypeNameDescriptionRef &typeNameDescription, const RouteDescription::NameDescriptionRef &nameDescription) override
void	OnRoundaboutEnter (const RouteDescription::RoundaboutEnterDescriptionRef &roundaboutEnterDescription, const RouteDescription::CrossingWaysDescriptionRef &crossingWaysDescription) override
void	OnRoundaboutLeave (const RouteDescription::RoundaboutLeaveDescriptionRef &roundaboutLeaveDescription, const RouteDescription::NameDescriptionRef &nameDescription) override
void	OnMotorwayEnter (const RouteDescription::MotorwayEnterDescriptionRef &motorwayEnterDescription, const RouteDescription::CrossingWaysDescriptionRef &crossingWaysDescription) override
void	OnMotorwayChange (const RouteDescription::MotorwayChangeDescriptionRef &motorwayChangeDescription, const RouteDescription::MotorwayJunctionDescriptionRef &motorwayJunctionDescription, const RouteDescription::DestinationDescriptionRef &crossingDestinationDescription) override
void	OnMotorwayLeave (const RouteDescription::MotorwayLeaveDescriptionRef &motorwayLeaveDescription, const RouteDescription::MotorwayJunctionDescriptionRef &motorwayJunctionDescription, const RouteDescription::DirectionDescriptionRef &directionDescription, const RouteDescription::NameDescriptionRef &nameDescription) override
void	OnPathNameChange (const RouteDescription::NameChangedDescriptionRef &nameChangedDescription) override
void	PushStreetName (const RouteDescription::NameDescriptionRef &nameDescription)
void	BeforeNode (const RouteDescription::Node &node) override
bool	Continue () const override
RouteStep	MkStep (const QString &name)
Public Member Functions inherited from osmscout::RouteDescriptionPostprocessor::Callback
virtual void	BeforeRoute ()
virtual void	OnMaxSpeed (const RouteDescription::MaxSpeedDescriptionRef &maxSpeedDescription)
virtual void	OnPOIAtRoute (const RouteDescription::POIAtRouteDescriptionRef &poiAtRouteDescription)
virtual void	AfterNode (const RouteDescription::Node &node)

Constructor & Destructor Documentation

Callback()

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

~Callback()

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

overridevirtual

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.

Continue()

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

overridevirtual

If postprocessor should continue

Returns

continue

Reimplemented from osmscout::RouteDescriptionPostprocessor::Callback.

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::DestinationDescriptionRef &  crossingDestinationDescription  )

overridevirtual

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

Parameters

motorwayChangeDescription
motorwayJunctionDescription
crossingDestinationDescription

Reimplemented from osmscout::RouteDescriptionPostprocessor::Callback.

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.

OnMotorwayLeave()

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

overridevirtual

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

Parameters

motorwayLeaveDescription
motorwayJunctionDescription
directionDescription
nameDescription

Reimplemented from osmscout::RouteDescriptionPostprocessor::Callback.

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.

OnRoundaboutEnter()

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

overridevirtual

Called if we enter a roundabound

Parameters

roundaboutEnterDescription
crossingWaysDescription

Reimplemented from osmscout::RouteDescriptionPostprocessor::Callback.

OnRoundaboutLeave()

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

overridevirtual

Called if we leave a roundabound entered before

Parameters

roundaboutLeaveDescription
nameDescription

Reimplemented from osmscout::RouteDescriptionPostprocessor::Callback.

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.

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.

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.

PushStreetName()

void osmscout::RouteDescriptionBuilder::Callback::PushStreetName

(

const RouteDescription::NameDescriptionRef &

nameDescription

)

---

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

• libosmscout-client-qt/include/osmscout/RouteDescriptionBuilder.h