Eclipse SUMO - Simulation of Urban MObility
Public Types | Public Member Functions | Private Attributes
StoppingPlaceMemory Class Reference

#include <MSStoppingPlaceRerouter.h>

Public Types

typedef std::map< const MSStoppingPlace *, StoppingPlaceMemoryEntry, ComparatorIdLess > StoppingPlaceMap
 Definition of the map containing all visited stopping places. More...
 

Public Member Functions

StoppingPlaceMap::const_iterator begin () const
 Returns a reference to the begin iterator for the internal map. More...
 
void clear ()
 Removes all data about evaluated StoppingPlace items. More...
 
StoppingPlaceMap::const_iterator end () const
 Returns a reference to the end iterator for the internal map. More...
 
void rememberBlockedStoppingPlace (const MSStoppingPlace *stoppingPlace, bool local)
 Store the time the StoppingPlace was confirmed to be blocked. More...
 
void rememberStoppingPlaceScore (const MSStoppingPlace *stoppingPlace, const std::string &score)
 score only needed when running with gui More...
 
bool remove (MSStoppingPlace *id)
 Removes an item. More...
 
void resetStoppingPlaceScores ()
 
SUMOTime sawBlockedStoppingPlace (const MSStoppingPlace *stoppingPlace, bool local) const
 Get the time the StoppingPlace was confirmed to be blocked. More...
 
int size () const
 Returns the number of stored items within the container. More...
 
 StoppingPlaceMemory ()
 Constructor. More...
 
virtual ~StoppingPlaceMemory ()
 

Private Attributes

StoppingPlaceMap myMap
 The map from StoppingPlace to single evaluation. More...
 

Detailed Description

Definition at line 46 of file MSStoppingPlaceRerouter.h.

Member Typedef Documentation

◆ StoppingPlaceMap

typedef std::map<const MSStoppingPlace*, StoppingPlaceMemoryEntry, ComparatorIdLess> StoppingPlaceMemory::StoppingPlaceMap

Definition of the map containing all visited stopping places.

Definition at line 49 of file MSStoppingPlaceRerouter.h.

Constructor & Destructor Documentation

◆ StoppingPlaceMemory()

StoppingPlaceMemory::StoppingPlaceMemory ( )
inline

Constructor.

Definition at line 52 of file MSStoppingPlaceRerouter.h.

◆ ~StoppingPlaceMemory()

virtual StoppingPlaceMemory::~StoppingPlaceMemory ( )
inlinevirtual

Definition at line 55 of file MSStoppingPlaceRerouter.h.

Member Function Documentation

◆ begin()

StoppingPlaceMap::const_iterator StoppingPlaceMemory::begin ( ) const
inline

Returns a reference to the begin iterator for the internal map.

Definition at line 111 of file MSStoppingPlaceRerouter.h.

References myMap.

◆ clear()

void StoppingPlaceMemory::clear ( )
inline

Removes all data about evaluated StoppingPlace items.

Definition at line 72 of file MSStoppingPlaceRerouter.h.

References myMap.

◆ end()

StoppingPlaceMap::const_iterator StoppingPlaceMemory::end ( ) const
inline

Returns a reference to the end iterator for the internal map.

Definition at line 116 of file MSStoppingPlaceRerouter.h.

References myMap.

◆ rememberBlockedStoppingPlace()

void StoppingPlaceMemory::rememberBlockedStoppingPlace ( const MSStoppingPlace *  stoppingPlace,
bool  local 
)
inline

Store the time the StoppingPlace was confirmed to be blocked.

Definition at line 82 of file MSStoppingPlaceRerouter.h.

References myMap, and SIMSTEP.

Referenced by MSBaseVehicle::rememberBlockedChargingStation(), and MSBaseVehicle::rememberBlockedParkingArea().

Here is the caller graph for this function:

◆ rememberStoppingPlaceScore()

void StoppingPlaceMemory::rememberStoppingPlaceScore ( const MSStoppingPlace *  stoppingPlace,
const std::string &  score 
)
inline

score only needed when running with gui

Definition at line 100 of file MSStoppingPlaceRerouter.h.

References myMap.

Referenced by MSBaseVehicle::rememberChargingStationScore(), and MSBaseVehicle::rememberParkingAreaScore().

Here is the caller graph for this function:

◆ remove()

bool StoppingPlaceMemory::remove ( MSStoppingPlace *  id)
inline

Removes an item.

Parameters
[in]idThe id of the item to remove
Returns
If the item could be removed (an item with the id was within the container before)

Definition at line 61 of file MSStoppingPlaceRerouter.h.

References myMap.

◆ resetStoppingPlaceScores()

void StoppingPlaceMemory::resetStoppingPlaceScores ( )
inline

Definition at line 104 of file MSStoppingPlaceRerouter.h.

References myMap.

Referenced by MSBaseVehicle::resetChargingStationScores(), and MSBaseVehicle::resetParkingAreaScores().

Here is the caller graph for this function:

◆ sawBlockedStoppingPlace()

SUMOTime StoppingPlaceMemory::sawBlockedStoppingPlace ( const MSStoppingPlace *  stoppingPlace,
bool  local 
) const
inline

Get the time the StoppingPlace was confirmed to be blocked.

Definition at line 90 of file MSStoppingPlaceRerouter.h.

References myMap.

Referenced by MSDevice_StationFinder::findChargingStation(), MSBaseVehicle::sawBlockedChargingStation(), and MSBaseVehicle::sawBlockedParkingArea().

Here is the caller graph for this function:

◆ size()

int StoppingPlaceMemory::size ( ) const
inline

Returns the number of stored items within the container.

Definition at line 77 of file MSStoppingPlaceRerouter.h.

References myMap.

Field Documentation

◆ myMap

StoppingPlaceMap StoppingPlaceMemory::myMap
private

The map from StoppingPlace to single evaluation.

Definition at line 122 of file MSStoppingPlaceRerouter.h.

Referenced by begin(), clear(), end(), rememberBlockedStoppingPlace(), rememberStoppingPlaceScore(), remove(), resetStoppingPlaceScores(), sawBlockedStoppingPlace(), and size().

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