NIImporter_OpenStreetMap.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2018 German Aerospace Center (DLR) and others.
// This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v2.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v20.html
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// Importer for networks stored in OpenStreetMap format
/****************************************************************************/
#ifndef NIImporter_OpenStreetMap_h
#define NIImporter_OpenStreetMap_h


// ===========================================================================
// included modules
// ===========================================================================
#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:
    struct NIOSMNode {
        NIOSMNode(long long int _id, double _lon, double _lat)
            :
            id(_id), lon(_lon), lat(_lat), ele(0),
            tlsControlled(false),
            railwayCrossing(false),
            railwaySignal(false),
            railwayBufferStop(false),
            ptStopPosition(false), ptStopLength(0), name(""),
            permissions(SVC_RAIL | SVC_BUS | SVC_TRAM),
            node(0) { }

        const long long int id;
        const double lon;
        const double lat;
        double ele;
        bool tlsControlled;
        bool railwayCrossing;
        bool railwaySignal;
        bool railwayBufferStop;
        bool ptStopPosition;
        double ptStopLength;
        std::string name;
        SVCPermissions permissions;
        NBNode* node;

    private:
        NIOSMNode& operator=(const NIOSMNode& s) = delete;


    };

    enum WayType {
        WAY_NONE = 0,
        WAY_FORWARD = 1,
        WAY_BACKWARD = 2,
        WAY_BOTH = WAY_FORWARD | WAY_BACKWARD,
        WAY_UNKNOWN = 4
    };

    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
    };


    struct Edge : public Parameterised {

        explicit Edge(long long int _id)
            :
            id(_id), myNoLanes(-1), myNoLanesForward(0), myMaxSpeed(MAXSPEED_UNGIVEN),
            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
            myParkingType(PARKING_NONE), // parking areas exported optionally
            myLayer(0), // layer is non-zero only in conflict areas
            myCurrentIsRoad(false),
            myCurrentIsPlatform(false) { }


        const long long int id;
        std::string streetName;
        int myNoLanes;
        int myNoLanesForward;
        double myMaxSpeed;
        std::string myHighWayType;
        std::string myIsOneWay;
        WayType myCyclewayType;
        WayType myBuswayType;
        WayType mySidewalkType;
        int myParkingType;
        int myLayer;
        std::vector<long long int> myCurrentNodes;
        bool myCurrentIsRoad;
        bool myCurrentIsPlatform;

    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;

    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);

    void reconstructLayerElevation(double layerElevation, NBNetBuilder& nb);

    std::map<NBNode*, std::pair<double, double> >
    getNeighboringNodes(NBNode* node, double maxDist, const std::set<NBNode*>& knownElevation);

protected:
    static const double MAXSPEED_UNGIVEN;
    static const long long int INVALID_ID;

    friend class NodesHandler;
    class NodesHandler : public SUMOSAXHandler {
    public:
        NodesHandler(std::map<long long int, NIOSMNode*>& toFill, std::set<NIOSMNode*,
                     CompareNodes>& uniqueNodes,
                     const OptionsCont& cont);


        ~NodesHandler() override;


    protected:


        void myStartElement(int element, const SUMOSAXAttributes& attrs) override;


        void myEndElement(int element) override;


    private:

        std::map<long long int, NIOSMNode*>& myToFill;

        long long int myLastNodeID;

        bool myIsInValidNodeTag;

        int myHierarchyLevel;

        std::set<NIOSMNode*, CompareNodes>& myUniqueNodes;

        const bool myImportElevation;

        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);


        ~EdgesHandler() override;


    protected:


        void myStartElement(int element, const SUMOSAXAttributes& attrs) override;


        void myEndElement(int element) override;


    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;

        std::vector<int> myParentElements;

        std::map<std::string, double> mySpeedMap;

    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;

        std::vector<int> myParentElements;

        bool myIsRestriction;

        long long int myFromWay;

        long long int myToWay;

        long long int myViaNode;
        long long int myViaWay;


        const OptionsCont& myOptionsCont;

        enum RestrictionType {
            RESTRICTION_ONLY,
            RESTRICTION_NO,
            RESTRICTION_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;


        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;

        std::string myName;

        std::string myRef;

        int myInterval;

        std::string myNightService;
    };

};


#endif

/****************************************************************************/