Eclipse SUMO - Simulation of Urban MObility
CHRouter< E, V > Class Template Reference

Computes the shortest path through a contracted network. More...

#include <CHRouter.h>

Inheritance diagram for CHRouter< E, V >:
Collaboration diagram for CHRouter< E, V >:

Data Structures

class  Unidirectional
 

Public Types

typedef std::pair< const typename SUMOAbstractRouter< E, V >::EdgeInfo *, const typename SUMOAbstractRouter< E, V >::EdgeInfo * > Meeting
 A meeting point of the two search scopes. More...
 
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

void buildContractionHierarchy (SUMOTime time, const V *const vehicle)
 
void buildPathFromMeeting (Meeting meeting, std::vector< const E * > &into) const
 normal routing methods More...
 
 CHRouter (const std::vector< E * > &edges, bool unbuildIsWarning, typename SUMOAbstractRouter< E, V >::Operation operation, const SUMOVehicleClass svc, SUMOTime weightPeriod, const bool havePermissions, const bool haveRestrictions)
 Constructor. More...
 
virtual SUMOAbstractRouter< E, V > * clone ()
 
virtual bool compute (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 traveltime in the contracted graph. More...
 
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. 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
 
bool isProhibited (const E *const edge, const V *const vehicle) const
 
virtual void prohibit (const std::vector< E * > &)
 
double recomputeCosts (const std::vector< const E * > &edges, const V *const v, SUMOTime msTime, double *lengthp=nullptr) const
 
void setBulkMode (const bool mode)
 
void startQuery ()
 
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 ~CHRouter ()
 Destructor. More...
 

Protected Attributes

bool myBulkMode
 whether we are currently operating several route queries in a bulk More...
 
MsgHandler *const myErrorMsgHandler
 the handler for routing errors More...
 
const bool myHavePermissions
 whether edge permissions need to be considered More...
 
const bool myHaveRestrictions
 whether edge restrictions need to be considered More...
 
Operation myOperation
 The object's operation to perform. More...
 
std::vector< E * > myProhibited
 
Operation myTTOperation
 The object's operation to perform for travel times. More...
 

Private Member Functions

const E * getVia (const E *forwardFrom, const E *forwardTo) const
 

Private Attributes

Unidirectional myBackwardSearch
 
const std::vector< E * > & myEdges
 all edges with numerical ids More...
 
Unidirectional myForwardSearch
 the unidirectional search queues More...
 
const CHBuilder< E, V >::Hierarchy * myHierarchy
 
CHBuilder< E, V > * myHierarchyBuilder
 
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 SUMOVehicleClass mySVC
 the permissions for which the hierarchy was constructed More...
 
const std::string myType
 the type of this router More...
 
SUMOTime myValidUntil
 the validity duration of the current hierarchy (exclusive) More...
 
const SUMOTime myWeightPeriod
 the validity duration of one weight interval More...
 

Detailed Description

template<class E, class V>
class CHRouter< E, V >

Computes the shortest path through a contracted network.

The template parameters are:

Parameters
EThe edge class to use (MSEdge/ROEdge)
VThe vehicle class to use (MSVehicle/ROVehicle)
PFThe prohibition function to use (prohibited_withPermissions/noProhibitions)

The router is edge-based. It must know the number of edges for internal reasons and whether a missing connection between two given edges (unbuild route) shall be reported as an error or as a warning.

The template parameters are:

Parameters
EThe edge class to use (MSEdge/ROEdge)
VThe vehicle class to use (MSVehicle/ROVehicle)

The router is edge-based. It must know the number of edges for internal reasons and whether a missing connection between two given edges (unbuild route) shall be reported as an error or as a warning.

Definition at line 61 of file CHRouter.h.

Member Typedef Documentation

◆ Meeting

template<class E, class V>
typedef std::pair<const typename SUMOAbstractRouter<E, V>::EdgeInfo*, const typename SUMOAbstractRouter<E, V>::EdgeInfo*> CHRouter< E, V >::Meeting

A meeting point of the two search scopes.

Definition at line 65 of file CHRouter.h.

◆ Operation

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

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

Definition at line 96 of file SUMOAbstractRouter.h.

Constructor & Destructor Documentation

◆ CHRouter()

template<class E, class V>
CHRouter< E, V >::CHRouter ( const std::vector< E * > &  edges,
bool  unbuildIsWarning,
typename SUMOAbstractRouter< E, V >::Operation  operation,
const SUMOVehicleClass  svc,
SUMOTime  weightPeriod,
const bool  havePermissions,
const bool  haveRestrictions 
)
inline

Constructor.

Parameters
[in]validatePermissionsWhether a multi-permission hierarchy shall be built If set to false, the net is pruned in synchronize() and the hierarchy is tailored to the svc

Definition at line 220 of file CHRouter.h.

◆ ~CHRouter()

template<class E, class V>
virtual CHRouter< E, V >::~CHRouter ( )
inlinevirtual

Destructor.

Definition at line 236 of file CHRouter.h.

References CHRouter< E, V >::myHierarchy, and CHRouter< E, V >::myHierarchyBuilder.

Member Function Documentation

◆ buildContractionHierarchy()

template<class E, class V>
void CHRouter< E, V >::buildContractionHierarchy ( SUMOTime  time,
const V *const  vehicle 
)
inline

◆ buildPathFromMeeting()

template<class E, class V>
void CHRouter< E, V >::buildPathFromMeeting ( Meeting  meeting,
std::vector< const E * > &  into 
) const
inline

normal routing methods

Builds the path from marked edges

Definition at line 305 of file CHRouter.h.

References CHRouter< E, V >::getVia().

Referenced by CHRouter< E, V >::compute().

◆ clone()

◆ compute()

template<class E, class V>
virtual bool CHRouter< E, V >::compute ( const E *  from,
const E *  to,
const V *const  vehicle,
SUMOTime  msTime,
std::vector< const E * > &  into,
bool  silent = false 
)
inlinevirtual

◆ 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 
)
inlineinherited

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

Referenced by MSBaseVehicle::reroute(), and MSTriggeredRerouter::rerouteParkingArea().

◆ endQuery()

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

◆ getEffort()

◆ 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
inlineinherited

◆ getVia()

template<class E, class V>
const E* CHRouter< E, V >::getVia ( const E *  forwardFrom,
const E *  forwardTo 
) const
inlineprivate

Definition at line 353 of file CHRouter.h.

References CHRouter< E, V >::myHierarchy.

Referenced by CHRouter< E, V >::buildPathFromMeeting().

◆ isProhibited()

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

◆ prohibit()

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

◆ recomputeCosts()

◆ setBulkMode()

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

Definition at line 230 of file SUMOAbstractRouter.h.

Referenced by ROMAAssignments::incremental().

◆ startQuery()

template<class E, class V>
void SUMOAbstractRouter< E, V >::startQuery ( )
inlineinherited

◆ 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
inlineinherited

◆ 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
inlineinherited

Field Documentation

◆ myBackwardSearch

template<class E, class V>
Unidirectional CHRouter< E, V >::myBackwardSearch
private

Definition at line 370 of file CHRouter.h.

Referenced by CHRouter< E, V >::compute().

◆ myBulkMode

template<class E, class V>
bool SUMOAbstractRouter< E, V >::myBulkMode
protectedinherited

whether we are currently operating several route queries in a bulk

Definition at line 245 of file SUMOAbstractRouter.h.

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

◆ myEdges

template<class E, class V>
const std::vector<E*>& CHRouter< E, V >::myEdges
private

all edges with numerical ids

Definition at line 366 of file CHRouter.h.

Referenced by CHRouter< E, V >::clone().

◆ myErrorMsgHandler

◆ myForwardSearch

template<class E, class V>
Unidirectional CHRouter< E, V >::myForwardSearch
private

the unidirectional search queues

Definition at line 369 of file CHRouter.h.

Referenced by CHRouter< E, V >::compute().

◆ myHavePermissions

template<class E, class V>
const bool SUMOAbstractRouter< E, V >::myHavePermissions
protectedinherited

whether edge permissions need to be considered

Definition at line 248 of file SUMOAbstractRouter.h.

Referenced by DijkstraRouter< E, V >::clone(), CHRouter< E, V >::clone(), and SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::isProhibited().

◆ myHaveRestrictions

template<class E, class V>
const bool SUMOAbstractRouter< E, V >::myHaveRestrictions
protectedinherited

whether edge restrictions need to be considered

Definition at line 251 of file SUMOAbstractRouter.h.

Referenced by DijkstraRouter< E, V >::clone(), CHRouter< E, V >::clone(), and SUMOAbstractRouter< E, IntermodalTrip< E, N, V > >::isProhibited().

◆ myHierarchy

template<class E, class V>
const CHBuilder<E, V>::Hierarchy* CHRouter< E, V >::myHierarchy
private

◆ myHierarchyBuilder

template<class E, class V>
CHBuilder<E, V>* CHRouter< E, V >::myHierarchyBuilder
private

◆ myNumQueries

template<class E, class V>
long long int SUMOAbstractRouter< E, V >::myNumQueries
privateinherited

◆ myOperation

template<class E, class V>
Operation SUMOAbstractRouter< E, V >::myOperation
protectedinherited

◆ myProhibited

template<class E, class V>
std::vector<E*> SUMOAbstractRouter< E, V >::myProhibited
protectedinherited

◆ myQueryStartTime

template<class E, class V>
long long int SUMOAbstractRouter< E, V >::myQueryStartTime
privateinherited

◆ myQueryTimeSum

template<class E, class V>
long long int SUMOAbstractRouter< E, V >::myQueryTimeSum
privateinherited

◆ myQueryVisits

template<class E, class V>
long long int SUMOAbstractRouter< E, V >::myQueryVisits
privateinherited

◆ mySVC

template<class E, class V>
const SUMOVehicleClass CHRouter< E, V >::mySVC
private

the permissions for which the hierarchy was constructed

Definition at line 382 of file CHRouter.h.

Referenced by CHRouter< E, V >::clone().

◆ myTTOperation

template<class E, class V>
Operation SUMOAbstractRouter< E, V >::myTTOperation
protectedinherited

The object's operation to perform for travel times.

Definition at line 242 of file SUMOAbstractRouter.h.

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

◆ myType

template<class E, class V>
const std::string SUMOAbstractRouter< E, V >::myType
privateinherited

the type of this router

Definition at line 257 of file SUMOAbstractRouter.h.

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

◆ myValidUntil

template<class E, class V>
SUMOTime CHRouter< E, V >::myValidUntil
private

the validity duration of the current hierarchy (exclusive)

Definition at line 379 of file CHRouter.h.

Referenced by CHRouter< E, V >::buildContractionHierarchy(), and CHRouter< E, V >::compute().

◆ myWeightPeriod

template<class E, class V>
const SUMOTime CHRouter< E, V >::myWeightPeriod
private

the validity duration of one weight interval

Definition at line 376 of file CHRouter.h.

Referenced by CHRouter< E, V >::buildContractionHierarchy(), CHRouter< E, V >::clone(), and CHRouter< E, V >::compute().


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