libosmscout 0.1
Loading...
Searching...
No Matches
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
RoutingError GetError () const
 Why this result carries no route.
Distance GetOverallDistance () const
RouteData & GetRoute ()
const RouteData & GetRoute () const
const std::vector< int > & GetSectionLenghts () const
 RoutingResult ()
void SetCurrentMaxDistance (const Distance &currentMaxDistance)
void SetError (RoutingError error)
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

◆ ClearSectionLengths()

void osmscout::RoutingResult::ClearSectionLengths ( )
inline

◆ GetCurrentMaxDistance()

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

◆ GetError()

RoutingError osmscout::RoutingResult::GetError ( ) const
inline

Why this result carries no route.

Success() is unchanged (!route.IsEmpty()), so a caller that only asks whether the calculation worked keeps its behaviour; this names the cause for a caller that reports it.

◆ GetOverallDistance()

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

◆ GetRoute() [1/2]

◆ 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

◆ SetError()

void osmscout::RoutingResult::SetError ( RoutingError error)
inline

◆ SetOverallDistance()

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

◆ Success()

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

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