MSRailSignal.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2002-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
/****************************************************************************/
// A rail signal logic
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <microsim/MSRoute.h>
#include <microsim/traffic_lights/MSTrafficLightLogic.h>
#include <microsim/traffic_lights/MSTLLogicControl.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSLink;
class MSPhaseDefinition;
class MSRailSignalConstraint;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class MSRailSignal : public MSTrafficLightLogic {
public:
    MSRailSignal(MSTLLogicControl& tlcontrol,
                 const std::string& id, const std::string& programID, SUMOTime delay,
                 const Parameterised::Map& parameters);
 
 
    void init(NLDetectorBuilder& nb) override;
 
 
    ~MSRailSignal();
 
    void setParameter(const std::string& key, const std::string& value) override;
 
    void addLink(MSLink* link, MSLane* lane, int pos) override;
 
 
    void adaptLinkInformationFrom(const MSTrafficLightLogic& logic) override;
 
 
 
 
    void updateCurrentPhase();
 
    SUMOTime trySwitch() override;
 
 
 
 
    int getPhaseNumber() const override;
 
    const Phases& getPhases() const override;
 
    const MSPhaseDefinition& getPhase(int givenstep) const override;
 
    bool getsMajorGreen(int /*linkIndex*/) const override {
        return true;
    }
 
 
 
    int getCurrentPhaseIndex() const override;
 
    const MSPhaseDefinition& getCurrentPhaseDef() const override;
 
 
 
    SUMOTime getPhaseIndexAtTime(SUMOTime simStep) const override;
 
    SUMOTime getOffsetFromIndex(int index) const override;
 
    int getIndexFromOffset(SUMOTime offset) const override;
 
 
 
    void changeStepAndDuration(MSTLLogicControl& tlcontrol, SUMOTime simStep, int step, SUMOTime stepDuration) override {
        UNUSED_PARAMETER(tlcontrol);
        UNUSED_PARAMETER(simStep);
        UNUSED_PARAMETER(step);
        UNUSED_PARAMETER(stepDuration);
    }
 
    VehicleVector getBlockingVehicles(int linkIndex) override;
    std::string getBlockingVehicleIDs() const;
 
    VehicleVector getRivalVehicles(int linkIndex) override;
    std::string getRivalVehicleIDs() const;
 
    VehicleVector getPriorityVehicles(int linkIndex) override;
    std::string getPriorityVehicleIDs() const;
 
    std::string getConstraintInfo(int linkIndex);
    std::string getConstraintInfo() const;
 
    void writeBlocks(OutputDevice& od) const;
 
    void addConstraint(const std::string& tripId, MSRailSignalConstraint* constraint);
 
    const std::map<std::string, std::vector<MSRailSignalConstraint*> >&  getConstraints() const {
        return myConstraints;
    }
 
    bool removeConstraint(const std::string& tripId, MSRailSignalConstraint* constraint);
    void removeConstraints();
 
    void updateDriveway(int numericalID);
 
    /* @brief return whether vehicle insertion must be delayed for an oncoming train
     * @param[in] link The rail signal link before which the vehicle is being inserted
     * @param[in] veh The vehicle being inserted
     * @param[in] brakeBeforeSignal Whether the vehicle may brake before the signal,
     *                              Returns true if the vehicle has to brake before the signal
     */
    static bool hasOncomingRailTraffic(MSLink* link, const MSVehicle* ego, bool& brakeBeforeSignal);
 
    static bool hasInsertionConstraint(MSLink* link, const MSVehicle* veh, std::string& info, bool& isInsertionOrder);
 
    static void initDriveWays(const SUMOVehicle* ego, bool update);
 
    typedef std::pair<const SUMOVehicle* const, const MSLink::ApproachingVehicleInformation> Approaching;
    typedef std::set<const MSLane*, ComparatorNumericalIdLess> LaneSet;
    typedef std::map<const MSLane*, int, ComparatorNumericalIdLess> LaneVisitedMap;
 
    /*  The driveways (Fahrstrassen) for each link index
     *  Each link index has at least one driveway
     *  A driveway describes one possible route that passes the signal up
     *  the next secure point
     *  When a signal guards a switch (indirect guard) that signal stores two
     *  or more driveways
     */
    struct DriveWay {
 
        DriveWay(bool temporary = false) :
            myNumericalID(temporary ? -1 : myDriveWayIndex++),
            myMaxFlankLength(0),
            myActive(nullptr),
            myProtectedBidi(nullptr),
            myCoreSize(0),
            myFoundSignal(false),
            myFoundReversal(false)
        {}
 
        int myNumericalID;
 
        double myMaxFlankLength;
 
        const SUMOVehicle* myActive;
 
        const MSEdge* myProtectedBidi;
 
        std::vector<const MSEdge*> myRoute;
 
        int myCoreSize;
 
        bool myFoundSignal;
        bool myFoundReversal;
 
        /* @brief the actual driveway part up to the next railsignal (halting position)
         * This must be free of other trains */
        std::vector<const MSLane*> myForward;
 
        /* @brief the list of bidirectional edges that can enter the forward
         * section and which must also be free of traffic
         * (up to the first element that could give protection) */
        std::vector<const MSLane*> myBidi;
 
        /* @brief the list of bidirectional edges that can enter the forward
         * section and which might contain deadlock-relevant traffic */
        std::vector<const MSLane*> myBidiExtended;
 
        /* @brief the list of edges that merge with the forward section
         * (found via backward search, up to the first element that could give protection) */
        std::vector<const MSLane*> myFlank;
 
        std::vector<const MSLane*> myConflictLanes;
 
        /* @brief the list of switches that threaten the driveway and for which protection must be found
         */
        std::vector<MSLink*> myFlankSwitches;
 
        /* @brief the list of (first) switches that could give protection from oncoming/flanking vehicles
         * if any of them fails to do so, upstream search must be performed
         * until protection or conflict is found
         */
        std::vector<MSLink*> myProtectingSwitches;
        std::vector<MSLink*> myProtectingSwitchesBidi;
 
        /* The conflict links for this block
         * Conflict resolution must be performed if vehicles are approaching the
         * current link and any of the conflict links */
        std::vector<MSLink*> myConflictLinks;
 
        bool conflictLaneOccupied(const std::string& joinVehicle = "", bool store = true, const SUMOVehicle* ego = nullptr) const;
 
        bool deadlockLaneOccupied(bool store = true) const;
 
        bool reserve(const Approaching& closest, MSEdgeVector& occupied);
 
        bool hasLinkConflict(const Approaching& closest, MSLink* foeLink) const;
 
        static bool mustYield(const Approaching& veh, const Approaching& foe);
 
        bool conflictLinkApproached() const;
 
        bool findProtection(const Approaching& veh, MSLink* link) const;
 
        bool overlap(const DriveWay& other) const;
 
        bool flankConflict(const DriveWay& other) const;
 
        void writeBlocks(OutputDevice& od) const;
 
        /* @brief determine route that identifies this driveway (a subset of the
         * vehicle route)
         * collects:
         *   myRoute
         *   myForward
         *   myBidi
         *   myProtectedBidi
         *
         * returns edge that is assumed to safe from oncoming-deadlock or nullptr
         */
        void buildRoute(MSLink* origin, double length, MSRouteIterator next, MSRouteIterator end, LaneVisitedMap& visited);
 
        /* @brief find switches that threaten this driveway
         * @param[out] flankSwitches collect the switches
         */
        void checkFlanks(const MSLink* originLink, const std::vector<const MSLane*>& lanes, const LaneVisitedMap& visited, bool allFoes, std::vector<MSLink*>& flankSwitches) const;
 
        /* @brief find links that cross the driveway without entering it
         * @param[out] flankSwitches collect the switches
         */
        void checkCrossingFlanks(MSLink* dwLink, const LaneVisitedMap& visited, std::vector<MSLink*>& flankSwitches) const;
 
        /* @brief find upstream protection from the given link
         * @param[out] flank: the stored flank lanes
         */
        void findFlankProtection(MSLink* link, double length, LaneVisitedMap& visited, MSLink* origLink, std::vector<const MSLane*>& flank);
    };
 
    /* @brief retrieve driveway with the given numerical id
     * @note: throws exception if the driveway does not exist at this rail signal */
    const DriveWay& retrieveDriveWay(int numericalID) const;
 
    static Approaching getClosest(MSLink* link);
 
protected:
    bool constraintsAllow(const SUMOVehicle* veh) const;
 
protected:
 
    /* The driveways for each link
     */
    struct LinkInfo {
        LinkInfo(MSLink* link);
 
        MSLink* myLink;
 
        std::vector<DriveWay> myDriveways;
 
        std::string getID() const;
 
        DriveWay& getDriveWay(const SUMOVehicle*);
 
        DriveWay buildDriveWay(MSRouteIterator first, MSRouteIterator end);
 
        void reroute(SUMOVehicle* veh, const MSEdgeVector& occupied);
 
        void reset();
 
        SUMOTime myLastRerouteTime;
        SUMOVehicle* myLastRerouteVehicle;
    };
 
    std::vector<LinkInfo> myLinkInfos;
 
    static std::string getTLLinkID(MSLink* link);
 
    static std::string getJunctionLinkID(MSLink* link);
 
    static std::string getClickableTLLinkID(MSLink* link);
 
    static std::string describeLinks(std::vector<MSLink*> links);
 
    static std::string formatVisitedMap(const LaneVisitedMap& visited);
 
    static void appendMapIndex(LaneVisitedMap& map, const MSLane* lane);
 
protected:
 
    Phases myPhases;
 
    MSPhaseDefinition myCurrentPhase;
 
    int myPhaseIndex;
 
    bool myMovingBlock;
 
    std::map<std::string, std::vector<MSRailSignalConstraint*> > myConstraints;
 
    static int myNumWarnings;
 
    static int myDriveWayIndex;
 
protected:
    void storeTraCIVehicles(int linkIndex);
 
 
    static bool myStoreVehicles;
    static VehicleVector myBlockingVehicles;
    static VehicleVector myRivalVehicles;
    static VehicleVector myPriorityVehicles;
    static std::string myConstraintInfo;
 
 
};