GNEAttributeCarrier.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2025 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 Base class for gui objects which carry attributes
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netedit/GNEReferenceCounter.h>
#include <utils/foxtools/fxheader.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GNEHierarchicalElement;
class GNELane;
class GNEMoveElement;
class GNENet;
class GNETagProperties;
class GNEUndoList;
class GUIGlObject;
class Parameterised;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEAttributeCarrier : public GNEReferenceCounter {
 
    friend class GNEChange_Attribute;
    friend class GNEChange_ToggleAttribute;
    friend class GNEAttributesEditorType;
 
public:
    GNEAttributeCarrier(const SumoXMLTag tag, GNENet* net, const std::string& filename, const bool isTemplate);
 
    virtual ~GNEAttributeCarrier();
 
 
    virtual GNEHierarchicalElement* getHierarchicalElement() = 0;
 
    virtual GNEMoveElement* getMoveElement() const = 0;
 
    virtual Parameterised* getParameters() = 0;
 
    virtual const Parameterised* getParameters() const = 0;
 
    virtual GUIGlObject* getGUIGlObject() = 0;
 
    virtual const GUIGlObject* getGUIGlObject() const = 0;
 
 
    const std::string getID() const;
 
    GNENet* getNet() const;
 
    const std::string& getFilename() const;
 
    void changeDefaultFilename(const std::string& file);
 
    void selectAttributeCarrier();
 
    void unselectAttributeCarrier();
 
    bool isAttributeCarrierSelected() const;
 
    virtual void updateGeometry() = 0;
 
 
    bool drawUsingSelectColor() const;
 
    bool drawMovingGeometryPoints() const;
 
 
 
    void markForDrawingFront();
 
    void unmarkForDrawingFront();
 
    bool isMarkedForDrawingFront() const;
 
    void drawInLayer(const double typeOrLayer, const double extraOffset = 0) const;
 
 
 
    void setInGrid(bool value);
 
    bool inGrid() const;
 
 
 
    bool checkDrawInspectContour() const;
 
    bool checkDrawFrontContour() const;
 
    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 checkDrawDeleteContourSmall() const = 0;
 
    virtual bool checkDrawSelectContour() const = 0;
 
    virtual bool checkDrawMoveContour() const = 0;
 
 
    void resetDefaultValues(const bool allowUndoRedo);
 
 
    /* @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
     * @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
     * @param[in] key The attribute key
     * @return position with the value associated to key
     */
    virtual Position getAttributePosition(SumoXMLAttr key) const = 0;
 
    /* @brief method for getting the Attribute of an XML key in positionVector format
     * @param[in] key The attribute key
     * @return positionVector 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 check if new value for certain attribute is valid
     * @param[in] key The attribute key
     * @param[in] value The new value
     */
    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
     */
    virtual 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
     */
    virtual 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;
 
    /* @brief method for check if the value for certain attribute is computed (for example, due a network recomputing)
     * @param[in] key The attribute key
     */
    virtual bool isAttributeComputed(SumoXMLAttr key) const;
 
    /* @brief method for check if the value for certain attribute is set
     * @param[in] key The attribute key
     */
    bool hasAttribute(SumoXMLAttr key) const;
 
    virtual std::string getPopUpID() const = 0;
 
    virtual std::string getHierarchyName() const = 0;
 
 
 
    void setACParameters(const std::vector<std::pair<std::string, std::string> >& parameters);
 
    void setACParameters(const std::vector<std::pair<std::string, std::string> >& parameters, GNEUndoList* undoList);
 
    void setACParameters(const Parameterised::Map& parameters, GNEUndoList* undoList);
 
 
    /* @brief method for return an alternative value for disabled attributes. Used only in GNEFrames
     * @param[in] key The attribute key
     */
    std::string getAlternativeValueForDisabledAttributes(SumoXMLAttr key) const;
 
    virtual std::string getAttributeForSelection(SumoXMLAttr key) const;
 
    const std::string& getTagStr() const;
 
    FXIcon* getACIcon() const;
 
    bool isTemplate() const;
 
    const GNETagProperties* getTagProperty() const;
 
 
    template<typename T>
    static bool canParse(const std::string& string);
 
    template<typename T>
    static T parse(const std::string& string);
 
    template<typename T>
    static bool canParse(const GNENet* net, const std::string& value, const bool checkConsecutivity);
 
    template<typename T>
    static T parse(const GNENet* net, const std::string& value);
 
    template<typename T>
    static std::string parseIDs(const std::vector<T>& ACs);
 
 
    /* @brief method for getting the common attribute of an XML key
     * @param[in] key The attribute key
     * @return string with the value associated to key
     */
    std::string getCommonAttribute(SumoXMLAttr key) const;
 
    /* @brief method for getting the common attribute of an XML key in double format
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    double getCommonAttributeDouble(SumoXMLAttr key) const;
 
    /* @brief method for getting the common attribute of an XML key in position format
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    Position getCommonAttributePosition(SumoXMLAttr key) const;
 
    /* @brief method for getting the common attribute of an XML key in positionVector format
     * @param[in] key The attribute key
     * @return double with the value associated to key
     */
    PositionVector getCommonAttributePositionVector(SumoXMLAttr key) const;
 
    /* @brief method for setting the common 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 setCommonAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
 
    /* @brief method for check if new value for certain common attribute is valid
     * @param[in] key The attribute key
     * @param[in] value The new value
     */
    bool isCommonAttributeValid(SumoXMLAttr key, const std::string& value) const;
 
    void setCommonAttribute(SumoXMLAttr key, const std::string& value);
 
 
 
    static const std::string FEATURE_LOADED;
 
    static const std::string FEATURE_GUESSED;
 
    static const std::string FEATURE_MODIFIED;
 
    static const std::string FEATURE_APPROVED;
 
 
    static const std::string TRUE_STR;
 
    static const std::string FALSE_STR;
 
protected:
    const GNETagProperties* myTagProperty;
 
    GNENet* myNet = nullptr;
 
    bool mySelected = false;
 
    bool myDrawInFront = false;
 
    bool myInGrid = false;
 
    std::string myFilename;
 
    bool myCenterAfterCreation = true;
 
    const bool myIsTemplate = false;
 
    virtual void toggleAttribute(SumoXMLAttr key, const bool value);
 
private:
    virtual void setAttribute(SumoXMLAttr key, const std::string& value) = 0;
 
    GNEAttributeCarrier(const GNEAttributeCarrier&) = delete;
 
    GNEAttributeCarrier& operator=(const GNEAttributeCarrier& src) = delete;
};