ad::map::route::planning::Route Class Reference

Implements routing on the lane network. More...

#include <ad/map/route/Route.hpp>

Inheritance diagram for ad::map::route::planning::Route:

Collaboration diagram for ad::map::route::planning::Route:

Classes
struct	RawRoute
	Basic route description. More...

Public Types
enum	Type { Type::INVALID, Type::SHORTEST, Type::SHORTEST_IGNORE_DIRECTION }
	Routing type. More...
typedef std::vector< point::ParaPointList >	BasicRoute
	Basic route description.

Public Member Functions
	Route (const RoutingParaPoint &start, const RoutingParaPoint &dest, physics::Distance const &maxDistance, physics::Duration const &maxDuration, Type const &routingType)
	Constructor. Calculates route between two points. More...
	Route (Route const &)=delete
	Route (Route const &&)=delete
Route &	operator= (Route const &)=delete
Route &	operator= (Route &&)=delete
virtual	~Route ()=default
	Destructor.
const point::ParaPoint &	getStart () const
const RoutingParaPoint &	getRoutingStart () const
const point::ParaPoint &	getDest () const
const RoutingParaPoint &	getRoutingDest () const
Type	getType () const
bool	laneDirectionIsIgnored () const
virtual bool	calculate ()=0
	Performs the routing. More...
bool	isValid () const
const RawRoute &	getRawRoute (size_t const routeIndex=0u) const
const std::vector< RawRoute > &	getRawRoutes () const
BasicRoute	getBasicRoute (size_t const routeIndex=0u) const
std::vector< BasicRoute >	getBasicRoutes () const

Protected Attributes
RoutingParaPoint	mStart
	Start point.
RoutingParaPoint	mDest
	Destination point.
const physics::Distance	mMaxDistance
	prediction distance to be used
const physics::Duration	mMaxDuration
	prediction duration to be used
Type	mType
	Type of the route to be calculated.
bool	mValid
	Indicates if calculation was successful. More...
std::vector< RawRoute >	mRawRoutes

Detailed Description

Implements routing on the lane network.

Member Enumeration Documentation

Type

enum ad::map::route::planning::Route::Type

strong

Routing type.

Enumerator
INVALID	Invalid value.
SHORTEST	Shortest route by distance.
SHORTEST_IGNORE_DIRECTION	Shortest route by distance, allow to drive also in lanes with other direction.

Constructor & Destructor Documentation

Route()

ad::map::route::planning::Route::Route	(	const RoutingParaPoint &	start,
		const RoutingParaPoint &	dest,
		physics::Distance const &	maxDistance,
		physics::Duration const &	maxDuration,
		Type const &	routingType
	)

Constructor. Calculates route between two points.

Parameters

[in]	start	Start point.
[in]	dest	Destination point.
[in]	maxDistance	maximum route search distance.
[in]	maxDuration	maximum route search duration.
[in]	routingType	Type of the route to be calculated.

Member Function Documentation

calculate()

virtual bool ad::map::route::planning::Route::calculate ( )

pure virtual

Performs the routing.

Returns

true if routing succeeded.

Implemented in ad::map::route::planning::RouteAstar, and ad::map::route::planning::RoutePrediction.

getBasicRoute()

BasicRoute ad::map::route::planning::Route::getBasicRoute

(

size_t const

routeIndex = 0u

)

const

Returns

Calculated base route.

getBasicRoutes()

std::vector<BasicRoute> ad::map::route::planning::Route::getBasicRoutes

(

)

const

Returns

All calculated basic routes.

getDest()

const point::ParaPoint& ad::map::route::planning::Route::getDest ( ) const

inline

Returns

Destination point as ParaPoint.

getRawRoute()

const RawRoute& ad::map::route::planning::Route::getRawRoute

(

size_t const

routeIndex = 0u

)

const

Returns

Raw calculated route.

getRawRoutes()

const std::vector<RawRoute>& ad::map::route::planning::Route::getRawRoutes ( ) const

inline

Returns

Raw calculated route.

getRoutingDest()

const RoutingParaPoint& ad::map::route::planning::Route::getRoutingDest ( ) const

inline

Returns

Destination point as RoutingParaPoint.

getRoutingStart()

const RoutingParaPoint& ad::map::route::planning::Route::getRoutingStart ( ) const

inline

Returns

Start point as RoutingParaPoint.

getStart()

const point::ParaPoint& ad::map::route::planning::Route::getStart ( ) const

inline

Returns

Start point as ParaPoint.

getType()

Type ad::map::route::planning::Route::getType ( ) const

inline

Returns

Type of the route to be calculated.

isValid()

bool ad::map::route::planning::Route::isValid ( ) const

inline

Returns

true if calculated route is valid.

laneDirectionIsIgnored()

bool ad::map::route::planning::Route::laneDirectionIsIgnored

(

)

const

Returns

true if route calculation ignores lane direction.

Member Data Documentation

mValid

bool ad::map::route::planning::Route::mValid

protected

Indicates if calculation was successful.

Calculated routes.

---

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

• include/ad/map/route/Route.hpp