MSInsertionControl.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Inserts vehicles into the network when their departure time is reached
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <map>
#include <string>
#include <set>
#include <utils/foxtools/MFXSynchSet.h>
#include <microsim/MSRouterDefs.h>
#include "MSVehicleContainer.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSVehicle;
class MSVehicleControl;
class SUMOVehicle;
class SUMOVehicleParameter;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSInsertionControl {
public:
    MSInsertionControl(MSVehicleControl& vc, SUMOTime maxDepartDelay, bool checkEdgesOnce, int maxVehicleNumber, SUMOTime randomDepartOffset);
 
 
    ~MSInsertionControl();
 
 
    int emitVehicles(SUMOTime time);
 
 
    void add(SUMOVehicle* veh);
 
 
    bool addFlow(SUMOVehicleParameter* const pars, int index = -1);
 
 
    int getWaitingVehicleNo() const;
 
    const MSVehicleContainer::VehicleVector& getPendingVehicles() const {
        return myPendingEmits;
    }
 
    int getPendingFlowCount() const;
 
    void alreadyDeparted(SUMOVehicle* veh);
 
    void descheduleDeparture(const SUMOVehicle* veh);
 
    void retractDescheduleDeparture(const SUMOVehicle* veh);
 
    void clearPendingVehicles(const std::string& route);
 
 
    void determineCandidates(SUMOTime time);
 
    int getPendingEmits(const MSLane* lane);
 
    void adaptIntermodalRouter(MSTransportableRouter& router) const;
 
    SUMOTime computeRandomDepartOffset() const;
 
    void saveState(OutputDevice& out);
 
    void clearState();
 
    SumoRNG* getFlowRNG() {
        return &myFlowRNG;
    }
 
    bool hasFlow(const std::string& id) const {
        return myFlowIDs.count(id) != 0;
    }
 
    const SUMOVehicleParameter* getFlowPars(const std::string& id) const;
 
    SUMOVehicle* getLastFlowVehicle(const std::string& id) const;
 
    void updateScale(const std::string vtypeid);
 
private:
    int tryInsert(SUMOTime time, SUMOVehicle* veh,
                  MSVehicleContainer::VehicleVector& refusedEmits);
 
 
    void checkCandidates(SUMOTime time, const bool preCheck);
 
 
private:
 
    static double initScale(const std::string vtypeid);
 
private:
    MSVehicleControl& myVehicleControl;
 
    MSVehicleContainer myAllVeh;
 
    MSVehicleContainer::VehicleVector myPendingEmits;
 
    std::set<SUMOVehicle*> myEmitCandidates;
 
 
#ifdef HAVE_FOX
    MFXSynchSet<const SUMOVehicle*> myAbortedEmits;
#else
    std::set<const SUMOVehicle*> myAbortedEmits;
#endif
 
    struct Flow {
        SUMOVehicleParameter* pars;
        int index;
        double scale;
    };
 
    std::vector<Flow> myFlows;
 
    std::map<std::string, int> myFlowIDs;
 
    SUMOTime myMaxDepartDelay;
 
    bool myEagerInsertionCheck;
 
    int myMaxVehicleNumber;
 
    SUMOTime myPendingEmitsUpdateTime;
 
    std::map<const MSLane*, int> myPendingEmitsForLane;
 
    SUMOTime myMaxRandomDepartOffset;
 
private:
    MSInsertionControl(const MSInsertionControl&);
 
    MSInsertionControl& operator=(const MSInsertionControl&);
 
    SumoRNG myFlowRNG;
 
};