#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.

Public Member Functions
void	buildPathFrom (const typename SUMOAbstractRouter< E, V >::EdgeInfo rbegin, std::vector< const E > &edges)
	Builds the path from marked edges.

virtual SUMOAbstractRouter *	clone ()=0

virtual bool	compute (const E from, const E to, const V const vehicle, SUMOTime msTime, std::vector< const E > &into, bool silent=false)=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.

bool	compute (const E from, double fromPos, const E to, double toPos, const V const vehicle, SUMOTime msTime, std::vector< const E > &into, bool silent=false)
	Builds the route between the given edges using the minimum effort at the given time, also taking into account position along the edges to ensure currect handling of looped routes The definition of the effort depends on the wished routing scheme.

bool	computeLooped (const E from, const E to, const V const vehicle, SUMOTime msTime, std::vector< const E > &into, bool silent=false)
	Builds the route between the given edges using the minimum effort at the given time if from == to, return the shortest looped route.

void	endQuery (int visits)

const SUMOAbstractRouter< E, V >::EdgeInfo &	getEdgeInfo (int index) const

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

const std::string &	getType () const

void	init (const int edgeID, const SUMOTime msTime)

bool	isProhibited (const E const edge, const V const vehicle) const

bool	isValid (const std::vector< const E * > &edges, const V *const v) const

virtual void	prohibit (const std::vector< E * > &toProhibit)

virtual double	recomputeCosts (const std::vector< const E * > &edges, const V const v, SUMOTime msTime, double lengthp=nullptr) const

double	recomputeCostsPos (const std::vector< const E * > &edges, const V const v, double fromPos, double toPos, SUMOTime msTime, double lengthp=nullptr) const

virtual void	reset (const V *const vehicle)
	reset internal caches, used by CHRouter

void	setAutoBulkMode (const bool mode)

virtual void	setBulkMode (const bool mode)

double	setHint (const typename std::vector< const E * >::const_iterator routeBegin, const typename std::vector< const E * >::const_iterator routeEnd, const V *const v, SUMOTime msTime)

void	startQuery ()

	SUMOAbstractRouter (const std::string &type, bool unbuildIsWarning, Operation operation, Operation ttOperation, const bool havePermissions, const bool haveRestrictions)
	Constructor.

	SUMOAbstractRouter (SUMOAbstractRouter *other)
	Copy Constructor.

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

void	updateViaEdgeCost (const E viaEdge, const V const v, double &time, double &effort, double &length) const

virtual	~SUMOAbstractRouter ()
	Destructor.

Protected Attributes
bool	myAmClean
	whether we are already initialized

bool	myAutoBulkMode
	whether we are currently trying to detect bulk mode automatically

bool	myBulkMode
	whether we are currently operating several route queries in a bulk

std::vector< typename SUMOAbstractRouter< E, V >::EdgeInfo >	myEdgeInfos
	The container of edge information.

MsgHandler *const	myErrorMsgHandler
	the handler for routing errors

std::vector< typename SUMOAbstractRouter< E, V >::EdgeInfo * >	myFound
	list of visited Edges (for resetting)

std::vector< typename SUMOAbstractRouter< E, V >::EdgeInfo * >	myFrontierList
	A container for reusage of the min edge heap.

const bool	myHavePermissions
	whether edge permissions need to be considered

const bool	myHaveRestrictions
	whether edge restrictions need to be considered

Operation	myOperation
	The object's operation to perform.

std::vector< E * >	myProhibited
	The list of explicitly prohibited edges.

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

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

Private Attributes
long long int	myNumQueries

long long int	myQueryStartTime
	the time spent querying in milliseconds

long long int	myQueryTimeSum

long long int	myQueryVisits
	counters for performance logging

const std::string	myType
	the type of this router

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 92 of file SUMOAbstractRouter.h.

Constructor & Destructor Documentation

◆ SUMOAbstractRouter() [1/2]

template<class E , class V >

SUMOAbstractRouter< E, V >::SUMOAbstractRouter	(	const std::string &	type,
		bool	unbuildIsWarning,
		Operation	operation,
		Operation	ttOperation,
		const bool	havePermissions,
		const bool	haveRestrictions
	)

inline

Constructor.

Definition at line 95 of file SUMOAbstractRouter.h.

◆ SUMOAbstractRouter() [2/2]

template<class E , class V >

SUMOAbstractRouter< E, V >::SUMOAbstractRouter ( SUMOAbstractRouter< E, V > * other )

inline

Copy Constructor.

Definition at line 111 of file SUMOAbstractRouter.h.

◆ ~SUMOAbstractRouter()

template<class E , class V >

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

inlinevirtual

Destructor.

Definition at line 127 of file SUMOAbstractRouter.h.

References elapsedMs2string(), SUMOAbstractRouter< E, V >::myNumQueries, SUMOAbstractRouter< E, V >::myQueryTimeSum, SUMOAbstractRouter< E, V >::myQueryVisits, SUMOAbstractRouter< E, V >::myType, toString(), and WRITE_MESSAGE.

Member Function Documentation

◆ buildPathFrom()

template<class E , class V >

void SUMOAbstractRouter< E, V >::buildPathFrom	(	const typename SUMOAbstractRouter< E, V >::EdgeInfo *	rbegin,
		std::vector< const E * > &	edges
	)

inline

Builds the path from marked edges.

Definition at line 364 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::EdgeInfo::edge, and SUMOAbstractRouter< E, V >::EdgeInfo::prev.

Referenced by AFRouter< E, N, V >::compute(), AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), and Node2EdgeRouter< E, N, V >::computeNode2Edge().

Here is the caller graph for this function:

◆ clone()

template<class E , class V >

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

pure virtual

Implemented in ROJTRRouter, AFRouter< E, N, V >, AStarRouter< E, V >, AStarRouter< FlippedEdge< E, N, V >, V >, CHRouter< E, V >, CHRouterWrapper< E, V >, DijkstraRouter< E, V >, IntermodalRouter< E, L, N, V >, Node2EdgeRouter< E, N, V >, Node2EdgeRouter< FlippedEdge< E, N, V >, FlippedNode< E, N, V >, V >, PedestrianRouter< E, L, N, V >, and RailwayRouter< E, V >.

Referenced by LandmarkLookupTable< E, V >::LandmarkLookupTable().

Here is the caller graph for this function:

◆ compute() [1/2]

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,
		bool	silent = `false`
	)

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 >, PedestrianRouter< E, L, N, V >, AFRouter< E, N, V >, AStarRouter< E, V >, CHRouter< E, V >, CHRouterWrapper< E, V >, DijkstraRouter< E, V >, and RailwayRouter< E, V >.

Referenced by RailwayRouter< E, V >::_compute(), NBRailwayTopologyAnalyzer::addBidiEdgesForStops(), MSDevice_FCDReplay::FCDHandler::checkRoute(), IntermodalRouter< E, L, N, V >::compute(), SUMOAbstractRouter< E, V >::compute(), MSDispatch::computeDetourTime(), SUMOAbstractRouter< E, V >::computeLooped(), ROMAAssignments::computePath(), MSDispatch::computePickupTime(), MSDispatch_RouteExtension::dispatch(), MSStoppingPlaceRerouter::evaluateDestination(), LIBSUMO_NAMESPACE::Simulation::findRoute(), NBPTLineCont::getCost(), libsumo::Helper::getDrivingDistance(), MSBaseVehicle::insertStop(), LandmarkLookupTable< E, V >::LandmarkLookupTable(), MSDevice_Taxi::prepareStop(), RORouteDef::repairCurrentRoute(), MSBaseVehicle::replaceStop(), MSBaseVehicle::reroute(), MSBaseVehicle::rerouteBetweenStops(), MSVehicle::rerouteParkingArea(), and MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ compute() [2/2]

template<class E , class V >

bool SUMOAbstractRouter< E, V >::compute	(	const E *	from,
		double	fromPos,
		const E *	to,
		double	toPos,
		const V *const	vehicle,
		SUMOTime	msTime,
		std::vector< const E * > &	into,
		bool	silent = `false`
	)

inline

Builds the route between the given edges using the minimum effort at the given time, also taking into account position along the edges to ensure currect handling of looped routes The definition of the effort depends on the wished routing scheme.

Definition at line 183 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::compute(), and SUMOAbstractRouter< E, V >::computeLooped().

◆ computeLooped()

template<class E , class V >

bool SUMOAbstractRouter< E, V >::computeLooped	(	const E *	from,
		const E *	to,
		const V *const	vehicle,
		SUMOTime	msTime,
		std::vector< const E * > &	into,
		bool	silent = `false`
	)

inline

Builds the route between the given edges using the minimum effort at the given time if from == to, return the shortest looped route.

Definition at line 198 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::compute(), MsgHandler::informf(), SUMOAbstractRouter< E, V >::myErrorMsgHandler, SUMOAbstractRouter< E, V >::recomputeCosts(), SVC_IGNORING, and TL.

Referenced by SUMOAbstractRouter< E, V >::compute(), and MSBaseVehicle::reroute().

Here is the caller graph for this function:

◆ endQuery()

template<class E , class V >

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

inline

Definition at line 339 of file SUMOAbstractRouter.h.

References SysUtils::getCurrentMillis(), SUMOAbstractRouter< E, V >::myQueryStartTime, SUMOAbstractRouter< E, V >::myQueryTimeSum, and SUMOAbstractRouter< E, V >::myQueryVisits.

Referenced by AStarRouter< E, V >::compute(), CHRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), Node2EdgeRouter< E, N, V >::computeNode2Edge(), Node2EdgeRouter< E, N, V >::computeNode2Edges(), and AFRouter< E, N, V >::endQuery().

Here is the caller graph for this function:

◆ getEdgeInfo()

template<class E , class V >

const SUMOAbstractRouter< E, V >::EdgeInfo & SUMOAbstractRouter< E, V >::getEdgeInfo ( int index ) const

inline

Definition at line 169 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::myEdgeInfos.

◆ 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 330 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::myOperation.

Referenced by IntermodalRouter< E, L, N, V >::compute(), AFRouter< E, N, V >::compute(), AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), PedestrianRouter< E, L, N, V >::compute(), Node2EdgeRouter< E, N, V >::computeNode2Edge(), Node2EdgeRouter< E, N, V >::computeNode2Edges(), RailwayRouter< E, V >::recomputeCosts(), SUMOAbstractRouter< E, V >::recomputeCostsPos(), SUMOAbstractRouter< E, V >::setHint(), CHBuilder< E, V >::synchronize(), SUMOAbstractRouter< E, V >::updateViaCost(), and SUMOAbstractRouter< E, V >::updateViaEdgeCost().

Here is the caller graph for this function:

◆ 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 231 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::myTTOperation.

Referenced by AFRouter< E, N, V >::compute(), AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), Node2EdgeRouter< E, N, V >::computeNode2Edge(), Node2EdgeRouter< E, N, V >::computeNode2Edges(), SUMOAbstractRouter< E, V >::updateViaCost(), and SUMOAbstractRouter< E, V >::updateViaEdgeCost().

Here is the caller graph for this function:

◆ getType()

template<class E , class V >

const std::string & SUMOAbstractRouter< E, V >::getType ( ) const

inline

Definition at line 165 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::myType.

◆ init()

template<class E , class V >

void SUMOAbstractRouter< E, V >::init	(	const int	edgeID,
		const SUMOTime	msTime
	)

inline

Definition at line 136 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::myAmClean, SUMOAbstractRouter< E, V >::myEdgeInfos, SUMOAbstractRouter< E, V >::myFound, SUMOAbstractRouter< E, V >::myFrontierList, and STEPS2TIME.

Referenced by AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), and SUMOAbstractRouter< E, V >::setHint().

Here is the caller graph for this function:

◆ isProhibited()

template<class E , class V >

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

inline

Definition at line 227 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::myHavePermissions, and SUMOAbstractRouter< E, V >::myHaveRestrictions.

Referenced by Node2EdgeRouter< E, N, V >::computeNode2Edge(), Node2EdgeRouter< E, N, V >::computeNode2Edges(), SUMOAbstractRouter< E, V >::isValid(), Node2EdgeRouter< E, N, V >::recomputeCostsNoLastEdge(), and SUMOAbstractRouter< E, V >::setHint().

Here is the caller graph for this function:

◆ isValid()

template<class E , class V >

bool SUMOAbstractRouter< E, V >::isValid	(	const std::vector< const E * > &	edges,
		const V *const	v
	)		const

inline

Definition at line 260 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::isProhibited().

Referenced by RORouteDef::addAlternative().

Here is the caller graph for this function:

◆ operator=()

template<class E , class V >

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

privatedelete

Invalidated assignment operator.

◆ prohibit()

template<class E , class V >

virtual void SUMOAbstractRouter< E, V >::prohibit ( const std::vector< E * > & toProhibit )

inlinevirtual

Reimplemented in CHRouter< E, V >, CHRouterWrapper< E, V >, IntermodalRouter< E, L, N, V >, PedestrianRouter< E, L, N, V >, and RailwayRouter< E, V >.

Definition at line 352 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::myEdgeInfos, and SUMOAbstractRouter< E, V >::myProhibited.

Referenced by AFBuild< E, N, V >::AFBuild(), IntermodalRouter< E, L, N, V >::prohibit(), PedestrianRouter< E, L, N, V >::prohibit(), and RailwayRouter< E, V >::prohibit().

Here is the caller graph for this function:

◆ recomputeCosts()

template<class E , class V >

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

inlinevirtual

Reimplemented in RailwayRouter< E, V >.

Definition at line 269 of file SUMOAbstractRouter.h.

References STEPS2TIME, and SUMOAbstractRouter< E, V >::updateViaCost().

Referenced by RORouteDef::addAlternative(), AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), SUMOAbstractRouter< E, V >::computeLooped(), ROMAAssignments::computePath(), MSDispatch::computePickupTime(), computeRoutes(), MSDevice_StationFinder::estimateConsumption(), MSStoppingPlaceRerouter::evaluateDestination(), LIBSUMO_NAMESPACE::Simulation::findRoute(), NBPTLineCont::getCost(), MSBaseVehicle::insertStop(), LandmarkLookupTable< E, V >::LandmarkLookupTable(), RailwayRouter< E, V >::recomputeCosts(), SUMOAbstractRouter< E, V >::recomputeCostsPos(), MSBaseVehicle::replaceStop(), MSBaseVehicle::reroute(), MSBaseVehicle::rerouteBetweenStops(), MSVehicle::rerouteParkingArea(), ROMAAssignments::sue(), and MSTriggeredRerouter::triggerRouting().

Here is the caller graph for this function:

◆ recomputeCostsPos()

template<class E , class V >

double SUMOAbstractRouter< E, V >::recomputeCostsPos	(	const std::vector< const E * > &	edges,
		const V *const	v,
		double	fromPos,
		double	toPos,
		SUMOTime	msTime,
		double *	lengthp = `nullptr`
	)		const

inline

Definition at line 287 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::getEffort(), SUMOAbstractRouter< E, V >::recomputeCosts(), and STEPS2TIME.

Referenced by MSDispatch::computeDetourTime().

Here is the caller graph for this function:

◆ reset()

template<class E , class V >

virtual void SUMOAbstractRouter< E, V >::reset ( const V *const vehicle )

inlinevirtual

reset internal caches, used by CHRouter

Reimplemented in AFRouter< E, N, V >, CHRouter< E, V >, Node2EdgeRouter< E, N, V >, and Node2EdgeRouter< FlippedEdge< E, N, V >, FlippedNode< E, N, V >, V >.

Definition at line 161 of file SUMOAbstractRouter.h.

References UNUSED_PARAMETER.

Referenced by computeRoutes(), and ROMAAssignments::incremental().

Here is the caller graph for this function:

◆ setAutoBulkMode()

template<class E , class V >

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

inline

Definition at line 348 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::myAutoBulkMode.

Referenced by LandmarkLookupTable< E, V >::LandmarkLookupTable().

Here is the caller graph for this function:

◆ setBulkMode()

template<class E , class V >

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

inlinevirtual

Reimplemented in AFRouter< E, N, V >, IntermodalRouter< E, L, N, V >, Node2EdgeRouter< E, N, V >, and Node2EdgeRouter< FlippedEdge< E, N, V >, FlippedNode< E, N, V >, V >.

Definition at line 344 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::myBulkMode.

Referenced by ROMAAssignments::computePath(), ROMAAssignments::incremental(), and IntermodalRouter< E, L, N, V >::setBulkMode().

Here is the caller graph for this function:

◆ setHint()

template<class E , class V >

double SUMOAbstractRouter< E, V >::setHint	(	const typename std::vector< const E * >::const_iterator	routeBegin,
		const typename std::vector< const E * >::const_iterator	routeEnd,
		const V *const	v,
		SUMOTime	msTime
	)

inline

Definition at line 299 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::EdgeInfo::edge, SUMOAbstractRouter< E, V >::EdgeInfo::effort, SUMOAbstractRouter< E, V >::getEffort(), SUMOAbstractRouter< E, V >::init(), SUMOAbstractRouter< E, V >::isProhibited(), SUMOAbstractRouter< E, V >::myEdgeInfos, SUMOAbstractRouter< E, V >::myFound, STEPS2TIME, and SUMOAbstractRouter< E, V >::updateViaCost().

◆ startQuery()

template<class E , class V >

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

inline

Definition at line 334 of file SUMOAbstractRouter.h.

References SysUtils::getCurrentMillis(), SUMOAbstractRouter< E, V >::myNumQueries, and SUMOAbstractRouter< E, V >::myQueryStartTime.

Referenced by AStarRouter< E, V >::compute(), CHRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), Node2EdgeRouter< E, N, V >::computeNode2Edge(), Node2EdgeRouter< E, N, V >::computeNode2Edges(), and AFRouter< E, N, V >::startQuery().

Here is the caller graph for this function:

◆ 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 245 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::getEffort(), SUMOAbstractRouter< E, V >::getTravelTime(), and SUMOAbstractRouter< E, V >::updateViaEdgeCost().

Referenced by IntermodalRouter< E, L, N, V >::compute(), RailwayRouter< E, V >::recomputeCosts(), SUMOAbstractRouter< E, V >::recomputeCosts(), Node2EdgeRouter< E, N, V >::recomputeCostsNoLastEdge(), and SUMOAbstractRouter< E, V >::setHint().

Here is the caller graph for this function:

◆ updateViaEdgeCost()

template<class E , class V >

void SUMOAbstractRouter< E, V >::updateViaEdgeCost	(	const E *	viaEdge,
		const V *const	v,
		double &	time,
		double &	effort,
		double &	length
	)		const

inline

Definition at line 235 of file SUMOAbstractRouter.h.

References SUMOAbstractRouter< E, V >::getEffort(), and SUMOAbstractRouter< E, V >::getTravelTime().

Referenced by AFRouter< E, N, V >::compute(), AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), Node2EdgeRouter< E, N, V >::computeNode2Edge(), Node2EdgeRouter< E, N, V >::computeNode2Edges(), and SUMOAbstractRouter< E, V >::updateViaCost().

Here is the caller graph for this function:

Field Documentation

◆ myAmClean

template<class E , class V >

bool SUMOAbstractRouter< E, V >::myAmClean

protected

whether we are already initialized

Definition at line 390 of file SUMOAbstractRouter.h.

Referenced by AFRouter< E, N, V >::compute(), AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), Node2EdgeRouter< E, N, V >::computeNode2Edge(), Node2EdgeRouter< E, N, V >::computeNode2Edges(), and SUMOAbstractRouter< E, V >::init().

◆ myAutoBulkMode

template<class E , class V >

bool SUMOAbstractRouter< E, V >::myAutoBulkMode

protected

whether we are currently trying to detect bulk mode automatically

Definition at line 387 of file SUMOAbstractRouter.h.

Referenced by DijkstraRouter< E, V >::clone(), DijkstraRouter< E, V >::compute(), and SUMOAbstractRouter< E, V >::setAutoBulkMode().

◆ 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 384 of file SUMOAbstractRouter.h.

Referenced by AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), and SUMOAbstractRouter< E, V >::setBulkMode().

◆ myEdgeInfos

template<class E , class V >

std::vector<typename SUMOAbstractRouter<E, V>::EdgeInfo> SUMOAbstractRouter< E, V >::myEdgeInfos

protected

The container of edge information.

Definition at line 402 of file SUMOAbstractRouter.h.

Referenced by AFRouter< E, N, V >::AFRouter(), AFRouter< E, N, V >::AFRouter(), AFRouter< E, N, V >::AFRouter(), AStarRouter< E, V >::AStarRouter(), AStarRouter< E, V >::AStarRouter(), AFRouter< E, N, V >::clone(), AStarRouter< E, V >::clone(), DijkstraRouter< E, V >::clone(), Node2EdgeRouter< E, N, V >::clone(), AFRouter< E, N, V >::compute(), AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), Node2EdgeRouter< E, N, V >::computeNode2Edge(), Node2EdgeRouter< E, N, V >::computeNode2Edges(), DijkstraRouter< E, V >::DijkstraRouter(), DijkstraRouter< E, V >::DijkstraRouter(), AFRouter< E, N, V >::edgeInfo(), Node2EdgeRouter< E, N, V >::edgeInfo(), AFRouter< E, N, V >::edgeInfo(), Node2EdgeRouter< E, N, V >::edgeInfo(), SUMOAbstractRouter< E, V >::getEdgeInfo(), SUMOAbstractRouter< E, V >::init(), SUMOAbstractRouter< E, V >::prohibit(), and SUMOAbstractRouter< E, V >::setHint().

◆ myErrorMsgHandler

template<class E , class V >

MsgHandler* const SUMOAbstractRouter< E, V >::myErrorMsgHandler

protected

the handler for routing errors

Definition at line 375 of file SUMOAbstractRouter.h.

Referenced by AFRouter< E, N, V >::clone(), AStarRouter< E, V >::clone(), CHRouter< E, V >::clone(), DijkstraRouter< E, V >::clone(), Node2EdgeRouter< E, N, V >::clone(), AFRouter< E, N, V >::compute(), AStarRouter< E, V >::compute(), CHRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), SUMOAbstractRouter< E, V >::computeLooped(), Node2EdgeRouter< E, N, V >::computeNode2Edge(), Node2EdgeRouter< E, N, V >::computeNode2Edges(), and RailwayRouter< E, V >::ensureInternalRouter().

◆ myFound

template<class E , class V >

std::vector<typename SUMOAbstractRouter<E, V>::EdgeInfo*> SUMOAbstractRouter< E, V >::myFound

protected

list of visited Edges (for resetting)

Definition at line 407 of file SUMOAbstractRouter.h.

Referenced by AFRouter< E, N, V >::compute(), AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), Node2EdgeRouter< E, N, V >::computeNode2Edge(), Node2EdgeRouter< E, N, V >::computeNode2Edges(), SUMOAbstractRouter< E, V >::init(), Node2EdgeRouter< E, N, V >::reset(), and SUMOAbstractRouter< E, V >::setHint().

◆ myFrontierList

template<class E , class V >

std::vector<typename SUMOAbstractRouter<E, V>::EdgeInfo*> SUMOAbstractRouter< E, V >::myFrontierList

protected

A container for reusage of the min edge heap.

Definition at line 405 of file SUMOAbstractRouter.h.

Referenced by AFRouter< E, N, V >::compute(), AStarRouter< E, V >::compute(), DijkstraRouter< E, V >::compute(), Node2EdgeRouter< E, N, V >::computeNode2Edge(), Node2EdgeRouter< E, N, V >::computeNode2Edges(), SUMOAbstractRouter< E, V >::init(), and Node2EdgeRouter< E, N, V >::reset().

◆ myHavePermissions

template<class E , class V >

const bool SUMOAbstractRouter< E, V >::myHavePermissions

protected

whether edge permissions need to be considered

Definition at line 393 of file SUMOAbstractRouter.h.

Referenced by AFRouter< E, N, V >::clone(), AStarRouter< E, V >::clone(), CHRouter< E, V >::clone(), CHRouterWrapper< E, V >::clone(), DijkstraRouter< E, V >::clone(), Node2EdgeRouter< E, N, V >::clone(), RailwayRouter< E, V >::ensureInternalRouter(), and SUMOAbstractRouter< E, V >::isProhibited().

◆ myHaveRestrictions

template<class E , class V >

const bool SUMOAbstractRouter< E, V >::myHaveRestrictions

protected

whether edge restrictions need to be considered

Definition at line 396 of file SUMOAbstractRouter.h.

Referenced by AFRouter< E, N, V >::clone(), AStarRouter< E, V >::clone(), CHRouter< E, V >::clone(), DijkstraRouter< E, V >::clone(), Node2EdgeRouter< E, N, V >::clone(), RailwayRouter< E, V >::ensureInternalRouter(), and SUMOAbstractRouter< E, V >::isProhibited().

◆ myNumQueries

template<class E , class V >

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

private

Definition at line 415 of file SUMOAbstractRouter.h.

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

◆ myOperation

template<class E , class V >

Operation SUMOAbstractRouter< E, V >::myOperation

protected

The object's operation to perform.

Definition at line 378 of file SUMOAbstractRouter.h.

Referenced by AFRouter< E, N, V >::clone(), AStarRouter< E, V >::clone(), CHRouter< E, V >::clone(), CHRouterWrapper< E, V >::clone(), DijkstraRouter< E, V >::clone(), Node2EdgeRouter< E, N, V >::clone(), CHRouterWrapper< E, V >::compute(), and SUMOAbstractRouter< E, V >::getEffort().

◆ myProhibited

template<class E , class V >

std::vector<E*> SUMOAbstractRouter< E, V >::myProhibited

protected

The list of explicitly prohibited edges.

Definition at line 399 of file SUMOAbstractRouter.h.

Referenced by RailwayRouter< E, V >::_compute(), RailwayRouter< E, V >::prohibit(), and SUMOAbstractRouter< E, V >::prohibit().

◆ myQueryStartTime

template<class E , class V >

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

private

the time spent querying in milliseconds

Definition at line 417 of file SUMOAbstractRouter.h.

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

◆ myQueryTimeSum

template<class E , class V >

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

private

Definition at line 418 of file SUMOAbstractRouter.h.

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

◆ myQueryVisits

template<class E , class V >

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

private

counters for performance logging

Definition at line 414 of file SUMOAbstractRouter.h.

Referenced by SUMOAbstractRouter< E, V >::endQuery(), and SUMOAbstractRouter< E, 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 381 of file SUMOAbstractRouter.h.

Referenced by DijkstraRouter< E, V >::clone(), and SUMOAbstractRouter< E, V >::getTravelTime().

◆ myType

template<class E , class V >

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

private

the type of this router

Definition at line 411 of file SUMOAbstractRouter.h.

Referenced by SUMOAbstractRouter< E, V >::getType(), and SUMOAbstractRouter< E, 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

Member Typedef Documentation

◆ Operation

Constructor & Destructor Documentation

◆ SUMOAbstractRouter() [1/2]

◆ SUMOAbstractRouter() [2/2]

◆ ~SUMOAbstractRouter()

Member Function Documentation

◆ buildPathFrom()

◆ clone()

◆ compute() [1/2]

◆ compute() [2/2]

◆ computeLooped()

◆ endQuery()

◆ getEdgeInfo()

◆ getEffort()

◆ getTravelTime()

◆ getType()

◆ init()

◆ isProhibited()

◆ isValid()

◆ operator=()

◆ prohibit()

◆ recomputeCosts()

◆ recomputeCostsPos()

◆ reset()

◆ setAutoBulkMode()

◆ setBulkMode()

◆ setHint()

◆ startQuery()

◆ updateViaCost()

◆ updateViaEdgeCost()

Field Documentation

◆ myAmClean

◆ myAutoBulkMode

◆ myBulkMode

◆ myEdgeInfos

◆ myErrorMsgHandler

◆ myFound

◆ myFrontierList

◆ myHavePermissions

◆ myHaveRestrictions

◆ myNumQueries

◆ myOperation

◆ myProhibited

◆ myQueryStartTime

◆ myQueryTimeSum

◆ myQueryVisits

◆ myTTOperation

◆ myType