Eclipse SUMO - Simulation of Urban MObility
MSInsertionControl Class Reference

Inserts vehicles into the network when their departure time is reached. More...

#include <MSInsertionControl.h>

Collaboration diagram for MSInsertionControl:
[legend]

Data Structures

struct  Flow
 Definition of vehicle flow with the current index for vehicle numbering. More...
 

Public Member Functions

void adaptIntermodalRouter (MSNet::MSIntermodalRouter &router) const
 
void add (SUMOVehicle *veh)
 Adds a single vehicle for departure. More...
 
bool addFlow (SUMOVehicleParameter *const pars, int index=-1)
 Adds parameter for a vehicle flow for departure. More...
 
void alreadyDeparted (SUMOVehicle *veh)
 stops trying to emit the given vehicle (because it already departed) More...
 
void clearPendingVehicles (const std::string &route)
 clears out all pending vehicles from a route, "" for all routes More...
 
void clearState ()
 Remove all vehicles before quick-loading state. More...
 
SUMOTime computeRandomDepartOffset () const
 compute (optional) random offset to the departure time More...
 
void descheduleDeparture (const SUMOVehicle *veh)
 stops trying to emit the given vehicle (and delete it) More...
 
void determineCandidates (SUMOTime time)
 Checks for all vehicles whether they can be emitted. More...
 
int emitVehicles (SUMOTime time)
 Emits vehicles that want to depart at the given time. More...
 
std::mt19937 * getFlowRNG ()
 retrieve internal RNG More...
 
int getPendingEmits (const MSLane *lane)
 return the number of pending emits for the given lane More...
 
int getPendingFlowCount () const
 Returns the number of flows that are still active. More...
 
int getWaitingVehicleNo () const
 Returns the number of waiting vehicles. More...
 
 MSInsertionControl (MSVehicleControl &vc, SUMOTime maxDepartDelay, bool checkEdgesOnce, int maxVehicleNumber, SUMOTime randomDepartOffset)
 Constructor. More...
 
void saveState (OutputDevice &out)
 Saves the current state into the given stream. More...
 
 ~MSInsertionControl ()
 Destructor. More...
 

Private Member Functions

void checkCandidates (SUMOTime time, const bool preCheck)
 Adds all vehicles that should have been emitted earlier to the refuse container. More...
 
 MSInsertionControl (const MSInsertionControl &)
 Invalidated copy constructor. More...
 
MSInsertionControloperator= (const MSInsertionControl &)
 Invalidated assignment operator. More...
 
int tryInsert (SUMOTime time, SUMOVehicle *veh, MSVehicleContainer::VehicleVector &refusedEmits)
 Tries to emit the vehicle. More...
 

Private Attributes

std::set< const SUMOVehicle * > myAbortedEmits
 Set of vehicles which shall not be inserted anymore. More...
 
MSVehicleContainer myAllVeh
 All loaded vehicles sorted by their departure time. More...
 
bool myEagerInsertionCheck
 Whether an edge on which a vehicle could not depart should be ignored in the same step. More...
 
std::set< SUMOVehicle * > myEmitCandidates
 Buffer for vehicles that may be inserted in the current step. More...
 
std::set< std::string > myFlowIDs
 Cache for periodical vehicle ids for quicker checking. More...
 
std::mt19937 myFlowRNG
 A random number generator for probabilistic flows. More...
 
std::vector< FlowmyFlows
 Container for periodical vehicle parameters. More...
 
SUMOTime myMaxDepartDelay
 The maximum waiting time; vehicles waiting longer are deleted (-1: no deletion) More...
 
SUMOTime myMaxRandomDepartOffset
 The maximum random offset to be added to vehicles departure times (non-negative) More...
 
int myMaxVehicleNumber
 Storage for maximum vehicle number. More...
 
MSVehicleContainer::VehicleVector myPendingEmits
 Buffers for vehicles that could not be inserted. More...
 
std::map< const MSLane *, int > myPendingEmitsForLane
 the number of pending emits for each edge in the current time step More...
 
SUMOTime myPendingEmitsUpdateTime
 Last time at which pending emits for each edge where counted. More...
 
MSVehicleControlmyVehicleControl
 The assigned vehicle control (needed for vehicle re-insertion and deletion) More...
 

Detailed Description

Inserts vehicles into the network when their departure time is reached.

Holds a list of vehicles which may be filled by vehicles read by SUMORouteLoaders. Tries to emit vehicles departing at a time into the network as soon this time is reached and keeps them as long the insertion fails.

If a vehicle is emitted, the control about it is given to the lanes.

Vehicles are not controlled (created, deleted) by this class.

Todo:
When a vehicle is deleted due to waiting too long or because of vaporizing, this is not reported anywhere

Definition at line 59 of file MSInsertionControl.h.

Constructor & Destructor Documentation

◆ MSInsertionControl() [1/2]

MSInsertionControl::MSInsertionControl ( MSVehicleControl vc,
SUMOTime  maxDepartDelay,
bool  checkEdgesOnce,
int  maxVehicleNumber,
SUMOTime  randomDepartOffset 
)

Constructor.

Parameters
[in]vcThe assigned vehicle control (needed for vehicle re-insertion and deletion)
[in]maxDepartDelayVehicles waiting for insertion longer than this time are deleted (-1: no deletion)
[in]checkEdgesOnceWhether an edge on which a vehicle could not depart should be ignored in the same step
[in]maxVehicleNumberThe maximum number of vehicles that should not be exceeded

Definition at line 46 of file MSInsertionControl.cpp.

References RandHelper::initRandGlobal(), myFlowRNG, and myMaxRandomDepartOffset.

◆ ~MSInsertionControl()

MSInsertionControl::~MSInsertionControl ( )

Destructor.

Definition at line 61 of file MSInsertionControl.cpp.

References myFlows.

◆ MSInsertionControl() [2/2]

MSInsertionControl::MSInsertionControl ( const MSInsertionControl )
private

Invalidated copy constructor.

Member Function Documentation

◆ adaptIntermodalRouter()

void MSInsertionControl::adaptIntermodalRouter ( MSNet::MSIntermodalRouter router) const

Definition at line 324 of file MSInsertionControl.cpp.

References IntermodalNetwork< E, L, N, V >::addSchedule(), MSRoute::dictionary(), IntermodalRouter< E, L, N, V >::getNetwork(), MSRoute::getStops(), and myFlows.

Referenced by MSNet::adaptIntermodalRouter().

Here is the caller graph for this function:

◆ add()

void MSInsertionControl::add ( SUMOVehicle veh)

Adds a single vehicle for departure.

The vehicle is added to "myAllVeh".

Parameters
[in]vehThe vehicle to add for later insertion

Definition at line 69 of file MSInsertionControl.cpp.

References MSVehicleContainer::add(), and myAllVeh.

Referenced by LIBSUMO_NAMESPACE::Vehicle::add(), MSRouteHandler::closeVehicle(), determineCandidates(), MSStageDriving::proceed(), and MSVehicle::processNextStop().

Here is the caller graph for this function:

◆ addFlow()

bool MSInsertionControl::addFlow ( SUMOVehicleParameter *const  pars,
int  index = -1 
)

Adds parameter for a vehicle flow for departure.

Parameters
[in]parsThe flow parameters to add for later insertion
[in]indexThe current index when loading this flow from a simulation state
Returns
whether it could be added (no other flow with the same id was present)

Definition at line 75 of file MSInsertionControl.cpp.

References SUMOVehicleParameter::id, MSInsertionControl::Flow::index, myFlowIDs, myFlows, SUMOVehicleParameter::parametersSet, MSInsertionControl::Flow::pars, and VEHPARS_FORCE_REROUTE.

Referenced by MSStateHandler::myStartElement().

Here is the caller graph for this function:

◆ alreadyDeparted()

void MSInsertionControl::alreadyDeparted ( SUMOVehicle veh)

stops trying to emit the given vehicle (because it already departed)

Definition at line 279 of file MSInsertionControl.cpp.

References myAllVeh, myPendingEmits, and MSVehicleContainer::remove().

Referenced by MSStateHandler::closeVehicle(), MSVehicleTransfer::loadState(), LIBSUMO_NAMESPACE::Vehicle::moveTo(), LIBSUMO_NAMESPACE::Vehicle::moveToXY(), and LIBSUMO_NAMESPACE::Vehicle::remove().

Here is the caller graph for this function:

◆ checkCandidates()

void MSInsertionControl::checkCandidates ( SUMOTime  time,
const bool  preCheck 
)
private

Adds all vehicles that should have been emitted earlier to the refuse container.

Parameters
[in]timeThe current simulation time
Todo:
recheck

Definition at line 173 of file MSInsertionControl.cpp.

References MSVehicleContainer::anyWaitingBefore(), SUMOVehicle::getDevice(), SUMOTrafficObject::getEdge(), MSEdge::insertVehicle(), myAllVeh, myEagerInsertionCheck, myEmitCandidates, myPendingEmits, MSVehicleContainer::pop(), MSDevice_Routing::skipRouting(), and MSVehicleContainer::top().

Referenced by determineCandidates().

Here is the caller graph for this function:

◆ clearPendingVehicles()

void MSInsertionControl::clearPendingVehicles ( const std::string &  route)

clears out all pending vehicles from a route, "" for all routes

Definition at line 286 of file MSInsertionControl.cpp.

References MSVehicleControl::deleteVehicle(), myPendingEmits, and myVehicleControl.

Referenced by LIBSUMO_NAMESPACE::Simulation::clearPending().

Here is the caller graph for this function:

◆ clearState()

void MSInsertionControl::clearState ( )

Remove all vehicles before quick-loading state.

Definition at line 350 of file MSInsertionControl.cpp.

References MSVehicleContainer::clearState(), myAbortedEmits, myAllVeh, myEmitCandidates, myFlowIDs, myFlows, myPendingEmits, and myPendingEmitsForLane.

Referenced by MSNet::clearState().

Here is the caller graph for this function:

◆ computeRandomDepartOffset()

SUMOTime MSInsertionControl::computeRandomDepartOffset ( ) const

compute (optional) random offset to the departure time

Definition at line 364 of file MSInsertionControl.cpp.

References DELTA_T, MSRouteHandler::getParsingRNG(), myMaxRandomDepartOffset, and RandHelper::rand().

Referenced by MSRouteHandler::addFlowPerson(), MSRouteHandler::closeVehicle(), and determineCandidates().

Here is the caller graph for this function:

◆ descheduleDeparture()

void MSInsertionControl::descheduleDeparture ( const SUMOVehicle veh)

stops trying to emit the given vehicle (and delete it)

Definition at line 273 of file MSInsertionControl.cpp.

References myAbortedEmits.

Referenced by MSLane::checkFailure(), MSLane::isInsertionSuccess(), and MSBaseVehicle::reroute().

Here is the caller graph for this function:

◆ determineCandidates()

◆ emitVehicles()

int MSInsertionControl::emitVehicles ( SUMOTime  time)

Emits vehicles that want to depart at the given time.

All vehicles scheduled for this time are tried to be emitted. This includes those with a depart time as the given time and those that wait for being emitted due they could not be inserted in previous steps.

For each vehicle, tryInsert is called. If this fails, a vehicle keeps within the refused emit containers ("myRefusedEmits1", "myRefusedEmits2") so that it may be emitted within the next steps.

Returns the number of vehicles that could be inserted into the net.

Parameters
[in]timeThe current simulation time
Returns
The number of vehicles that could be inserted into the net

Definition at line 108 of file MSInsertionControl.cpp.

References MSRoutingEngine::isEnabled(), myEmitCandidates, myPendingEmits, and tryInsert().

Referenced by MSNet::simulationStep().

Here is the caller graph for this function:

◆ getFlowRNG()

std::mt19937* MSInsertionControl::getFlowRNG ( )
inline

retrieve internal RNG

Definition at line 161 of file MSInsertionControl.h.

References myFlowRNG.

Referenced by MSStateHandler::myStartElement().

Here is the caller graph for this function:

◆ getPendingEmits()

int MSInsertionControl::getPendingEmits ( const MSLane lane)

return the number of pending emits for the given lane

Definition at line 301 of file MSInsertionControl.cpp.

References MSNet::getCurrentTimeStep(), MSLane::getEdge(), MSNet::getInstance(), MSEdge::getLanes(), myPendingEmits, myPendingEmitsForLane, and myPendingEmitsUpdateTime.

Referenced by GUIEdge::getColorValue(), GUILane::getPendingEmits(), GUIEdge::getScaleValue(), and GUILane::getScaleValue().

Here is the caller graph for this function:

◆ getPendingFlowCount()

int MSInsertionControl::getPendingFlowCount ( ) const

Returns the number of flows that are still active.

Returns
number of active flows

Definition at line 267 of file MSInsertionControl.cpp.

References myFlows.

Referenced by LIBSUMO_NAMESPACE::Simulation::getMinExpectedNumber(), and MSNet::simulationState().

Here is the caller graph for this function:

◆ getWaitingVehicleNo()

int MSInsertionControl::getWaitingVehicleNo ( ) const

Returns the number of waiting vehicles.

The sizes of refused emits (sum of vehicles in "myRefusedEmits1" and "myRefusedEmits2") is returned.

Returns
The number of vehicles that could not (yet) be inserted into the net

Definition at line 261 of file MSInsertionControl.cpp.

References myPendingEmits.

Referenced by MSNet::generateStatistics(), GUINet::getParameterWindow(), GUIApplicationWindow::handleEvent_SimulationStep(), MSNet::postSimStepOutput(), MSNet::writeOutput(), and MSNet::writeStatistics().

Here is the caller graph for this function:

◆ operator=()

MSInsertionControl& MSInsertionControl::operator= ( const MSInsertionControl )
private

Invalidated assignment operator.

◆ saveState()

void MSInsertionControl::saveState ( OutputDevice out)

Saves the current state into the given stream.

Definition at line 336 of file MSInsertionControl.cpp.

References OutputDevice::closeTag(), myFlows, OutputDevice::openTag(), SUMO_ATTR_ID, SUMO_ATTR_INDEX, SUMO_ATTR_REROUTE, SUMO_TAG_FLOWSTATE, VEHPARS_FORCE_REROUTE, and OutputDevice::writeAttr().

Referenced by MSStateHandler::saveState().

Here is the caller graph for this function:

◆ tryInsert()

int MSInsertionControl::tryInsert ( SUMOTime  time,
SUMOVehicle veh,
MSVehicleContainer::VehicleVector refusedEmits 
)
private

Tries to emit the vehicle.

If the insertion fails, it is examined whether the reason was a vaporizing edge. If so, the vehicle is deleted. Otherwise, it is checked whether the time the vehicle had to wait so far is larger than the maximum allowed waiting time. If so, the vehicle is deleted, too. If both does not match, the vehicle is reinserted to "refusedEmits" in order to be emitted in next steps.

Parameters
[in]timeThe current simulation time
[in]vehThe vehicle to emit
[in]refusedEmitsContainer to insert vehicles that could not be emitted into
Returns
The number of emitted vehicles (0 or 1)

Definition at line 137 of file MSInsertionControl.cpp.

References MSVehicleControl::deleteVehicle(), SUMOVehicleParameter::depart, SUMOTrafficObject::getEdge(), MSNet::getInstance(), SUMOTrafficObject::getParameter(), SUMOVehicle::getRouteValidity(), MSEdge::insertVehicle(), SUMOVehicle::isOnRoad(), MSEdge::isVaporizing(), myAbortedEmits, myEagerInsertionCheck, myMaxDepartDelay, myMaxVehicleNumber, myVehicleControl, MSBaseVehicle::ROUTE_START_INVALID_LANE, MSBaseVehicle::ROUTE_START_INVALID_PERMISSIONS, and MSEdge::setLastFailedInsertionTime().

Referenced by emitVehicles().

Here is the caller graph for this function:

Field Documentation

◆ myAbortedEmits

std::set<const SUMOVehicle*> MSInsertionControl::myAbortedEmits
private

Set of vehicles which shall not be inserted anymore.

Definition at line 207 of file MSInsertionControl.h.

Referenced by clearState(), descheduleDeparture(), and tryInsert().

◆ myAllVeh

MSVehicleContainer MSInsertionControl::myAllVeh
private

All loaded vehicles sorted by their departure time.

Definition at line 198 of file MSInsertionControl.h.

Referenced by add(), alreadyDeparted(), checkCandidates(), and clearState().

◆ myEagerInsertionCheck

bool MSInsertionControl::myEagerInsertionCheck
private

Whether an edge on which a vehicle could not depart should be ignored in the same step.

Definition at line 229 of file MSInsertionControl.h.

Referenced by checkCandidates(), and tryInsert().

◆ myEmitCandidates

std::set<SUMOVehicle*> MSInsertionControl::myEmitCandidates
private

Buffer for vehicles that may be inserted in the current step.

Definition at line 204 of file MSInsertionControl.h.

Referenced by checkCandidates(), clearState(), and emitVehicles().

◆ myFlowIDs

std::set<std::string> MSInsertionControl::myFlowIDs
private

Cache for periodical vehicle ids for quicker checking.

Definition at line 223 of file MSInsertionControl.h.

Referenced by addFlow(), and clearState().

◆ myFlowRNG

std::mt19937 MSInsertionControl::myFlowRNG
private

A random number generator for probabilistic flows.

Definition at line 251 of file MSInsertionControl.h.

Referenced by determineCandidates(), getFlowRNG(), and MSInsertionControl().

◆ myFlows

std::vector<Flow> MSInsertionControl::myFlows
private

Container for periodical vehicle parameters.

Definition at line 220 of file MSInsertionControl.h.

Referenced by adaptIntermodalRouter(), addFlow(), clearState(), determineCandidates(), getPendingFlowCount(), saveState(), and ~MSInsertionControl().

◆ myMaxDepartDelay

SUMOTime MSInsertionControl::myMaxDepartDelay
private

The maximum waiting time; vehicles waiting longer are deleted (-1: no deletion)

Definition at line 226 of file MSInsertionControl.h.

Referenced by tryInsert().

◆ myMaxRandomDepartOffset

SUMOTime MSInsertionControl::myMaxRandomDepartOffset
private

The maximum random offset to be added to vehicles departure times (non-negative)

Definition at line 241 of file MSInsertionControl.h.

Referenced by computeRandomDepartOffset(), and MSInsertionControl().

◆ myMaxVehicleNumber

int MSInsertionControl::myMaxVehicleNumber
private

Storage for maximum vehicle number.

Definition at line 232 of file MSInsertionControl.h.

Referenced by tryInsert().

◆ myPendingEmits

MSVehicleContainer::VehicleVector MSInsertionControl::myPendingEmits
private

Buffers for vehicles that could not be inserted.

Definition at line 201 of file MSInsertionControl.h.

Referenced by alreadyDeparted(), checkCandidates(), clearPendingVehicles(), clearState(), emitVehicles(), getPendingEmits(), and getWaitingVehicleNo().

◆ myPendingEmitsForLane

std::map<const MSLane*, int> MSInsertionControl::myPendingEmitsForLane
private

the number of pending emits for each edge in the current time step

Definition at line 238 of file MSInsertionControl.h.

Referenced by clearState(), and getPendingEmits().

◆ myPendingEmitsUpdateTime

SUMOTime MSInsertionControl::myPendingEmitsUpdateTime
private

Last time at which pending emits for each edge where counted.

Definition at line 235 of file MSInsertionControl.h.

Referenced by getPendingEmits().

◆ myVehicleControl

MSVehicleControl& MSInsertionControl::myVehicleControl
private

The assigned vehicle control (needed for vehicle re-insertion and deletion)

Definition at line 195 of file MSInsertionControl.h.

Referenced by clearPendingVehicles(), and tryInsert().


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