NIImporter_SUMO.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
/****************************************************************************/
// Importer for networks stored in SUMO format
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <map>
#include <utils/xml/SUMOSAXHandler.h>
#include <utils/geom/GeoConvHelper.h>
#include <utils/common/Parameterised.h>
#include <netbuild/NBLoadedSUMOTLDef.h>
#include "NIXMLTypesHandler.h"
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class NBNetBuilder;
class NBEdge;
class OptionsCont;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class NIImporter_SUMO : public SUMOSAXHandler {
public:
    static void loadNetwork(OptionsCont& oc, NBNetBuilder& nb);
 
    static NBLoadedSUMOTLDef* initTrafficLightLogic(const SUMOSAXAttributes& attrs, NBLoadedSUMOTLDef* currentTL);
 
    static void addPhase(const SUMOSAXAttributes& attrs, NBLoadedSUMOTLDef* currentTL);
 
    static GeoConvHelper* loadLocation(const SUMOSAXAttributes& attrs, bool setLoaded = true);
 
protected:
    NIImporter_SUMO(NBNetBuilder& nb);
 
    ~NIImporter_SUMO();
 
 
 
    void myStartElement(int element,
                        const SUMOSAXAttributes& attrs);
 
 
    void myEndElement(int element);
 
 
private:
    void _loadNetwork(OptionsCont& oc);
 
 
 
    void addEdge(const SUMOSAXAttributes& attrs);
 
 
    void addLane(const SUMOSAXAttributes& attrs);
 
    void addStopOffsets(const SUMOSAXAttributes& attrs, bool& ok);
 
    void addJunction(const SUMOSAXAttributes& attrs);
 
 
    void addRequest(const SUMOSAXAttributes& attrs);
 
 
    void addConnection(const SUMOSAXAttributes& attrs);
 
    void addProhibition(const SUMOSAXAttributes& attrs);
 
    void addRoundabout(const SUMOSAXAttributes& attrs);
 
 
 
 
private:
    class Connection final : public Parameterised {
    public:
        std::string toEdgeID;
        int toLaneIdx;
        std::string tlID;
        int tlLinkIndex;
        int tlLinkIndex2;
        bool mayDefinitelyPass;
        /* @brief Whether the junction must be kept clear coming from this connection
         * @note: The enum NBEdge::KeepClear is not needed here because data
         *        from a .net.xml is fully specified */
        bool keepClear;
        double contPos;
        double visibility;
        SVCPermissions permissions;
        SVCPermissions changeLeft;
        SVCPermissions changeRight;
        double speed;
        double friction;
        double customLength;
        PositionVector customShape;
        bool uncontrolled;
        bool indirectLeft;
        std::string edgeType;
    };
 
 
    class LaneAttrs final : public Parameterised {
    public:
        double maxSpeed;
        double friction;
        PositionVector shape;
        std::vector<Connection> connections;
        std::string allow;
        std::string disallow;
        std::string changeLeft;
        std::string changeRight;
        double width;
        double endOffset;
        StopOffset laneStopOffset;
        bool accelRamp;
        std::string oppositeID;
        bool customShape;
        std::string type;
    };
 
 
    class EdgeAttrs final : public Parameterised {
    public:
        std::string id;
        std::string streetName;
        std::string type;
        SumoXMLEdgeFunc func;
        std::string fromNode;
        std::string toNode;
        PositionVector shape;
        double length;
        int priority;
        double maxSpeed;
        //double friction;
        std::vector<LaneAttrs*> lanes;
        NBEdge* builtEdge;
        LaneSpreadFunction lsf;
        StopOffset edgeStopOffset;
        double distance;
        std::string bidi;
    };
 
 
    struct Prohibition {
        std::string prohibitorFrom;
        std::string prohibitorTo;
        std::string prohibitedFrom;
        std::string prohibitedTo;
    };
 
    struct Crossing : public Parameterised {
        Crossing(const std::string& _edgeID) :
            edgeID(_edgeID), customTLIndex(-1), customTLIndex2(-1) {}
 
        std::string edgeID;
        std::vector<std::string> crossingEdges;
        double width;
        bool priority;
        PositionVector customShape;
        int customTLIndex;
        int customTLIndex2;
    };
 
    struct WalkingAreaParsedCustomShape {
        PositionVector shape;
        std::vector<std::string> fromEdges;
        std::vector<std::string> toEdges;
        std::vector<std::string> fromCrossed;
        std::vector<std::string> toCrossed;
        double width;
    };
 
    struct JunctionAttrs {
        NBNode* node;
        // @the list of internal lanes corresponding to each link
        std::vector<std::string> intLanes;
        // @brief the complete response definition for all links
        std::vector<std::string> response;
    };
 
    std::map<std::string, EdgeAttrs*> myEdges;
 
    std::vector<Prohibition> myProhibitions;
 
    NBNetBuilder& myNetBuilder;
 
    NBNodeCont& myNodeCont;
 
    NBTrafficLightLogicCont& myTLLCont;
 
    NIXMLTypesHandler myTypesHandler;
 
    EdgeAttrs* myCurrentEdge;
 
    JunctionAttrs myCurrentJunction;
 
    LaneAttrs* myCurrentLane;
 
    NBLoadedSUMOTLDef* myCurrentTL;
 
    GeoConvHelper* myLocation;
 
    std::map<std::string, std::vector<Crossing> > myPedestrianCrossings;
 
    std::map<std::string, WalkingAreaParsedCustomShape> myWACustomShapes;
 
    std::vector<Parameterised*> myLastParameterised;
 
    MMVersion myNetworkVersion;
 
    bool myHaveSeenInternalEdge;
 
    bool myAmLefthand;
 
    bool myChangeLefthand;
 
    int myCornerDetail;
 
    int myLinkDetail;
 
    bool myRectLaneCut;
 
    bool myWalkingAreas;
 
    double myLimitTurnSpeed;
 
    bool myCheckLaneFoesAll;
    bool myCheckLaneFoesRoundabout;
    bool myTlsIgnoreInternalJunctionJam;
    std::string myDefaultSpreadType;
    bool myGeomAvoidOverlap;
    bool myJunctionsHigherSpeed;
    double myInternalJunctionsVehicleWidth;
    bool myJunctionsMinimalShape;
    bool myJunctionsEndpointShape;
 
    std::vector<std::vector<std::string> > myRoundabouts;
 
    std::set<std::string> myRailSignals;
 
    std::set<std::string> myDiscardableParams;
 
private:
 
    static Position readPosition(const SUMOSAXAttributes& attrs, const std::string& id, bool& ok);
 
    void parseProhibitionConnection(const std::string& attr, std::string& from, std::string& to, bool& ok);
};