GNEDataSet.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
/****************************************************************************/
// A abstract class for data elements
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netedit/elements/GNEAttributeCarrier.h>
#include <netedit/elements/GNEHierarchicalElement.h>
#include <utils/common/Parameterised.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GNENet;
class GNEDataInterval;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEDataSet : public GNEAttributeCarrier, public GNEHierarchicalElement {
 
public:
    class AttributeColors {
 
    public:
        AttributeColors();
 
        void updateValues(const std::string& attribute, const double value);
 
        void updateAllValues(const AttributeColors& attributeColors);
 
        bool exist(const std::string& attribute) const;
 
        double getMinValue(const std::string& attribute) const;
 
        double getMaxValue(const std::string& attribute) const;
 
        void clear();
 
    private:
        std::map<std::string, std::pair<double, double> > myMinMaxValue;
 
        AttributeColors& operator=(const AttributeColors&) = delete;
    };
 
    GNEDataSet(GNENet* net);
 
    GNEDataSet(const std::string& dataSetID, GNENet* net, FileBucket* fileBucket);
 
    ~GNEDataSet();
 
 
    GNEHierarchicalElement* getHierarchicalElement() override;
 
    GNEMoveElement* getMoveElement() const override;
 
    Parameterised* getParameters() override;
 
    const Parameterised* getParameters() const override;
 
    GUIGlObject* getGUIGlObject() override;
 
    const GUIGlObject* getGUIGlObject() const override;
 
 
    FileBucket* getFileBucket() const override;
 
    void updateAttributeColors();
 
    const GNEDataSet::AttributeColors& getAllAttributeColors() const;
 
    const std::map<SumoXMLTag, GNEDataSet::AttributeColors>& getSpecificAttributeColors() const;
 
    void updateGeometry() override;
 
    Position getPositionInView() const;
 
    void writeDataSet(OutputDevice& device) const;
 
 
    bool checkDrawFromContour() const override;
 
    bool checkDrawToContour() const override;
 
    bool checkDrawRelatedContour() const override;
 
    bool checkDrawOverContour() const override;
 
    bool checkDrawDeleteContour() const override;
 
    bool checkDrawDeleteContourSmall() const override;
 
    bool checkDrawSelectContour() const override;
 
    bool checkDrawMoveContour() const override;
 
 
 
    void addDataIntervalChild(GNEDataInterval* dataInterval);
 
    void removeDataIntervalChild(GNEDataInterval* dataInterval);
 
    bool dataIntervalChildrenExist(GNEDataInterval* dataInterval) const;
 
    void updateDataIntervalBegin(const double oldBegin);
 
    bool checkNewInterval(const double newBegin, const double newEnd);
 
    bool checkNewBeginEnd(const GNEDataInterval* dataInterval, const double newBegin, const double newEnd);
 
    GNEDataInterval* retrieveInterval(const double begin, const double end) const;
 
    const std::map<const double, GNEDataInterval*>& getDataIntervalChildren() 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
     */
    std::string getAttribute(SumoXMLAttr key) const override;
 
    /* @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
     */
    double getAttributeDouble(SumoXMLAttr key) const override;
 
    /* @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
     */
    Position getAttributePosition(SumoXMLAttr key) const override;
 
    /* @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
     */
    PositionVector getAttributePositionVector(SumoXMLAttr key) const override;
 
    void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) override;
 
    bool isValid(SumoXMLAttr key, const std::string& value) override;
 
    std::string getPopUpID() const override;
 
    std::string getHierarchyName() const override;
 
protected:
    std::string myDataSetID;
 
    std::map<const double, GNEDataInterval*> myDataIntervalChildren;
 
    GNEDataSet::AttributeColors myAllAttributeColors;
 
    std::map<SumoXMLTag, GNEDataSet::AttributeColors> mySpecificAttributeColors;
 
private:
    void setAttribute(SumoXMLAttr key, const std::string& value) override;
 
    static bool checkNewInterval(const std::map<const double, GNEDataInterval*>& dataIntervalMap, const double newBegin, const double newEnd);
 
    GNEDataSet(const GNEDataSet&) = delete;
 
    GNEDataSet& operator=(const GNEDataSet&) = delete;
};
 
/****************************************************************************/