GNEGenericData.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 data sets
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netbuild/NBEdge.h>
#include <netbuild/NBVehicle.h>
#include <netedit/elements/GNEHierarchicalElement.h>
#include <netedit/elements/GNEPathElement.h>
#include <utils/common/Parameterised.h>
#include <utils/geom/PositionVector.h>
#include <utils/gui/div/GUIGeometry.h>
#include <utils/gui/globjects/GUIGlObject.h>
#include <utils/router/SUMOAbstractRouter.h>
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GNEViewNet;
class GNEDataInterval;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class GNEGenericData : public GNEPathElement, public Parameterised, public GNEHierarchicalElement {
 
public:
    GNEGenericData(const SumoXMLTag tag, FXIcon* icon, const GUIGlObjectType type, GNEDataInterval* dataIntervalParent,
                   const Parameterised::Map& parameters,
                   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 ~GNEGenericData();
 
    virtual bool isGenericDataVisible() const = 0;
 
    GUIGlObject* getGUIGlObject();
 
    const GUIGlObject* getGUIGlObject() const;
 
    GNEDataInterval* getDataIntervalParent() const;
 
    // @brief draw attribute
    void drawAttribute(const PositionVector& shape) const;
 
    virtual void updateGeometry() = 0;
 
    virtual Position getPositionInView() const = 0;
 
 
    bool checkDrawFromContour() const;
 
    bool checkDrawToContour() const;
 
    bool checkDrawRelatedContour() const;
 
    bool checkDrawOverContour() const;
 
    bool checkDrawDeleteContour() const;
 
    bool checkDrawSelectContour() const;
 
    bool checkDrawMoveContour() const;
 
 
 
    virtual void writeGenericData(OutputDevice& device) const = 0;
 
    virtual bool isGenericDataValid() const;
 
    virtual std::string getGenericDataProblem() const;
 
    virtual void fixGenericDataProblem();
 
 
    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    virtual void drawGL(const GUIVisualizationSettings& s) const = 0;
 
    void deleteGLObject();
 
    void selectGLObject();
 
    void updateGLObject();
 
    virtual Boundary getCenteringBoundary() const = 0;
 
 
 
    virtual void computePathElement() = 0;
 
    bool isPathElementSelected() const;
 
    virtual void drawLanePartialGL(const GUIVisualizationSettings& s, const GNESegment* segment, const double offsetFront) const = 0;
 
    virtual void drawJunctionPartialGL(const GUIVisualizationSettings& s, const GNESegment* segment, const double offsetFront) const = 0;
 
    virtual GNELane* getFirstPathLane() const = 0;
 
    virtual GNELane* getLastPathLane() 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;
 
    virtual void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList) = 0;
 
    virtual bool isValid(SumoXMLAttr key, const std::string& value) = 0;
 
    virtual std::string getPopUpID() const = 0;
 
    virtual std::string getHierarchyName() const = 0;
 
    const Parameterised::Map& getACParametersMap() const;
 
protected:
    GNEDataInterval* myDataIntervalParent;
 
    void drawFilteredAttribute(const GUIVisualizationSettings& s, const PositionVector& laneShape, const std::string& attribute, const GNEDataInterval* dataIntervalParent) const;
 
    bool isVisibleInspectDeleteSelect() const;
 
    void replaceFirstParentEdge(const std::string& value);
 
    void replaceLastParentEdge(const std::string& value);
 
    void replaceParentTAZElement(const int index, const std::string& value);
 
    std::string getPartialID() const;
 
private:
    virtual void setAttribute(SumoXMLAttr key, const std::string& value) = 0;
 
    GNEGenericData(const GNEGenericData&) = delete;
 
    GNEGenericData& operator=(const GNEGenericData&) = delete;
};
 
/****************************************************************************/