struct defining the result type of findWaypoint() and findNearestWaypoint() More...
#include <ad/map/route/RouteOperation.hpp>
Public Member Functions | |
| FindWaypointResult (FullRoute const &route) | |
| constructor More... | |
| FindWaypointResult (FullRoute const &route, point::ParaPoint const &iQueryPosition, RoadSegmentList::const_iterator roadSegmentIter, LaneSegmentList::const_iterator laneIntervalIter) | |
| constructor More... | |
| FindWaypointResult (FindWaypointResult const &other)=default | |
| copy constructor | |
| bool | isValid () const |
| checks whether the FindWaypointResult contains valid data | |
| FindWaypointResult & | operator= (FindWaypointResult const &other) |
| assignment operator More... | |
| FindWaypointResult | getLeftLane () const |
| return a FindWayPointResult that is iterated to the left lane of this More... | |
| FindWaypointResult | getRightLane () const |
| return a FindWayPointResult that is iterated to the right lane of this More... | |
| std::vector< FindWaypointResult > | getSuccessorLanes () const |
| return a vector of FindWayPointResult that is iterated to the successor lanes of this More... | |
| std::vector< FindWaypointResult > | getPredecessorLanes () const |
| return a vector of FindWayPointResult that is iterated to the predecessor lanes of this More... | |
Public Attributes | |
| const FullRoute & | queryRoute |
| reference to the route | |
| RoadSegmentList::const_iterator | roadSegmentIterator |
| iterator referencing an element of the queryRoute | |
| LaneSegmentList::const_iterator | laneSegmentIterator |
| iterator referencing an element of the routeIterator content; only valid if routeIterator != queryRoute.end() | |
| point::ParaPoint | queryPosition |
| copy of the query position this waypoint result refers to | |
Detailed Description
struct defining the result type of findWaypoint() and findNearestWaypoint()
Constructor & Destructor Documentation
◆ FindWaypointResult() [1/2]
| ad::map::route::FindWaypointResult::FindWaypointResult | ( | FullRoute const & | route | ) |
constructor
constructs a result that is invalid
◆ FindWaypointResult() [2/2]
|
inline |
constructor
constructs a result with the provided data
Member Function Documentation
◆ getLeftLane()
| FindWaypointResult ad::map::route::FindWaypointResult::getLeftLane | ( | ) | const |
return a FindWayPointResult that is iterated to the left lane of this
If there is no left lane, the result is invalid (see isValid())
- Exceptions
-
std::runtime_error() in case of an inconsistent route
◆ getPredecessorLanes()
| std::vector<FindWaypointResult> ad::map::route::FindWaypointResult::getPredecessorLanes | ( | ) | const |
return a vector of FindWayPointResult that is iterated to the predecessor lanes of this
If there are no predecessor lanes, the result is empty.
- Exceptions
-
std::runtime_error() in case of an inconsistent route
◆ getRightLane()
| FindWaypointResult ad::map::route::FindWaypointResult::getRightLane | ( | ) | const |
return a FindWayPointResult that is iterated to the right lane of this
If there is no right lane, the result is invalid (see isValid())
- Exceptions
-
std::runtime_error() in case of an inconsistent route
◆ getSuccessorLanes()
| std::vector<FindWaypointResult> ad::map::route::FindWaypointResult::getSuccessorLanes | ( | ) | const |
return a vector of FindWayPointResult that is iterated to the successor lanes of this
If there are no successor lanes, the result is empty.
- Exceptions
-
std::runtime_error() in case of an inconsistent route
◆ operator=()
| FindWaypointResult& ad::map::route::FindWaypointResult::operator= | ( | FindWaypointResult const & | other | ) |
assignment operator
The assignment is only possible if the other refers to the same query route as this. If there is a miss match a std::invalid_argument exception is thrown
The documentation for this struct was generated from the following file:
- include/ad/map/route/RouteOperation.hpp
