MSRailSignal.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
/****************************************************************************/
// 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 MSDriveWay;
 
 
// ===========================================================================
// 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();
 
    inline int getNumericalID() const {
        return myNumericalID;
    }
 
    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;
 
 
 
 
    bool 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;
 
    void resetLastSwitch(SUMOTime t); 
 
 
    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;
    static VehicleVector getBlockingVehicles(const MSDriveWay* dw);
 
    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;
 
    std::vector<const MSDriveWay*> getBlockingDriveWays(int linkIndex) override;
    std::string getBlockingDriveWayIDs() const;
 
    static std::vector<const MSDriveWay*> getBlockingDriveWays(const MSDriveWay* dw);
 
    std::string getRequestedDriveWay(int linkIndex) override;
    std::string getRequestedDriveWay() const;
 
    void writeBlocks(OutputDevice& od, bool writeVehicles) 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 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::map<const MSLane*, int, ComparatorNumericalIdLess> LaneVisitedMap;
 
    /* @brief retrieve driveway with the given numerical id
     * @note: throws exception if the driveway does not exist at this rail signal */
    const MSDriveWay& retrieveDriveWay(int numericalID) const;
 
    const MSDriveWay& retrieveDriveWayForVeh(int tlIndex, const SUMOVehicle* veh);
    const MSDriveWay& retrieveDriveWayForRoute(int tlIndex, MSRouteIterator first, MSRouteIterator end);
 
    const std::vector<MSDriveWay*> retrieveDriveWays(int tlIndex) const;
 
    bool constraintsAllow(const SUMOVehicle* veh, bool storeWaitRelation = false) const;
 
    bool isMovingBlock() const {
        return myMovingBlock;
    }
 
    static bool storeVehicles() {
        return myStoreVehicles;
    }
 
    static VehicleVector& blockingVehicles() {
        return myBlockingVehicles;
    }
 
    static std::vector<const MSDriveWay*>& blockingDriveWays() {
        return myBlockingDriveWays;
    }
 
    static VehicleVector& rivalVehicles() {
        return myRivalVehicles;
    }
 
    static VehicleVector& priorityVehicles() {
        return myPriorityVehicles;
    }
 
    static std::string describeLinks(std::vector<MSLink*> links);
 
protected:
 
    const int myNumericalID;
 
    std::string getNewDrivewayID();
 
    /* The driveways for each link
     */
    struct LinkInfo {
        LinkInfo(MSLink* link);
 
        ~LinkInfo();
 
        MSLink* myLink;
 
        std::vector<MSDriveWay*> myDriveways;
 
        std::string getID() const;
 
        MSDriveWay& getDriveWay(const SUMOVehicle*, int searchStart = -1);
        MSDriveWay& getDriveWay(MSRouteIterator firstIt, MSRouteIterator endIt, const std::string& info = "");
 
        void reroute(SUMOVehicle* veh, const MSEdgeVector& occupied);
 
        void reset();
 
        SUMOTime myLastRerouteTime;
        SUMOVehicle* myLastRerouteVehicle;
 
        bool myControlled;
    };
 
    std::vector<LinkInfo> myLinkInfos;
 
protected:
 
    Phases myPhases;
 
    MSPhaseDefinition myCurrentPhase;
 
    int myPhaseIndex;
 
    bool myMovingBlock;
 
    std::map<std::string, std::vector<MSRailSignalConstraint*> > myConstraints;
 
    int myDriveWayIndex;
 
    static int myRSIndex;
 
protected:
    void storeTraCIVehicles(int linkIndex);
    static void storeTraCIVehicles(const MSDriveWay* dw);
 
    static void resetStored();
 
 
    static bool myStoreVehicles;
    static VehicleVector myBlockingVehicles;
    static VehicleVector myRivalVehicles;
    static VehicleVector myPriorityVehicles;
    static std::string myConstraintInfo;
    static std::vector<const MSDriveWay*> myBlockingDriveWays;
    static std::string myRequestedDriveWay;
 
 
};