osmscout::RoutingProfile Class Reference

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

Inheritance diagram for osmscout::RoutingProfile:

Public Member Functions
virtual	~RoutingProfile ()=default
virtual Vehicle	GetVehicle () const =0
virtual Distance	GetCostLimitDistance () const =0
virtual double	GetCostLimitFactor () const =0
virtual bool	CanUse (const RouteNode &currentNode, const std::vector< ObjectVariantData > &objectVariantData, size_t pathIndex) const =0
virtual bool	CanUse (const Area &area) const =0
virtual bool	CanUse (const Way &way) const =0
virtual bool	CanUseForward (const Way &way) const =0
virtual bool	CanUseBackward (const Way &way) const =0
virtual double	GetCosts (const RouteNode &currentNode, const std::vector< ObjectVariantData > &objectVariantData, size_t inPathIndex, size_t outPathIndex) const =0
virtual double	GetCosts (const Area &area, const Distance &distance) const =0
virtual double	GetCosts (const Way &way, const Distance &distance) const =0
virtual double	GetUTurnCost () const =0
virtual double	GetCosts (const Distance &distance) const =0
virtual std::string	GetCostString (double cost) const =0
virtual Duration	GetTime (const Area &area, const Distance &distance) const =0
virtual Duration	GetTime (const Way &way, const Distance &distance) const =0

Detailed Description

Abstract interface for a routing profile. A routing profile decides about the costs of taking a certain way. It thus may hold information about how fast ways can be used, maximum speed of the traveling device etc...

Constructor & Destructor Documentation

~RoutingProfile()

virtual osmscout::RoutingProfile::~RoutingProfile ( )

virtualdefault

Member Function Documentation

CanUse() [1/3]

virtual bool osmscout::RoutingProfile::CanUse ( const Area & area ) const

pure virtual

Implemented in osmscout::AbstractRoutingProfile.

CanUse() [2/3]

virtual bool osmscout::RoutingProfile::CanUse ( const RouteNode & currentNode, const std::vector< ObjectVariantData > & objectVariantData, size_t pathIndex ) const

pure virtual

Implemented in osmscout::AbstractRoutingProfile.

CanUse() [3/3]

virtual bool osmscout::RoutingProfile::CanUse ( const Way & way ) const

pure virtual

Implemented in osmscout::AbstractRoutingProfile.

CanUseBackward()

virtual bool osmscout::RoutingProfile::CanUseBackward ( const Way & way ) const

pure virtual

Implemented in osmscout::AbstractRoutingProfile.

CanUseForward()

virtual bool osmscout::RoutingProfile::CanUseForward ( const Way & way ) const

pure virtual

Implemented in osmscout::AbstractRoutingProfile.

GetCostLimitDistance()

virtual Distance osmscout::RoutingProfile::GetCostLimitDistance ( ) const

pure virtual

Implemented in osmscout::AbstractRoutingProfile.

GetCostLimitFactor()

virtual double osmscout::RoutingProfile::GetCostLimitFactor ( ) const

pure virtual

Implemented in osmscout::AbstractRoutingProfile.

GetCosts() [1/4]

virtual double osmscout::RoutingProfile::GetCosts ( const Area & area, const Distance & distance ) const

pure virtual

Estimated cost for specific area with given distance

Implemented in osmscout::FastestPathRoutingProfile, and osmscout::ShortestPathRoutingProfile.

GetCosts() [2/4]

virtual double osmscout::RoutingProfile::GetCosts ( const Distance & distance ) const

pure virtual

Estimated cost for distance when are no limitations (max. speed on the way)

Implemented in osmscout::FastestPathRoutingProfile, and osmscout::ShortestPathRoutingProfile.

GetCosts() [3/4]

virtual double osmscout::RoutingProfile::GetCosts ( const RouteNode & currentNode, const std::vector< ObjectVariantData > & objectVariantData, size_t inPathIndex, size_t outPathIndex ) const

pure virtual

Estimated cost for outgoing path (outPathIndex) from currentNode when currentNode is entered from inPathIndex

Implemented in osmscout::FastestPathRoutingProfile, and osmscout::ShortestPathRoutingProfile.

GetCosts() [4/4]

virtual double osmscout::RoutingProfile::GetCosts ( const Way & way, const Distance & distance ) const

pure virtual

Estimated cost for specific way with given distance

Implemented in osmscout::FastestPathRoutingProfile, and osmscout::ShortestPathRoutingProfile.

GetCostString()

virtual std::string osmscout::RoutingProfile::GetCostString ( double cost ) const

pure virtual

Textual representation of cost

Implemented in osmscout::AbstractRoutingProfile, osmscout::FastestPathRoutingProfile, and osmscout::ShortestPathRoutingProfile.

GetTime() [1/2]

virtual Duration osmscout::RoutingProfile::GetTime ( const Area & area, const Distance & distance ) const

pure virtual

Implemented in osmscout::AbstractRoutingProfile.

GetTime() [2/2]

virtual Duration osmscout::RoutingProfile::GetTime ( const Way & way, const Distance & distance ) const

pure virtual

Implemented in osmscout::AbstractRoutingProfile.

GetUTurnCost()

virtual double osmscout::RoutingProfile::GetUTurnCost ( ) const

pure virtual

Implemented in osmscout::AbstractRoutingProfile, and osmscout::FastestPathRoutingProfile.

GetVehicle()

virtual Vehicle osmscout::RoutingProfile::GetVehicle ( ) const

pure virtual

Implemented in osmscout::AbstractRoutingProfile.

---

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

• libosmscout/include/osmscout/routing/RoutingProfile.h