Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
AStarRouter< E, V, M > Class Template Reference

Computes the shortest path through a network using the A* algorithm. More...

#include <AStarRouter.h>

Inheritance diagram for AStarRouter< E, V, M >:
[legend]
Collaboration diagram for AStarRouter< E, V, M >:
[legend]

Data Structures

class  EdgeInfoComparator

Public Types

typedef FullLookupTable< E, V > FLT
typedef LandmarkLookupTable< E, V, M > LMLT
typedef AbstractLookupTable< E, V > LookupTable
typedef double(* Operation) (const E *const, const V *const, double)
 Type of the function that is used to retrieve the edge effort.
typedef std::map< const E *, double > Prohibitions
 Prohibitions and their estimated end time.

Public Member Functions

 AStarRouter (const std::vector< E * > &edges, bool unbuildIsWarning, typename SUMOAbstractRouter< E, V >::Operation operation, const std::shared_ptr< const LookupTable > lookup=nullptr, const bool havePermissions=false, const bool haveRestrictions=false)
 Constructor.
 AStarRouter (const std::vector< typename SUMOAbstractRouter< E, V >::EdgeInfo > &edgeInfos, bool unbuildIsWarning, typename SUMOAbstractRouter< E, V >::Operation operation, const std::shared_ptr< const LookupTable > lookup=nullptr, const bool havePermissions=false, const bool haveRestrictions=false)
void buildPathFrom (const typename SUMOAbstractRouter< E, V >::EdgeInfo *rbegin, std::vector< const E * > &edges)
 Builds the path from marked edges.
virtual SUMOAbstractRouter< E, V > * clone ()
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 travel time.
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 >::EdgeInfogetEdgeInfo (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 Prohibitions &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 ()
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 ~AStarRouter ()
 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
EdgeInfoComparator myComparator
std::vector< typename SUMOAbstractRouter< E, V >::EdgeInfomyEdgeInfos
 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
const std::shared_ptr< const LookupTablemyLookupTable
 the lookup table for travel time heuristics
double myMaxSpeed
 maximum speed in the network
Operation myOperation
 The object's operation to perform.
Prohibitions myProhibited
 The list of explicitly prohibited edges and estimated end time of prohibition.
Operation myTTOperation
 The object's operation to perform for travel times.

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 M>
class AStarRouter< E, V, M >

Computes the shortest path through a network using the A* algorithm.

The template parameters are:

Parameters
EThe edge class to use (MSEdge/ROEdge)
VThe vehicle class to use (MSVehicle/ROVehicle)
BASEThe base class to use (SUMOAbstractRouterPermissions/SUMOAbstractRouter)

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 76 of file AStarRouter.h.

Member Typedef Documentation

◆ FLT

template<class E, class V, class M>
typedef FullLookupTable<E, V> AStarRouter< E, V, M >::FLT

Definition at line 79 of file AStarRouter.h.

◆ LMLT

template<class E, class V, class M>
typedef LandmarkLookupTable<E, V, M> AStarRouter< E, V, M >::LMLT

Definition at line 80 of file AStarRouter.h.

◆ LookupTable

template<class E, class V, class M>
typedef AbstractLookupTable<E, V> AStarRouter< E, V, M >::LookupTable

Definition at line 78 of file AStarRouter.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 95 of file SUMOAbstractRouter.h.

◆ Prohibitions

template<class E, class V>
typedef std::map<const E*, double> SUMOAbstractRouter< E, V >::Prohibitions
inherited

Prohibitions and their estimated end time.

Definition at line 98 of file SUMOAbstractRouter.h.

Constructor & Destructor Documentation

◆ AStarRouter() [1/2]

template<class E, class V, class M>
AStarRouter< E, V, M >::AStarRouter ( const std::vector< E * > & edges,
bool unbuildIsWarning,
typename SUMOAbstractRouter< E, V >::Operation operation,
const std::shared_ptr< const LookupTable > lookup = nullptr,
const bool havePermissions = false,
const bool haveRestrictions = false )
inline

Constructor.

Definition at line 98 of file AStarRouter.h.

Referenced by AStarRouter< _IntermodalEdge, _IntermodalTrip, _MapMatcher >::clone(), Node2EdgeRouter< E, N, V, M >::Node2EdgeRouter(), and Node2EdgeRouter< E, N, V, M >::Node2EdgeRouter().

Here is the caller graph for this function:

◆ AStarRouter() [2/2]

template<class E, class V, class M>
AStarRouter< E, V, M >::AStarRouter ( const std::vector< typename SUMOAbstractRouter< E, V >::EdgeInfo > & edgeInfos,
bool unbuildIsWarning,
typename SUMOAbstractRouter< E, V >::Operation operation,
const std::shared_ptr< const LookupTable > lookup = nullptr,
const bool havePermissions = false,
const bool haveRestrictions = false )
inline

Definition at line 109 of file AStarRouter.h.

◆ ~AStarRouter()

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

Destructor.

Definition at line 121 of file AStarRouter.h.

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

Builds the path from marked edges.

Definition at line 382 of file SUMOAbstractRouter.h.

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

Here is the caller graph for this function:

◆ clone()

template<class E, class V, class M>
virtual SUMOAbstractRouter< E, V > * AStarRouter< E, V, M >::clone ( )
inlinevirtual

◆ compute() [1/2]

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

Builds the route between the given edges using the minimum travel time.

Implements SUMOAbstractRouter< E, V >.

Definition at line 129 of file AStarRouter.h.

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

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

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

Referenced by SUMOAbstractRouter< MSEdge, SUMOVehicle >::compute(), MSBaseVehicle::optimizeSkipped(), MSBaseVehicle::reroute(), and MSBaseVehicle::routeAlongStops().

Here is the caller graph for this function:

◆ endQuery()

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

◆ getEdgeInfo()

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

Definition at line 177 of file SUMOAbstractRouter.h.

◆ 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

◆ getType()

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

Definition at line 173 of file SUMOAbstractRouter.h.

◆ init()

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

Definition at line 144 of file SUMOAbstractRouter.h.

Referenced by AStarRouter< _IntermodalEdge, _IntermodalTrip, _MapMatcher >::compute(), DijkstraRouter< _IntermodalEdge, _IntermodalTrip >::compute(), and SUMOAbstractRouter< MSEdge, SUMOVehicle >::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
inlineinherited

Definition at line 235 of file SUMOAbstractRouter.h.

Referenced by SUMOAbstractRouter< MSEdge, SUMOVehicle >::isValid(), Node2EdgeRouter< E, N, V, M >::recomputeCostsNoLastEdge(), and SUMOAbstractRouter< MSEdge, SUMOVehicle >::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
inlineinherited

Definition at line 268 of file SUMOAbstractRouter.h.

Referenced by RORouteDef::addAlternative().

Here is the caller graph for this function:

◆ prohibit()

template<class E, class V>
virtual void SUMOAbstractRouter< E, V >::prohibit ( const Prohibitions & toProhibit)
inlinevirtualinherited

◆ recomputeCosts()

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

Definition at line 295 of file SUMOAbstractRouter.h.

Referenced by MSDispatch::computeDetourTime(), MSBaseVehicle::optimizeSkipped(), MSBaseVehicle::reroute(), and MSBaseVehicle::routeAlongStops().

Here is the caller graph for this function:

◆ reset()

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

reset internal caches, used by CHRouter

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

Definition at line 169 of file SUMOAbstractRouter.h.

Referenced by computeRoutes().

Here is the caller graph for this function:

◆ setAutoBulkMode()

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

Definition at line 361 of file SUMOAbstractRouter.h.

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

Here is the caller graph for this function:

◆ setBulkMode()

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

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

Definition at line 307 of file SUMOAbstractRouter.h.

◆ 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

Definition at line 253 of file SUMOAbstractRouter.h.

Referenced by RailwayRouter< E, V >::recomputeCosts(), SUMOAbstractRouter< MSEdge, SUMOVehicle >::recomputeCosts(), Node2EdgeRouter< E, N, V, M >::recomputeCostsNoLastEdge(), and SUMOAbstractRouter< MSEdge, SUMOVehicle >::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
inlineinherited

Field Documentation

◆ myAmClean

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

◆ myAutoBulkMode

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

whether we are currently trying to detect bulk mode automatically

Definition at line 405 of file SUMOAbstractRouter.h.

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

◆ myComparator

template<class E, class V, class M>
EdgeInfoComparator AStarRouter< E, V, M >::myComparator
protected

Definition at line 282 of file AStarRouter.h.

◆ myEdgeInfos

◆ myErrorMsgHandler

◆ myFound

◆ myFrontierList

◆ myHavePermissions

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

◆ myHaveRestrictions

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

◆ myLookupTable

template<class E, class V, class M>
const std::shared_ptr<const LookupTable> AStarRouter< E, V, M >::myLookupTable
protected

the lookup table for travel time heuristics

Definition at line 285 of file AStarRouter.h.

Referenced by Node2EdgeRouter< E, N, V, M >::clone(), and Node2EdgeRouter< E, N, V, M >::computeNode2Edge().

◆ myMaxSpeed

template<class E, class V, class M>
double AStarRouter< E, V, M >::myMaxSpeed
protected

maximum speed in the network

Definition at line 288 of file AStarRouter.h.

Referenced by Node2EdgeRouter< E, N, V, M >::computeNode2Edge(), and Node2EdgeRouter< E, N, V, M >::computeNode2Edges().

◆ myNumQueries

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

Definition at line 433 of file SUMOAbstractRouter.h.

◆ myOperation

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

◆ myProhibited

template<class E, class V>
Prohibitions SUMOAbstractRouter< E, V >::myProhibited
protectedinherited

The list of explicitly prohibited edges and estimated end time of prohibition.

Definition at line 417 of file SUMOAbstractRouter.h.

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

◆ myQueryStartTime

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

the time spent querying in milliseconds

Definition at line 435 of file SUMOAbstractRouter.h.

◆ myQueryTimeSum

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

Definition at line 436 of file SUMOAbstractRouter.h.

◆ myQueryVisits

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

counters for performance logging

Definition at line 432 of file SUMOAbstractRouter.h.

◆ myTTOperation

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

The object's operation to perform for travel times.

Definition at line 399 of file SUMOAbstractRouter.h.

◆ myType

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

the type of this router

Definition at line 429 of file SUMOAbstractRouter.h.


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