GNEEdge.h

Go to the documentation of this file.

/****************************************************************************/
// A road/street connecting two junctions (netedit-version, adapted from GUIEdge)
// Basically a container for an NBEdge with drawing and editing capabilities
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2001-2017 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef GNEEdge_h
#define GNEEdge_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include "GNENetElement.h"

// ===========================================================================
// class declarations
// ===========================================================================
class GNENet;
class GNEJunction;
class GNELane;
class GNEConnection;
class GNEAdditional;
class GNERouteProbe;
class GNEVaporizer;
class GNERerouter;
class GNECrossing;

// ===========================================================================
// class definitions
// ===========================================================================
class GNEEdge : public GNENetElement {

    friend class GNEChange_Lane;
    friend class GNEChange_Connection;

public:
    typedef std::vector<GNELane*> LaneVector;

    typedef std::vector<GNEConnection*> ConnectionVector;

    typedef std::vector<GNEAdditional*> AdditionalVector;

    GNEEdge(NBEdge& nbe, GNENet* net, bool wasSplit = false, bool loaded = false);

    ~GNEEdge();

    void updateGeometry();

    void commitGeometryMoving(const PositionVector& oldShape, double minDistToEnd, GNEUndoList* undoList);

    Boundary getBoundary() const;


    virtual GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent);

    virtual GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent);

    Boundary getCenteringBoundary() const;

    void drawGL(const GUIVisualizationSettings& s) const;

    void updateJunctionPosition(GNEJunction* junction, const Position& origPos);

    NBEdge* getNBEdge();

    GNEJunction* getGNEJunctionSource() const;

    GNEJunction* getGNEJunctionDestiny() const;

    Position moveGeometry(const Position& oldPos, const Position& newPos, bool relative = false);

    static bool changeGeometry(PositionVector& geom, const std::string& id, const Position& oldPos, const Position& newPos, bool relative = false, bool moveEndPoints = false);

    void moveGeometry(const Position& delta);

    bool deleteGeometry(const Position& pos, GNEUndoList* undoList);

    void setEndpoint(Position pos, GNEUndoList* undoList);

    void resetEndpoint(const Position& pos, GNEUndoList* undoList);

    /* @brief method for getting the Attribute of an XML key
     * @param[in] key The attribute key
     * @return string with the value associated to key
     */
    std::string getAttribute(SumoXMLAttr key) const;
    std::string getAttributeForSelection(SumoXMLAttr key) const;

    /* @brief method for setting the attribute and letting the object perform additional changes
     * @param[in] key The attribute key
     * @param[in] value The new value
     * @param[in] undoList The undoList on which to register changes
     */
    void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);

    /* @brief method for setting the attribute and letting the object perform additional changes
     * @param[in] key The attribute key
     * @param[in] value The new value
     * @param[in] undoList The undoList on which to register changes
     */
    bool isValid(SumoXMLAttr key, const std::string& value);

    void setResponsible(bool newVal);

    void setGeometry(PositionVector geom, bool inner);

    void remakeGNEConnections();

    void copyTemplate(GNEEdge* tpl, GNEUndoList* undolist);

    std::set<GUIGlID> getLaneGlIDs();

    const std::vector<GNELane*>& getLanes();

    const std::vector<GNEConnection*>& getGNEConnections();

    GNEConnection* retrieveGNEConnection(int fromLane, NBEdge* to, int toLane, bool createIfNoExist = true);

    bool wasSplit();

    /* @brief compute a splitting position which keeps the resulting edges
     * straight unless the user clicked near a geometry point */
    Position getSplitPos(const Position& clickPos);

    void setMicrosimID(const std::string& newID);

    void addAdditionalChild(GNEAdditional* additional);

    void removeAdditionalChild(GNEAdditional* additional);

    const std::vector<GNEAdditional*>& getAdditionalChilds() const;

    void addGNERerouter(GNERerouter* rerouter);

    void removeGNERerouter(GNERerouter* rerouter);

    const std::vector<GNERerouter*>& getGNERerouters() const;

    int getNumberOfGNERerouters() const;

    bool hasRestrictedLane(SUMOVehicleClass vclass) const;

    // the radius in which to register clicks for geometry nodes
    static const double SNAP_RADIUS;

    void clearGNEConnections();

    int getRouteProbeRelativePosition(GNERouteProbe* routeProbe) const;

    int getVaporizerRelativePosition(GNEVaporizer* vaporizer) const;

    std::vector<GNECrossing*> getGNECrossings();

protected:
    NBEdge& myNBEdge;

    GNEJunction* myGNEJunctionSource;

    GNEJunction* myGNEJunctionDestiny;

    PositionVector myOrigShape;

    LaneVector myLanes;

    ConnectionVector myGNEConnections;

    bool myAmResponsible;

    bool myWasSplit;

    std::string myConnectionStatus;

    AdditionalVector myAdditionals;

    std::vector<GNERerouter*> myReroutes;

private:
    void setAttribute(SumoXMLAttr key, const std::string& value);

    GNEEdge(const GNEEdge& s);

    GNEEdge& operator=(const GNEEdge& s);

    void setNumLanes(int numLanes, GNEUndoList* undoList);

    void addLane(GNELane* lane, const NBEdge::Lane& laneAttrs);

    void removeLane(GNELane* lane);

    void addConnection(NBEdge::Connection nbCon, bool selectAfterCreation = false);

    void removeConnection(NBEdge::Connection nbCon);

    void removeEdgeFromCrossings(GNEJunction* junction, GNEUndoList* undoList);
};


#endif

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