GNETAZElement.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2022 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
/****************************************************************************/
// Abstract class for TAZElements uses in netedit
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netedit/elements/GNEHierarchicalElement.h>
#include <utils/gui/div/GUIGeometry.h>
#include <utils/common/Parameterised.h>
#include <utils/geom/PositionVector.h>
#include <utils/gui/globjects/GUIGlObject.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GNEViewNet;
class GNENetworkElement;
class GUIGLObjectPopupMenu;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNETAZElement : public GUIGlObject, public GNEHierarchicalElement, public Parameterised {
 
public:
    GNETAZElement(const std::string& id, GNENet* net, GUIGlObjectType type, SumoXMLTag tag,
                  const std::vector<GNEJunction*>& junctionParents,
                  const std::vector<GNEEdge*>& edgeParents,
                  const std::vector<GNELane*>& laneParents,
                  const std::vector<GNEAdditional*>& additionalParents,
                  const std::vector<GNETAZElement*>& TAZElementParents,
                  const std::vector<GNEDemandElement*>& demandElementParents,
                  const std::vector<GNEGenericData*>& genericDataParents,
                  const std::map<std::string, std::string>& parameters);
 
    GNETAZElement(GNETAZElement* TAZElementParent, GNENet* net, GUIGlObjectType type, SumoXMLTag tag,
                  const std::vector<GNEJunction*>& junctionParents,
                  const std::vector<GNEEdge*>& edgeParents,
                  const std::vector<GNELane*>& laneParents,
                  const std::vector<GNEAdditional*>& additionalParents,
                  const std::vector<GNETAZElement*>& TAZElementParents,
                  const std::vector<GNEDemandElement*>& demandElementParents,
                  const std::vector<GNEGenericData*>& genericDataParents,
                  const std::map<std::string, std::string>& parameters);
 
    virtual ~GNETAZElement();
 
    const std::string& getID() const;
 
    GUIGlObject* getGUIGlObject();
 
    std::string generateChildID(SumoXMLTag childTag);
 
    virtual const PositionVector& getTAZElementShape() const = 0;
 
    virtual void writeTAZElement(OutputDevice& device) const = 0;
 
 
    virtual void updateGeometry() = 0;
 
    virtual Position getPositionInView() const = 0;
 
    virtual double getExaggeration(const GUIVisualizationSettings& s) const = 0;
 
    virtual Boundary getCenteringBoundary() const = 0;
 
 
    virtual GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent) = 0;
 
    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    virtual void drawGL(const GUIVisualizationSettings& s) const = 0;
 
    /* @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 double format (to avoid unnecessary parse<double>(...) for certain attributes)
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    virtual double getAttributeDouble(SumoXMLAttr key) const = 0;
 
    /* @brief method for getting the Attribute of an XML key in position format (to avoid unnecessary parse<position>(...) for certain attributes)
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    virtual Position getAttributePosition(SumoXMLAttr key) const = 0;
 
    virtual void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) = 0;
 
    virtual bool isValid(SumoXMLAttr key, const std::string& value) = 0;
 
    /* @brief method for enable attribute
     * @param[in] key The attribute key
     * @param[in] undoList The undoList on which to register changes
     * @note certain attributes can be only enabled, and can produce the disabling of other attributes
     */
    void enableAttribute(SumoXMLAttr key, GNEUndoList* undoList);
 
    /* @brief method for disable attribute
     * @param[in] key The attribute key
     * @param[in] undoList The undoList on which to register changes
     * @note certain attributes can be only enabled, and can produce the disabling of other attributes
     */
    void disableAttribute(SumoXMLAttr key, GNEUndoList* undoList);
 
    /* @brief method for check if the value for certain attribute is set
     * @param[in] key The attribute key
     */
    virtual bool isAttributeEnabled(SumoXMLAttr key) const = 0;
 
    /* @brief method for check if the value for certain attribute is computed (for example, due a network recomputing)
     * @param[in] key The attribute key
     */
    bool isAttributeComputed(SumoXMLAttr key) const;
 
    virtual std::string getPopUpID() const = 0;
 
    virtual std::string getHierarchyName() const = 0;
 
    const std::map<std::string, std::string>& getACParametersMap() const;
 
private:
    virtual bool checkChildTAZElementRestriction() const;
 
    virtual void setAttribute(SumoXMLAttr key, const std::string& value) = 0;
 
    void toogleAttribute(SumoXMLAttr key, const bool value);
 
    GNETAZElement(const GNETAZElement&) = delete;
 
    GNETAZElement& operator=(const GNETAZElement&) = delete;
};