SUMO - Simulation of Urban MObility
SUMOAbstractRouter< E, V > Class Template Referenceabstract

#include <SUMOAbstractRouter.h>

Inheritance diagram for SUMOAbstractRouter< E, V >:
Inheritance graph
Collaboration diagram for SUMOAbstractRouter< E, V >:
Collaboration graph

Public Types

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

Public Member Functions

virtual SUMOAbstractRouterclone () const =0
 
virtual void 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)
 
SUMOReal getEffort (const E *const e, const V *const v, SUMOReal t) const
 
virtual SUMOReal recomputeCosts (const std::vector< const E * > &edges, const V *const v, SUMOTime msTime) const =0
 
void setBulkMode (const bool mode)
 
void startQuery ()
 
 SUMOAbstractRouter (Operation operation, const std::string &type)
 Constructor. More...
 
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...
 

Private Member Functions

SUMOAbstractRouteroperator= (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 53 of file SUMOAbstractRouter.h.

Member Typedef Documentation

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

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

Definition at line 56 of file SUMOAbstractRouter.h.

Constructor & Destructor Documentation

template<class E, class V>
SUMOAbstractRouter< E, V >::SUMOAbstractRouter ( Operation  operation,
const std::string &  type 
)
inline

Constructor.

Definition at line 59 of file SUMOAbstractRouter.h.

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

Destructor.

Definition at line 70 of file SUMOAbstractRouter.h.

Member Function Documentation

template<class E, class V>
virtual void SUMOAbstractRouter< E, V >::compute ( const E *  from,
const E *  to,
const V *const  vehicle,
SUMOTime  msTime,
std::vector< const E * > &  into 
)
pure virtual
template<class E, class V>
SUMOAbstractRouter& SUMOAbstractRouter< E, V >::operator= ( const SUMOAbstractRouter< E, V > &  s)
private

Invalidated assignment operator.

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

Definition at line 101 of file SUMOAbstractRouter.h.

Referenced by RONet::createBulkRouteRequests().

Field Documentation

template<class E, class V>
long long int SUMOAbstractRouter< E, V >::myNumQueries
private
template<class E, class V>
long long int SUMOAbstractRouter< E, V >::myQueryStartTime
private
template<class E, class V>
long long int SUMOAbstractRouter< E, V >::myQueryTimeSum
private
template<class E, class V>
long long int SUMOAbstractRouter< E, V >::myQueryVisits
private
template<class E, class V>
const std::string SUMOAbstractRouter< E, V >::myType
private

the type of this router

Definition at line 114 of file SUMOAbstractRouter.h.

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


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