MSRailSignalControl.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2002-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
/****************************************************************************/
// Centralized services for rail signal control (Singleton)
// - monitors track usage for long-range deadlock prevention
/****************************************************************************/
#pragma once
#include <config.h>
#include <microsim/MSNet.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSRailSignal;
class MSRailSignalConstraint;
class MSEdge;
class MSDriveWay;
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSRailSignalControl : public MSNet::VehicleStateListener {
public:
 
    ~MSRailSignalControl();
 
    static MSRailSignalControl& getInstance();
 
    static bool hasInstance() {
        return myInstance != nullptr;
    }
 
    static void cleanup();
 
    static void clearState();
 
    void resetWaitRelations() {
        myWaitRelations.clear();
        myWrittenDeadlocks.clear();
    }
 
    void addWaitRelation(const SUMOVehicle* waits, const MSRailSignal* rs, const SUMOVehicle* reason, MSRailSignalConstraint* constraint = nullptr);
 
    void addDrivewayFollower(const MSDriveWay* dw, const MSDriveWay* dw2);
 
    void addDWDeadlockChecks(const MSRailSignal* rs, MSDriveWay* dw);
 
    bool haveDeadlock(const SUMOVehicle* veh) const;
 
    void loadDeadlockCheck(std::vector<const MSRailSignal*> signals);
    void loadDeadlockRoute(const ConstMSEdgeVector& edges);
 
    void vehicleStateChanged(const SUMOVehicle* const vehicle, MSNet::VehicleState to, const std::string& info = "");
 
    void addSignal(MSRailSignal* signal);
 
    const std::vector<MSRailSignal*>& getSignals() const {
        return mySignals;
    }
 
    void notifyApproach(const MSLink* link);
 
    void updateSignals(SUMOTime t);
 
 
    static bool isSignalized(SUMOVehicleClass svc) {
        return (mySignalizedClasses & svc) == svc;
    }
 
    static bool isMovingBlock(SVCPermissions svc) {
        return (myMBClasses & svc & SVC_RAIL_CLASSES) == (svc & SVC_RAIL_CLASSES);
    }
 
    static bool isUsingDriveWays(SVCPermissions svc) {
        return ((mySignalizedClasses | myMBClasses) & svc) == svc;
    }
 
    static void initSignalized(SVCPermissions svc, SVCPermissions mbSvc) {
        mySignalizedClasses = svc;
        myMBClasses = mbSvc;
    }
 
    struct Deadlock {
        std::vector<const MSRailSignal*> signals;
        std::vector<ConstMSEdgeVector> edges;
        ConstMSEdgeVector forwardEnds;
    };
 
protected:
 
    void findDeadlockFoes(const MSDriveWay* dw, const Deadlock& dl, int signalIndex, std::vector<const MSDriveWay*> deadlockFoes);
    void findDeadlockFoesFromRoutes(const MSDriveWay* dw, const Deadlock& dl, int signalIndex, std::vector<const MSDriveWay*> deadlockFoes);
 
 
private:
    MSRailSignalControl();
 
    void updateDriveways(const MSEdge* used);
 
    std::set<const MSEdge*> myUsedEdges;
 
    struct WaitRelation {
        WaitRelation(const MSRailSignal* _railSignal = nullptr, const SUMOVehicle* _foe = nullptr, MSRailSignalConstraint* _constraint = nullptr) :
            railSignal(_railSignal), foe(_foe), constraint(_constraint) {}
        // indices along route
        const MSRailSignal* railSignal;
        const SUMOVehicle* foe;
        MSRailSignalConstraint* constraint;
    };
    std::map<const SUMOVehicle*, WaitRelation> myWaitRelations;
 
    mutable std::set<std::set<const SUMOVehicle*> > myWrittenDeadlocks;
 
    std::vector<Deadlock> myLoadedDeadlocks;
    // @brief index in list of loaded deadlocks, index of signal in list of signals
    std::map<const MSRailSignal*, std::vector<std::pair<int, int> > > mySignalDeadlocks;
 
    std::map<const MSDriveWay*, std::set<const MSDriveWay*, ComparatorNumericalIdLess>> myDriveWaySucc;
    std::map<const MSDriveWay*, std::set<const MSDriveWay*>> myDriveWayPred;
 
    std::vector<MSRailSignal*> mySignals;
 
    std::vector<std::pair<MSLink*, int> > mySwitchedGreenFlanks;
    std::map<std::pair<int, int>, bool> myDriveWayCompatibility;
    std::set<MSRailSignal*, ComparatorNumericalIdLess> myActiveSignals;
    double myMaxTrainLength;
 
    static SVCPermissions mySignalizedClasses;
    static SVCPermissions myMBClasses;
 
    static MSRailSignalControl* myInstance;
 
 
};