GNENetElement.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
/****************************************************************************/
// A abstract class for net elements
/****************************************************************************/
#ifndef GNENetElement_h
#define GNENetElement_h


// ===========================================================================
// included modules
// ===========================================================================
#include <config.h>

#include <string>
#include <utility>
#include <vector>
#include <netbuild/NBConnection.h>
#include <netbuild/NBEdge.h>
#include <netbuild/NBNode.h>
#include <utils/geom/Boundary.h>
#include <utils/geom/Position.h>
#include <utils/gui/globjects/GLIncludes.h>
#include <utils/gui/globjects/GUIGlObject.h>
#include <utils/gui/globjects/GUIGlObjectStorage.h>
#include <utils/gui/globjects/GUIPointOfInterest.h>
#include <utils/gui/globjects/GUIPolygon.h>
#include <utils/gui/settings/GUIPropertySchemeStorage.h>
#include <utils/xml/SUMOSAXHandler.h>
#include <utils/xml/SUMOXMLDefinitions.h>
#include <netedit/GNEAttributeCarrier.h>

// ===========================================================================
// class declarations
// ===========================================================================

class GNEAdditional;

// ===========================================================================
// class definitions
// ===========================================================================

class GNENetElement : public GUIGlObject, public GNEAttributeCarrier {

public:
    GNENetElement(GNENet* net, const std::string& id, GUIGlObjectType type, SumoXMLTag tag);

    ~GNENetElement();

    virtual void updateGeometry(bool updateGrid) = 0;

    GNENet* getNet() const;

    void addAdditionalParent(GNEAdditional* additional);

    void removeAdditionalParent(GNEAdditional* additional);

    void addAdditionalChild(GNEAdditional* additional);

    void removeAdditionalChild(GNEAdditional* additional);

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

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


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

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

    virtual Boundary getCenteringBoundary() const = 0;

    virtual void drawGL(const GUIVisualizationSettings& s) const = 0;


    void selectAttributeCarrier(bool changeFlag = true);

    void unselectAttributeCarrier(bool changeFlag = true);

    bool isAttributeCarrierSelected() 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 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 asociated 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;


    virtual bool addGenericParameter(const std::string& key, const std::string& value) = 0;

    virtual bool removeGenericParameter(const std::string& key) = 0;

    virtual bool updateGenericParameter(const std::string& oldKey, const std::string& newKey) = 0;

    virtual bool updateGenericParameterValue(const std::string& key, const std::string& newValue) = 0;

    virtual std::string getGenericParametersStr() const = 0;

    virtual std::vector<std::pair<std::string, std::string> > getGenericParameters() const = 0;

    virtual void setGenericParametersStr(const std::string& value) = 0;


protected:
    GNENet* myNet;

    Boundary myMovingGeometryBoundary;

    std::vector<GNEAdditional*> myFirstAdditionalParents;

    std::vector<GNEAdditional*> myAdditionalChilds;

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

    virtual void mouseOverObject(const GUIVisualizationSettings& s) const = 0;

    GNENetElement(const GNENetElement&) = delete;

    GNENetElement& operator=(const GNENetElement&) = delete;
};


#endif

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