NIImporter_OpenStreetMap.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-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
/****************************************************************************/
// Importer for networks stored in OpenStreetMap format
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <map>
#include <utils/xml/SUMOSAXHandler.h>
#include <utils/common/UtilExceptions.h>
#include <utils/common/Parameterised.h>
#include <netbuild/NBPTPlatform.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class NBEdge;
class NBEdgeCont;
class NBNetBuilder;
class NBNode;
class NBNodeCont;
class NBTrafficLightLogicCont;
class NBTypeCont;
class OptionsCont;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class NIImporter_OpenStreetMap {
public:
    static void loadNetwork(const OptionsCont& oc, NBNetBuilder& nb);
 
protected:
 
    enum WayType {
        WAY_NONE = 0,
        // technically possible
        WAY_FORWARD = 1,
        WAY_BACKWARD = 2,
        WAY_BOTH = WAY_FORWARD | WAY_BACKWARD,
        WAY_UNKNOWN = 4,
        // recommended for routing
        WAY_PREFER_FORWARD = 8,
        WAY_PREFER_BACKWARD = 16,
    };
 
    struct NIOSMNode : public Parameterised {
        NIOSMNode(long long int _id, double _lon, double _lat)
            :
            id(_id), lon(_lon), lat(_lat), ele(0.),
            tlsControlled(false),
            pedestrianCrossing(false),
            railwayCrossing(false),
            railwaySignal(false),
            railwayBufferStop(false),
            ptStopPosition(false), ptStopLength(0), name(""),
            permissions(SVC_IGNORING),
            positionMeters(std::numeric_limits<double>::max()),
            myRailDirection(WAY_UNKNOWN),
            node(nullptr) { }
 
        const long long int id;
        const double lon;
        const double lat;
        double ele;
        bool tlsControlled;
        bool pedestrianCrossing;
        bool railwayCrossing;
        bool railwaySignal;
        bool railwayBufferStop;
        bool ptStopPosition;
        double ptStopLength;
        std::string name;
        SVCPermissions permissions;
        std::string position;
        double positionMeters;
        WayType myRailDirection;
        NBNode* node;
 
    private:
        NIOSMNode& operator=(const NIOSMNode& s) = delete;
 
 
    };
 
public:
    static SUMOVehicleClass interpretTransportType(const std::string& type, NIOSMNode* toSet = nullptr);
 
protected:
 
 
    enum ParkingType {
        PARKING_NONE = 0,
        PARKING_LEFT = 1,
        PARKING_RIGHT = 2,
        PARKING_BOTH = WAY_FORWARD | WAY_BACKWARD,
        PARKING_UNKNOWN = 4,
        PARKING_FORBIDDEN = 8,
        PARKING_PERPENDICULAR = 16,
        PARKING_DIAGONAL = 32
    };
 
    enum ChangeType {
        CHANGE_YES = 0,
        CHANGE_NO_LEFT = 1,
        CHANGE_NO_RIGHT = 2,
        CHANGE_NO = 3
    };
 
    enum class PlacementType {
        NONE = 0,
        LEFT_OF = 1,
        RIGHT_OF = 2,
        MIDDLE_OF = 3
    };
 
    class Edge : public Parameterised {
    public:
        explicit Edge(long long int _id) :
            id(_id), myNoLanes(-1), myNoLanesForward(0),
            myMaxSpeed(MAXSPEED_UNGIVEN),
            myMaxSpeedBackward(MAXSPEED_UNGIVEN),
            myExtraAllowed(0),
            myExtraDisallowed(0),
            myCyclewayType(WAY_UNKNOWN), // building of extra lane depends on bikelaneWidth of loaded typemap
            myBuswayType(WAY_NONE), // buslanes are always built when declared
            mySidewalkType(WAY_UNKNOWN), // building of extra lanes depends on sidewalkWidth of loaded typemap
            myRailDirection(WAY_UNKNOWN), // store direction(s) of railway usage
            myParkingType(PARKING_NONE), // parking areas exported optionally
            myChangeForward(CHANGE_YES),
            myChangeBackward(CHANGE_YES),
            myLayer(0), // layer is non-zero only in conflict areas
            myCurrentIsRoad(false),
            myAmInRoundabout(false),
            myPlacement(PlacementType::NONE),
            myPlacementLane(-1),
            myWidth(-1)
        { }
 
        virtual ~Edge() {}
 
        const long long int id;
        std::string streetName;
        std::string ref;
        int myNoLanes;
        int myNoLanesForward;
        double myMaxSpeed;
        double myMaxSpeedBackward;
        SVCPermissions myExtraAllowed;
        SVCPermissions myExtraDisallowed;
        std::string myHighWayType;
        std::string myIsOneWay;
        WayType myCyclewayType;
        WayType myBuswayType;
        WayType mySidewalkType;
        int myRailDirection;
        int myParkingType;
        int myChangeForward;
        int myChangeBackward;
        std::vector<bool> myDesignatedLaneForward;
        std::vector<bool> myDesignatedLaneBackward;
        std::vector<SVCPermissions> myAllowedLaneForward;
        std::vector<SVCPermissions> myAllowedLaneBackward;
        std::vector<SVCPermissions> myDisallowedLaneForward;
        std::vector<SVCPermissions> myDisallowedLaneBackward;
        int myLayer;
        std::vector<long long int> myCurrentNodes;
        bool myCurrentIsRoad;
        bool myAmInRoundabout;
        std::map<std::string, std::string> myExtraTags;
        std::vector<int> myTurnSignsForward;
        std::vector<int> myTurnSignsBackward;
        PlacementType myPlacement;
        int myPlacementLane;
        std::vector<double> myWidthLanesForward;
        std::vector<double> myWidthLanesBackward;
        double myWidth;
 
    private:
        Edge& operator=(const Edge& s) = delete;
    };
 
 
    NIImporter_OpenStreetMap();
 
    ~NIImporter_OpenStreetMap();
 
    void load(const OptionsCont& oc, NBNetBuilder& nb);
 
private:
    class CompareNodes {
    public:
        bool operator()(const NIOSMNode* n1, const NIOSMNode* n2) const {
            return (n1->lat > n2->lat) || (n1->lat == n2->lat && n1->lon > n2->lon);
        }
    };
 
 
    static const std::string compoundTypeSeparator;
 
    class CompareEdges;
 
    std::map<long long int, NIOSMNode*> myOSMNodes;
 
    std::set<NIOSMNode*, CompareNodes> myUniqueNodes;
 
 
    std::map<long long int, Edge*> myEdges;
 
    std::map<long long int, Edge*> myPlatformShapes;
 
    std::set<std::string> myUnusableTypes;
 
    std::map<std::string, std::string> myKnownCompoundTypes;
 
    bool myImportLaneAccess;
 
    bool myImportSidewalks;
 
    bool myOnewayDualSidewalk;
 
    bool myImportBikeAccess;
 
    bool myImportCrossings;
 
    bool myImportTurnSigns;
 
    bool myAnnotateDefaults;
 
    int myPlacementSkippedNonExplicitOneWay = 0;
 
    int myPlacementSkippedAuxOppositeDirection = 0;
 
    static bool myAllAttributes;
 
    static std::set<std::string> myExtraAttributes;
 
    NBNode* insertNodeChecking(long long int id, NBNodeCont& nc, NBTrafficLightLogicCont& tlsc);
 
 
    int insertEdge(Edge* e, int index, NBNode* from, NBNode* to,
                   const std::vector<long long int>& passed, NBNetBuilder& nb,
                   const NBNode* first, const NBNode* last);
 
    void reconstructLayerElevation(double layerElevation, NBNetBuilder& nb);
 
    std::map<NBNode*, std::pair<double, double> >
    getNeighboringNodes(NBNode* node, double maxDist, const std::set<NBNode*>& knownElevation);
 
    std::string usableType(const std::string& type, const std::string& id, NBTypeCont& tc);
 
    void extendRailwayDistances(Edge* e, NBTypeCont& tc);
 
    static double interpretDistance(NIOSMNode* node);
 
protected:
    static const double MAXSPEED_UNGIVEN;
    static const long long int INVALID_ID;
 
    static void applyChangeProhibition(NBEdge* e, int changeProhibition);
    void applyLaneUse(NBEdge* e, NIImporter_OpenStreetMap::Edge* nie, const bool forward);
 
    static void mergeTurnSigns(std::vector<int>& signs, std::vector<int> signs2);
    void applyTurnSigns(NBEdge* e, const std::vector<int>& turnSigns);
 
    class NodesHandler : public SUMOSAXHandler {
    public:
        NodesHandler(std::map<long long int, NIOSMNode*>& toFill, std::set<NIOSMNode*,
                     CompareNodes>& uniqueNodes,
                     const OptionsCont& cont);
 
 
        ~NodesHandler() override;
 
        int getDuplicateNodes() const {
            return myDuplicateNodes;
        }
 
        void resetHierarchy() {
            myHierarchyLevel = 0;
        }
 
    protected:
 
 
        void myStartElement(int element, const SUMOSAXAttributes& attrs) override;
 
 
        void myEndElement(int element) override;
 
 
    private:
        std::map<long long int, NIOSMNode*>& myToFill;
 
        std::string myLastNodeID;
 
        NIOSMNode* myCurrentNode;
 
        bool myIsStation;
        std::string myRailwayRef;
 
        int myHierarchyLevel;
 
        std::set<NIOSMNode*, CompareNodes>& myUniqueNodes;
 
        const bool myImportElevation;
 
        StringVector myRailSignalRules;
 
        int myDuplicateNodes;
 
        const OptionsCont& myOptionsCont;
 
    private:
        NodesHandler(const NodesHandler& s);
 
        NodesHandler& operator=(const NodesHandler& s);
 
    };
 
 
    class EdgesHandler : public SUMOSAXHandler {
    public:
        EdgesHandler(const std::map<long long int, NIOSMNode*>& osmNodes,
                     std::map<long long int, Edge*>& toFill, std::map<long long int, Edge*>& platformShapes,
                     const NBTypeCont& tc);
 
 
        ~EdgesHandler() override;
 
 
    protected:
 
 
        void myStartElement(int element, const SUMOSAXAttributes& attrs) override;
 
 
        void myEndElement(int element) override;
 
        double interpretSpeed(const std::string& key, std::string value);
 
        int interpretChangeType(const std::string& value) const;
 
        void interpretLaneUse(const std::string& value, SUMOVehicleClass svc, const bool forward) const;
 
        bool interpretPlacement(const std::string& value, NIImporter_OpenStreetMap::PlacementType& placement, int& laneIndex) const;
 
        void addType(const std::string& singleTypeID);
 
 
    private:
        const std::map<long long int, NIOSMNode*>& myOSMNodes;
 
        std::map<long long int, Edge*>& myEdgeMap;
 
        std::map<long long int, Edge*>& myPlatformShapesMap;
 
        Edge* myCurrentEdge = nullptr;
 
        std::map<std::string, double> mySpeedMap;
 
        const NBTypeCont& myTypeCont;
 
    private:
        EdgesHandler(const EdgesHandler& s);
 
        EdgesHandler& operator=(const EdgesHandler& s);
 
    };
 
    class RelationHandler : public SUMOSAXHandler {
    public:
        RelationHandler(const std::map<long long int, NIOSMNode*>& osmNodes,
                        const std::map<long long int, Edge*>& osmEdges, NBPTStopCont* nbptStopCont,
                        const std::map<long long int, Edge*>& platfromShapes, NBPTLineCont* nbptLineCont,
                        const OptionsCont& oc);
 
 
        ~RelationHandler() override;
 
    protected:
 
 
        void myStartElement(int element, const SUMOSAXAttributes& attrs) override;
 
 
        void myEndElement(int element) override;
 
 
    private:
        const std::map<long long int, NIOSMNode*>& myOSMNodes;
 
        const std::map<long long int, Edge*>& myOSMEdges;
 
        const std::map<long long int, Edge*>& myPlatformShapes;
 
        NBPTStopCont* myNBPTStopCont;
 
        NBPTLineCont* myNBPTLineCont;
 
        long long int myCurrentRelation;
 
        bool myIsRestriction;
 
        SVCPermissions myRestrictionException;
 
        long long int myFromWay;
 
        long long int myToWay;
 
        long long int myViaNode;
        long long int myViaWay;
 
        long long int myStation;
 
        const OptionsCont& myOptionsCont;
 
        enum class RestrictionType {
            ONLY,
            NO,
            UNKNOWN
        };
        RestrictionType myRestrictionType;
 
        void resetValues();
 
        bool checkEdgeRef(long long int ref) const;
 
        bool applyRestriction() const;
 
        NBEdge* findEdgeRef(long long int wayRef, const std::vector<NBEdge*>& candidates) const;
 
    private:
        RelationHandler(const RelationHandler& s);
 
        RelationHandler& operator=(const RelationHandler& s);
 
        std::vector<long long int> myStops;
 
        std::set<long long int> myPlatformStops;
 
 
        struct NIIPTPlatform {
            long long int ref;
            bool isWay;
        };
 
        std::vector<NIIPTPlatform> myPlatforms;
 
        std::vector<long long int> myWays;
 
        bool myIsStopArea;
 
        bool myIsRoute;
 
        std::string myPTRouteType;
 
        RGBColor myRouteColor;
 
        std::string myName;
 
        std::string myRef;
 
        int myInterval;
 
        std::string myNightService;
 
        std::map<long long int, long long int > myStopAreas;
 
    };
 
};