GNENetworkElement.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 abstract class for network elements
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netedit/elements/GNEHierarchicalElement.h>
#include <utils/gui/div/GUIGeometry.h>
#include <utils/gui/globjects/GUIGlObject.h>
#include <utils/geom/PositionVector.h>
#include <netedit/elements/GNEContour.h>
#include <netedit/GNEMoveElement.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class GNEAdditional;
class GNEDemandElement;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNENetworkElement : public GUIGlObject, public GNEHierarchicalElement, public GNEMoveElement {
 
public:
    GNENetworkElement(GNENet* net, const std::string& id, GUIGlObjectType type, SumoXMLTag tag, FXIcon* icon,
                      const std::vector<GNEJunction*>& junctionParents,
                      const std::vector<GNEEdge*>& edgeParents,
                      const std::vector<GNELane*>& laneParents,
                      const std::vector<GNEAdditional*>& additionalParents,
                      const std::vector<GNEDemandElement*>& demandElementParents,
                      const std::vector<GNEGenericData*>& genericDataParents);
 
    virtual ~GNENetworkElement();
 
    virtual GNEMoveOperation* getMoveOperation() = 0;
 
    GUIGlObject* getGUIGlObject();
 
    const GUIGlObject* getGUIGlObject() const;
 
    virtual bool isNetworkElementValid() const;
 
    virtual std::string getNetworkElementProblem() const;
 
 
    virtual void updateGeometry() = 0;
 
    virtual Position getPositionInView() const = 0;
 
 
 
    virtual bool checkDrawFromContour() const = 0;
 
    virtual bool checkDrawToContour() const = 0;
 
    virtual bool checkDrawRelatedContour() const = 0;
 
    virtual bool checkDrawOverContour() const = 0;
 
    virtual bool checkDrawDeleteContour() const = 0;
 
    virtual bool checkDrawSelectContour() const = 0;
 
    virtual bool checkDrawMoveContour() const = 0;
 
 
 
    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    virtual GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent) = 0;
 
    virtual Boundary getCenteringBoundary() const = 0;
 
    virtual void updateCenteringBoundary(const bool updateGrid) = 0;
 
    virtual void drawGL(const GUIVisualizationSettings& s) const = 0;
 
    bool isGLObjectLocked() const;
 
    void markAsFrontElement();
 
    virtual void deleteGLObject() = 0;
 
    void selectGLObject();
 
    virtual const std::string getOptionalName() const;
 
 
    /* @brief method for getting the Attribute of an XML key
     * @param[in] key The attribute key
     * @return string with the value associated to key
     */
    virtual std::string getAttribute(SumoXMLAttr key) const = 0;
 
    /* @brief method for getting the Attribute of an XML key in Position format
     * @param[in] key The attribute key
     * @return position with the value associated to key
     */
    virtual PositionVector getAttributePositionVector(SumoXMLAttr key) const = 0;
 
    /* @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
     */
    virtual void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) = 0;
 
    /* @brief method for checking if the key and their conrrespond attribute are valids
     * @param[in] key The attribute key
     * @param[in] value The value associated to key key
     * @return true if the value is valid, false in other case
     */
    virtual bool isValid(SumoXMLAttr key, const std::string& value) = 0;
 
    std::string getPopUpID() const;
 
    std::string getHierarchyName() const;
 
 
    void setShapeEdited(const bool value);
 
    bool isShapeEdited() const;
 
    int getGeometryPointUnderCursorShapeEdited() const;
 
    void simplifyShapeEdited(GNEUndoList* undoList);
 
    void straigthenShapeEdited(GNEUndoList* undoList);
 
    void closeShapeEdited(GNEUndoList* undoList);
 
    void openShapeEdited(GNEUndoList* undoList);
 
    void setFirstGeometryPointShapeEdited(const int index, GNEUndoList* undoList);
 
    void deleteGeometryPointShapeEdited(const int index, GNEUndoList* undoList);
 
    void resetShapeEdited(GNEUndoList* undoList);
 
 
    void setNetworkElementID(const std::string& newID);
 
    virtual const Parameterised::Map& getACParametersMap() const = 0;
 
protected:
    bool myShapeEdited;
 
    GNEContour myNetworkElementContour;
 
    // @brief check if we're drawing using a boundary but element was already selected
    bool checkDrawingBoundarySelection() const;
 
    GUIGLObjectPopupMenu* getShapeEditedPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent, const PositionVector& shape);
 
    int getVertexIndex(const PositionVector& shape, const Position& pos);
 
private:
    virtual void setAttribute(SumoXMLAttr key, const std::string& value) = 0;
 
    GNENetworkElement(const GNENetworkElement&) = delete;
 
    GNENetworkElement& operator=(const GNENetworkElement&) = delete;
};