MELoop.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2026 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
/****************************************************************************/
// The main mesocopic simulation loop
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <queue>
#include <map>
#include <utils/common/SUMOTime.h>
#include <microsim/MSMoveReminder.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MESegment;
class MEVehicle;
class MSEdge;
class MSLink;
class MSVehicleControl;
class OptionsCont;
 
// ===========================================================================
// class definitions
// ===========================================================================
class MELoop {
public:
    MELoop(const SUMOTime recheckInterval);
 
    ~MELoop();
 
    void simulate(SUMOTime tMax);
 
    void addLeaderCar(MEVehicle* veh, MSLink* link, const bool fromState = false);
 
    void removeLeaderCar(MEVehicle* v);
 
    void vaporizeCar(MEVehicle* v, MSMoveReminder::Notification reason);
 
    static bool isEnteringRoundabout(const MSEdge& e);
 
    static int numSegmentsFor(const double length, const double slength);
 
    void buildSegmentsFor(const MSEdge& e, const OptionsCont& oc);
 
    MESegment* getSegmentForEdge(const MSEdge& e, double pos = 0);
 
    SUMOTime changeSegment(MEVehicle* veh, SUMOTime leaveTime, MESegment* const toSegment,
                           MSMoveReminder::Notification reason, const bool ignoreLink = false) const;
 
    void clearState();
 
    static long long int getEventCounter() {
        return LeaderEvent::myEventCounter;
    }
 
    static void setEventCounter(long long int counter) {
        LeaderEvent::myEventCounter = counter;
    }
 
private:
    void checkCar(MEVehicle* veh);
 
    MESegment* nextSegment(MESegment* s, MEVehicle* v);
 
 
    void teleportVehicle(MEVehicle* veh, MESegment* const toSegment, bool disconnected);
 
private:
 
    struct LeaderEvent {
        LeaderEvent(MEVehicle* v);
 
        SUMOTime time;
        // eventIndex ensures stable sorting of vehicles with the same event time
        long long int eventIndex;
        // nid allows safely comparing events for deleted vehicles (myInvalidatedLeaderCars)
        long long int nid;
        MEVehicle* veh;
 
        bool operator<(const LeaderEvent& b) const {
            if (time == b.time) {
                return eventIndex > b.eventIndex;
            }
            return time > b.time;
        }
 
        bool operator==(const LeaderEvent& b) const {
            return time == b.time && nid == b.nid;
        }
 
        static long long int myEventCounter;
    };
 
    bool wasInvalidated(const LeaderEvent& e);
 
 
    typedef std::priority_queue<LeaderEvent> LeaderEventQeue;
    LeaderEventQeue myLeaderCars;
    LeaderEventQeue myInvalidatedLeaderCars;
 
    std::vector<MESegment*> myEdges2FirstSegments;
 
    const SUMOTime myFullRecheckInterval;
 
    const SUMOTime myLinkRecheckInterval;
 
private:
    MELoop(const MELoop&);
 
    MELoop& operator=(const MELoop&);
};