Eclipse SUMO - Simulation of Urban MObility
RouteCostCalculator< R, E, V > Class Template Referenceabstract

Abstract base class providing static factory method. More...

#include <RouteCostCalculator.h>

Inheritance diagram for RouteCostCalculator< R, E, V >:
[legend]
Collaboration diagram for RouteCostCalculator< R, E, V >:
[legend]

Public Member Functions

virtual void calculateProbabilities (std::vector< R * > alternatives, const V *const veh, const SUMOTime time)=0
 calculate the probabilities in the logit model More...
 
int getMaxRouteNumber () const
 
bool keepRoutes () const
 
virtual void setCosts (R *route, const double costs, const bool isActive=false) const =0
 
bool skipRouteCalculation () const
 

Static Public Member Functions

static void cleanup ()
 
static RouteCostCalculator< R, E, V > & getCalculator ()
 

Protected Member Functions

 RouteCostCalculator ()
 Constructor. More...
 
virtual ~RouteCostCalculator ()
 Destructor. More...
 

Private Attributes

bool myKeepRoutes
 Information whether all routes should be saved. More...
 
int myMaxRouteNumber
 The maximum route alternatives number. More...
 
bool mySkipRouteCalculation
 Information whether new routes should be calculated. More...
 

Static Private Attributes

static RouteCostCalculatormyInstance = 0
 

Detailed Description

template<class R, class E, class V>
class RouteCostCalculator< R, E, V >

Abstract base class providing static factory method.

Definition at line 41 of file RouteCostCalculator.h.

Constructor & Destructor Documentation

◆ RouteCostCalculator()

◆ ~RouteCostCalculator()

template<class R , class E , class V >
virtual RouteCostCalculator< R, E, V >::~RouteCostCalculator ( )
inlineprotectedvirtual

Destructor.

Definition at line 77 of file RouteCostCalculator.h.

Member Function Documentation

◆ calculateProbabilities()

template<class R , class E , class V >
virtual void RouteCostCalculator< R, E, V >::calculateProbabilities ( std::vector< R * >  alternatives,
const V *const  veh,
const SUMOTime  time 
)
pure virtual

calculate the probabilities in the logit model

Implemented in GawronCalculator< R, E, V >, and LogitCalculator< R, E, V >.

◆ cleanup()

template<class R , class E , class V >
static void RouteCostCalculator< R, E, V >::cleanup ( )
inlinestatic

Definition at line 45 of file RouteCostCalculator.h.

References RouteCostCalculator< R, E, V >::myInstance.

Referenced by RONet::cleanup().

Here is the caller graph for this function:

◆ getCalculator()

template<class R , class E , class V >
RouteCostCalculator< R, E, V > & RouteCostCalculator< R, E, V >::getCalculator
static

Definition at line 105 of file RouteCostCalculator.h.

References OptionsCont::getFloat(), OptionsCont::getOptions(), and OptionsCont::getString().

Referenced by RORouteDef::addAlternative(), RORouteDef::preComputeCurrentRoute(), and ROMAAssignments::sue().

Here is the caller graph for this function:

◆ getMaxRouteNumber()

template<class R , class E , class V >
int RouteCostCalculator< R, E, V >::getMaxRouteNumber ( ) const
inline

Definition at line 55 of file RouteCostCalculator.h.

References RouteCostCalculator< R, E, V >::myMaxRouteNumber.

Referenced by RORouteDef::addAlternative().

Here is the caller graph for this function:

◆ keepRoutes()

template<class R , class E , class V >
bool RouteCostCalculator< R, E, V >::keepRoutes ( ) const
inline

◆ setCosts()

template<class R , class E , class V >
virtual void RouteCostCalculator< R, E, V >::setCosts ( R *  route,
const double  costs,
const bool  isActive = false 
) const
pure virtual

◆ skipRouteCalculation()

template<class R , class E , class V >
bool RouteCostCalculator< R, E, V >::skipRouteCalculation ( ) const
inline

Field Documentation

◆ myInstance

template<class R , class E , class V >
RouteCostCalculator< R, E, V > * RouteCostCalculator< R, E, V >::myInstance = 0
staticprivate

Definition at line 80 of file RouteCostCalculator.h.

Referenced by RouteCostCalculator< R, E, V >::cleanup().

◆ myKeepRoutes

template<class R , class E , class V >
bool RouteCostCalculator< R, E, V >::myKeepRoutes
private

Information whether all routes should be saved.

Definition at line 86 of file RouteCostCalculator.h.

Referenced by RouteCostCalculator< R, E, V >::keepRoutes(), and RouteCostCalculator< R, E, V >::RouteCostCalculator().

◆ myMaxRouteNumber

template<class R , class E , class V >
int RouteCostCalculator< R, E, V >::myMaxRouteNumber
private

The maximum route alternatives number.

Definition at line 83 of file RouteCostCalculator.h.

Referenced by RouteCostCalculator< R, E, V >::getMaxRouteNumber(), and RouteCostCalculator< R, E, V >::RouteCostCalculator().

◆ mySkipRouteCalculation

template<class R , class E , class V >
bool RouteCostCalculator< R, E, V >::mySkipRouteCalculation
private

Information whether new routes should be calculated.

Definition at line 89 of file RouteCostCalculator.h.

Referenced by RouteCostCalculator< R, E, V >::RouteCostCalculator(), and RouteCostCalculator< R, E, V >::skipRouteCalculation().


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