#include <SUMOAbstractRouter.h>

Inheritance diagram for SUMOAbstractRouter< E, V >:

Collaboration diagram for SUMOAbstractRouter< E, V >:

Data Structures
class	EdgeInfo

Public Types
typedef double(*	Operation) (const E const, const V const, double)
	Type of the function that is used to retrieve the edge effort. More...

Public Member Functions
virtual SUMOAbstractRouter *	clone ()=0

virtual bool	compute (const E from, const E to, const V const vehicle, SUMOTime msTime, std::vector< const E > &into)=0
	Builds the route between the given edges using the minimum effort at the given time The definition of the effort depends on the wished routing scheme. More...

void	endQuery (int visits)

double	getEffort (const E const e, const V const v, double t) const

double	getTravelTime (const E const e, const V const v, const double t, const double effort) const

virtual bool	isProhibited (const E const, const V const) const

double	recomputeCosts (const std::vector< const E > &edges, const V const v, SUMOTime msTime) const

void	setBulkMode (const bool mode)

void	startQuery ()

	SUMOAbstractRouter (const std::string &type, Operation operation=nullptr, Operation ttOperation=nullptr)
	Constructor. More...

void	updateViaCost (const E const prev, const E const e, const V *const v, double &time, double &effort, double &length) const

virtual	~SUMOAbstractRouter ()
	Destructor. More...

Protected Attributes
bool	myBulkMode
	whether we are currently operating several route queries in a bulk More...

Operation	myOperation
	The object's operation to perform. More...

Operation	myTTOperation
	The object's operation to perform for travel times. More...

Private Member Functions
SUMOAbstractRouter &	operator= (const SUMOAbstractRouter &s)
	Invalidated assignment operator. More...

Private Attributes
long long int	myNumQueries

long long int	myQueryStartTime
	the time spent querying in milliseconds More...

long long int	myQueryTimeSum

long long int	myQueryVisits
	counters for performance logging More...

const std::string	myType
	the type of this router More...

Detailed Description

template<class E, class V>
class SUMOAbstractRouter< E, V >

The interface for routing the vehicles over the network.

Definition at line 46 of file SUMOAbstractRouter.h.

Member Typedef Documentation

◆ Operation

template<class E, class V>

typedef double(* SUMOAbstractRouter< E, V >::Operation) (const E *const, const V *const, double)

Type of the function that is used to retrieve the edge effort.

Definition at line 96 of file SUMOAbstractRouter.h.

Constructor & Destructor Documentation

◆ SUMOAbstractRouter()

template<class E, class V>

SUMOAbstractRouter< E, V >::SUMOAbstractRouter	(	const std::string &	type,
		Operation	operation = `nullptr`,
		Operation	ttOperation = `nullptr`
	)

inline

Constructor.

Definition at line 99 of file SUMOAbstractRouter.h.

◆ ~SUMOAbstractRouter()

template<class E, class V>

virtual SUMOAbstractRouter< E, V >::~SUMOAbstractRouter ( )

inlinevirtual

Destructor.

Definition at line 110 of file SUMOAbstractRouter.h.

Member Function Documentation

◆ clone()

template<class E, class V>

virtual SUMOAbstractRouter* SUMOAbstractRouter< E, V >::clone ( )

pure virtual

Implemented in AStarRouter< MSEdge, SUMOVehicle, SUMOAbstractRouterPermissions< MSEdge, SUMOVehicle > >, IntermodalRouter< E, L, N, V >, PedestrianRouter< E, L, N, V >, and ROJTRRouter.

Referenced by LandmarkLookupTable< E, V >::LandmarkLookupTable(), and SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::~SUMOAbstractRouter().

◆ compute()

template<class E, class V>

virtual bool SUMOAbstractRouter< E, V >::compute	(	const E *	from,
		const E *	to,
		const V *const	vehicle,
		SUMOTime	msTime,
		std::vector< const E *> &	into
	)

pure virtual

Builds the route between the given edges using the minimum effort at the given time The definition of the effort depends on the wished routing scheme.

Implemented in IntermodalRouter< E, L, N, V >, AStarRouter< MSEdge, SUMOVehicle, SUMOAbstractRouterPermissions< MSEdge, SUMOVehicle > >, and PedestrianRouter< E, L, N, V >.

Referenced by NBRailwayTopologyAnalyzer::addBidiEdgesForStops(), libsumo::Vehicle::changeTarget(), TraCIServerAPI_Simulation::commandDistanceRequest(), IntermodalRouter< E, L, N, V >::compute(), libsumo::Simulation::findRoute(), NBPTLineCont::getCost(), libsumo::Simulation::getDistance2D(), libsumo::Simulation::getDistanceRoad(), ROMAAssignments::getKPaths(), ROMAAssignments::incremental(), LandmarkLookupTable< E, V >::LandmarkLookupTable(), MSTriggeredRerouter::notifyEnter(), RORouteDef::repairCurrentRoute(), MSBaseVehicle::reroute(), MSTriggeredRerouter::rerouteParkingArea(), MSVehicle::rerouteParkingArea(), ROMAAssignments::sue(), and SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::~SUMOAbstractRouter().

◆ endQuery()

template<class E, class V>

void SUMOAbstractRouter< E, V >::endQuery ( int visits )

inline

Definition at line 180 of file SUMOAbstractRouter.h.

◆ getEffort()

template<class E, class V>

double SUMOAbstractRouter< E, V >::getEffort	(	const E *const	e,
		const V *const	v,
		double	t
	)		const

inline

Definition at line 171 of file SUMOAbstractRouter.h.

Referenced by IntermodalRouter< E, L, N, V >::compute(), CHBuilder< E, V >::synchronize(), and SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::updateViaCost().

◆ getTravelTime()

template<class E, class V>

double SUMOAbstractRouter< E, V >::getTravelTime	(	const E *const	e,
		const V *const	v,
		const double	t,
		const double	effort
	)		const

inline

Definition at line 128 of file SUMOAbstractRouter.h.

Referenced by SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::updateViaCost().

◆ isProhibited()

template<class E, class V>

virtual bool SUMOAbstractRouter< E, V >::isProhibited	(	const E *	const,
		const V *	const
	)		const

inlinevirtual

Reimplemented in SUMOAbstractRouterPermissions< E, V >, and SUMOAbstractRouterPermissions< MSEdge, SUMOVehicle >.

Definition at line 124 of file SUMOAbstractRouter.h.

Referenced by SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::recomputeCosts().

◆ operator=()

template<class E, class V>

SUMOAbstractRouter& SUMOAbstractRouter< E, V >::operator= ( const SUMOAbstractRouter< E, V > & s )

private

Invalidated assignment operator.

◆ recomputeCosts()

template<class E, class V>

double SUMOAbstractRouter< E, V >::recomputeCosts	(	const std::vector< const E *> &	edges,
		const V *const	v,
		SUMOTime	msTime
	)		const

inline

Definition at line 155 of file SUMOAbstractRouter.h.

Referenced by RORouteDef::addAlternative(), computeRoutes(), libsumo::Simulation::findRoute(), NBPTLineCont::getCost(), LandmarkLookupTable< E, V >::LandmarkLookupTable(), MSTriggeredRerouter::notifyEnter(), MSBaseVehicle::reroute(), MSTriggeredRerouter::rerouteParkingArea(), MSVehicle::rerouteParkingArea(), and ROMAAssignments::sue().

◆ setBulkMode()

template<class E, class V>

void SUMOAbstractRouter< E, V >::setBulkMode ( const bool mode )

inline

Definition at line 185 of file SUMOAbstractRouter.h.

Referenced by ROMAAssignments::incremental().

◆ startQuery()

template<class E, class V>

void SUMOAbstractRouter< E, V >::startQuery ( )

inline

Definition at line 175 of file SUMOAbstractRouter.h.

◆ updateViaCost()

template<class E, class V>

void SUMOAbstractRouter< E, V >::updateViaCost	(	const E *const	prev,
		const E *const	e,
		const V *const	v,
		double &	time,
		double &	effort,
		double &	length
	)		const

inline

Definition at line 132 of file SUMOAbstractRouter.h.

Referenced by IntermodalRouter< E, L, N, V >::compute(), and SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::recomputeCosts().

Field Documentation

◆ myBulkMode

template<class E, class V>

bool SUMOAbstractRouter< E, V >::myBulkMode

protected

whether we are currently operating several route queries in a bulk

Definition at line 197 of file SUMOAbstractRouter.h.

Referenced by SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::setBulkMode().

◆ myNumQueries

template<class E, class V>

long long int SUMOAbstractRouter< E, V >::myNumQueries

private

Definition at line 205 of file SUMOAbstractRouter.h.

Referenced by SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::startQuery(), and SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::~SUMOAbstractRouter().

◆ myOperation

template<class E, class V>

Operation SUMOAbstractRouter< E, V >::myOperation

protected

The object's operation to perform.

Definition at line 191 of file SUMOAbstractRouter.h.

Referenced by SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::getEffort().

◆ myQueryStartTime

template<class E, class V>

long long int SUMOAbstractRouter< E, V >::myQueryStartTime

private

the time spent querying in milliseconds

Definition at line 207 of file SUMOAbstractRouter.h.

Referenced by SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::endQuery(), and SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::startQuery().

◆ myQueryTimeSum

template<class E, class V>

long long int SUMOAbstractRouter< E, V >::myQueryTimeSum

private

Definition at line 208 of file SUMOAbstractRouter.h.

Referenced by SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::endQuery(), and SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::~SUMOAbstractRouter().

◆ myQueryVisits

template<class E, class V>

long long int SUMOAbstractRouter< E, V >::myQueryVisits

private

counters for performance logging

Definition at line 204 of file SUMOAbstractRouter.h.

Referenced by SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::endQuery(), and SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::~SUMOAbstractRouter().

◆ myTTOperation

template<class E, class V>

Operation SUMOAbstractRouter< E, V >::myTTOperation

protected

The object's operation to perform for travel times.

Definition at line 194 of file SUMOAbstractRouter.h.

Referenced by SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::getTravelTime().

◆ myType

template<class E, class V>

const std::string SUMOAbstractRouter< E, V >::myType

private

the type of this router

Definition at line 201 of file SUMOAbstractRouter.h.

Referenced by SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::~SUMOAbstractRouter().

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

SUMOAbstractRouter.h

Data Structures

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

template<class E, class V> class SUMOAbstractRouter< E, V >

Member Typedef Documentation

◆ Operation

Constructor & Destructor Documentation

◆ SUMOAbstractRouter()

◆ ~SUMOAbstractRouter()

Member Function Documentation

◆ clone()

◆ compute()

◆ endQuery()

◆ getEffort()

◆ getTravelTime()

◆ isProhibited()

◆ operator=()

◆ recomputeCosts()

◆ setBulkMode()

◆ startQuery()

◆ updateViaCost()

Field Documentation

◆ myBulkMode

◆ myNumQueries

◆ myOperation

◆ myQueryStartTime

◆ myQueryTimeSum

◆ myQueryVisits

◆ myTTOperation

◆ myType

template<class E, class V>
class SUMOAbstractRouter< E, V >