libosmscout 0.1
Loading...
Searching...
No Matches
Public Member Functions | List of all members
osmscout::RoutingResult Class Referencefinal

Result of a routing calculation. More...

#include <AbstractRoutingService.h>

Public Member Functions

void AppendSectionLength (int length)
 
void ClearSectionLengths ()
 
Distance GetCurrentMaxDistance () const
 
Distance GetOverallDistance () const
 
RouteData & GetRoute ()
 
const RouteData & GetRoute () const
 
const std::vector< int > & GetSectionLenghts () const
 
 RoutingResult ()
 
void SetCurrentMaxDistance (const Distance &currentMaxDistance)
 
void SetOverallDistance (const Distance &overallDistance)
 
bool Success () const
 

Detailed Description

Result of a routing calculation.

This object is always returned. In case of an routing error it however may not contain a valid route (route is empty).

TODO: Adapt it to the same style as RoutePointsResult and Co.

Constructor & Destructor Documentation

◆ RoutingResult()

osmscout::RoutingResult::RoutingResult ( )
default

Member Function Documentation

◆ AppendSectionLength()

void osmscout::RoutingResult::AppendSectionLength ( int  length)
inline

Referenced by osmscout::MultiDBRoutingService::CalculateRoute(), and osmscout::SimpleRoutingService::CalculateRouteViaCoords().

◆ ClearSectionLengths()

void osmscout::RoutingResult::ClearSectionLengths ( )
inline

Referenced by osmscout::MultiDBRoutingService::CalculateRoute(), and osmscout::SimpleRoutingService::CalculateRouteViaCoords().

◆ GetCurrentMaxDistance()

Distance osmscout::RoutingResult::GetCurrentMaxDistance ( ) const
inline

◆ GetOverallDistance()

Distance osmscout::RoutingResult::GetOverallDistance ( ) const
inline

◆ GetRoute() [1/2]

RouteData & osmscout::RoutingResult::GetRoute ( )
inline

Referenced by osmscout::MultiDBRoutingService::CalculateRoute(), osmscout::AbstractRoutingService< RoutingState >::CalculateRoute(), and osmscout::SimpleRoutingService::CalculateRouteViaCoords().

◆ GetRoute() [2/2]

const RouteData & osmscout::RoutingResult::GetRoute ( ) const
inline

◆ GetSectionLenghts()

const std::vector< int > & osmscout::RoutingResult::GetSectionLenghts ( ) const
inline

◆ SetCurrentMaxDistance()

void osmscout::RoutingResult::SetCurrentMaxDistance ( const Distance &  currentMaxDistance)
inline

Referenced by osmscout::AbstractRoutingService< RoutingState >::CalculateRoute(), and osmscout::AbstractRoutingService< RoutingState >::WalkPaths().

◆ SetOverallDistance()

void osmscout::RoutingResult::SetOverallDistance ( const Distance &  overallDistance)
inline

Referenced by osmscout::AbstractRoutingService< RoutingState >::CalculateRoute().

◆ Success()

bool osmscout::RoutingResult::Success ( ) const
inline

References osmscout::RouteData::IsEmpty().

Referenced by osmscout::MultiDBRoutingService::CalculateRoute(), and osmscout::SimpleRoutingService::CalculateRouteViaCoords().

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