NBOwnTLDef.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
/****************************************************************************/
// A traffic light logics which must be computed (only nodes/edges are given)
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <vector>
#include <set>
#include <utils/xml/SUMOXMLDefinitions.h>
#include "NBTrafficLightDefinition.h"
#include "NBNode.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class NBOwnTLDef : public NBTrafficLightDefinition {
public:
    NBOwnTLDef(const std::string& id,
               const std::vector<NBNode*>& junctions,
               SUMOTime offset,
               TrafficLightType type);
 
 
    NBOwnTLDef(const std::string& id, NBNode* junction, SUMOTime offset,
               TrafficLightType type);
 
 
    NBOwnTLDef(const std::string& id, SUMOTime offset, TrafficLightType type);
 
 
    ~NBOwnTLDef();
 
 
 
    void remapRemoved(NBEdge* removed,
                      const EdgeVector& incoming, const EdgeVector& outgoing);
 
 
    void setTLControllingInformation() const;
 
 
    void setSinglePhase() {
        myHaveSinglePhase = true;
    }
 
    static void addGreenWithin(NBTrafficLightLogic* logic, const EdgeVector& fromEdges, EdgeVector& toProc);
 
    static void addPedestrianScramble(NBTrafficLightLogic* logic, int totalNumLinks, SUMOTime greenTime, SUMOTime yellowTime,
                                      const std::vector<NBNode::Crossing*>& crossings, const EdgeVector& fromEdges, const EdgeVector& toEdges);
 
    static std::string addPedestrianPhases(NBTrafficLightLogic* logic, const SUMOTime greenTime, const SUMOTime minDur, const SUMOTime maxDur,
                                           const SUMOTime earliestEnd, const SUMOTime latestEnd,
                                           std::string state, const std::vector<NBNode::Crossing*>& crossings, const EdgeVector& fromEdges, const EdgeVector& toEdges);
 
    static std::string patchStateForCrossings(const std::string& state, const std::vector<NBNode::Crossing*>& crossings, const EdgeVector& fromEdges, const EdgeVector& toEdges);
 
    static std::string patchNEMAStateForCrossings(const std::string& state,
            const std::vector<NBNode::Crossing*>& crossings,
            const EdgeVector& fromEdges,
            const EdgeVector& toEdges,
            const NBEdge* greenEdge, NBEdge* otherChosen);
 
    NBTrafficLightLogic* computeLogicAndConts(int brakingTimeSeconds, bool onlyConts = false);
 
    /* initialize myNeedsContRelation and set myNeedsContRelationReady to true */
    void initNeedsContRelation() const;
 
    /* build optional all-red phase */
    void buildAllRedState(SUMOTime allRedTime, NBTrafficLightLogic* logic, const std::string& state);
 
    int getMaxIndex();
 
    void setLayout(TrafficLightLayout layout) {
        myLayout = layout;
    }
 
    TrafficLightLayout getLayout() const {
        return myLayout;
    }
 
    static const double MIN_SPEED_CROSSING_TIME;
 
protected:
 
    NBTrafficLightLogic* myCompute(int brakingTimeSeconds);
 
 
    void collectLinks();
 
 
    void replaceRemoved(NBEdge* removed, int removedLane,
                        NBEdge* by, int byLane, bool incoming);
 
 
protected:
 
    bool corridorLike() const;
 
    NBTrafficLightLogic* buildNemaPhases(
        const EdgeVector& fromEdges,
        const EdgeVector& toEdges,
        const std::vector<NBNode::Crossing*>& crossings,
        const std::vector<std::pair<NBEdge*, NBEdge*> >& chosenList,
        const std::vector<std::string>& straightStates,
        const std::vector<std::string>& leftStates);
 
    std::string filterState(std::string state, const EdgeVector& fromEdges, const NBEdge* e);
 
    void filterMissingNames(std::vector<int>& vec, const std::map<int, int>& names, bool isBarrier, int barrierDefault = 0);
 
    void fixDurationSum(NBTrafficLightLogic* logic, const std::map<int, int>& names, int ring1a, int ring1b, int ring2a, int ring2b);
 
    double getDirectionalWeight(LinkDirection dir);
 
 
    int getToPrio(const NBEdge* const e);
 
 
    double computeUnblockedWeightedStreamNumber(const NBEdge* const e1, const NBEdge* const e2);
 
 
    std::pair<NBEdge*, NBEdge*> getBestCombination(const EdgeVector& edges);
 
 
    std::pair<NBEdge*, NBEdge*> getBestPair(EdgeVector& incoming);
 
 
    static bool hasCrossing(const NBEdge* from, const NBEdge* to, const std::vector<NBNode::Crossing*>& crossings);
 
    static EdgeVector getConnectedOuterEdges(const EdgeVector& incoming);
 
 
    std::string allowCompatible(std::string state, const EdgeVector& fromEdges, const EdgeVector& toEdges,
                                const std::vector<int>& fromLanes, const std::vector<int>& toLanes);
 
    std::string allowSingleEdge(std::string state, const EdgeVector& fromEdges);
 
    std::string allowFollowers(std::string state, const EdgeVector& fromEdges, const EdgeVector& toEdges);
 
    std::string allowPredecessors(std::string state, const EdgeVector& fromEdges, const EdgeVector& toEdges,
                                  const std::vector<int>& fromLanes, const std::vector<int>& toLanes);
 
    std::string allowUnrelated(std::string state, const EdgeVector& fromEdges, const EdgeVector& toEdges,
                               const std::vector<bool>& isTurnaround,
                               const std::vector<NBNode::Crossing*>& crossings);
 
    std::string allowByVClass(std::string state, const EdgeVector& fromEdges, const EdgeVector& toEdges, SVCPermissions perm);
 
    bool forbidden(const std::string& state, int index, const EdgeVector& fromEdges, const EdgeVector& toEdges, bool allowCont);
 
    std::string correctConflicting(std::string state, const EdgeVector& fromEdges, const EdgeVector& toEdges,
                                   const std::vector<bool>& isTurnaround,
                                   const std::vector<int>& fromLanes,
                                   const std::vector<int>& toLanes,
                                   const std::vector<bool>& hadGreenMajor,
                                   bool& haveForbiddenLeftMover,
                                   std::vector<bool>& rightTurnConflicts,
                                   std::vector<bool>& mergeConflicts);
 
    std::string correctMixed(std::string state, const EdgeVector& fromEdges,
                             const std::vector<int>& fromLanes,
                             bool& buildMixedGreenPhase, std::vector<bool>& mixedGreen);
 
    void checkCustomCrossingIndices(NBTrafficLightLogic* logic) const;
 
    void fixSuperfluousYellow(NBTrafficLightLogic* logic) const;
 
    void deactivateAlwaysGreen(NBTrafficLightLogic* logic) const;
 
    void deactivateInsideEdges(NBTrafficLightLogic* logic, const EdgeVector& fromEdges) const;
 
    SUMOTime computeEscapeTime(const std::string& state, const EdgeVector& fromEdges, const EdgeVector& toEdges) const;
 
    bool hasStraightConnection(const NBEdge* fromEdge);
 
    class edge_by_incoming_priority_sorter {
    public:
        int operator()(const NBEdge* const e1, const NBEdge* const e2) const {
            if (e1->getJunctionPriority(e1->getToNode()) != e2->getJunctionPriority(e2->getToNode())) {
                return e1->getJunctionPriority(e1->getToNode()) > e2->getJunctionPriority(e2->getToNode());
            }
            return e1->getID() > e2->getID();
        }
    };
 
 
private:
    bool myHaveSinglePhase;
 
    TrafficLightLayout myLayout;
 
};