GNEDemandElement.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 demand elements
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <netedit/GNEMoveElement.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/vehicle/SUMOVehicleParameter.h>
 
#include "GNEDemandElementDistribution.h"
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GNENet;
class GNEAdditional;
class GNEDemandElement;
class GNENetworkElement;
class GNEGenericData;
class GNEEdge;
class GNELane;
class GNEJunction;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEDemandElement : public GNEPathElement, public GNEHierarchicalElement, public GNEMoveElement, public GNEDemandElementDistribution {
 
public:
    friend class GNERouteHandler;
    friend class GNEDemandElementFlow;
    friend class GNEDemandElementPlan;
 
    enum class Problem {
        OK,                         // There is no problem
        INVALID_ELEMENT,            // Element is invalid (for example, a route without edges)
        INVALID_PATH,               // Path (route, trip... ) is not valid (i.e is empty)
        DISCONNECTED_PLAN,          // Plan element (person, containers) is not connected with the previous or next plan
        INVALID_STOPPOSITION,       // StopPosition is invalid (only used in stops over edges or lanes
        STOP_DOWNSTREAM,            // Stops don't follow their route parent
        REPEATEDROUTE_DISCONNECTED, // Repeated route is disconnected
        NO_PLANS                    // Person or container doesn't have a plan
    };
 
    GNEDemandElement(const std::string& id, GNENet* net, GUIGlObjectType type, SumoXMLTag tag, FXIcon* icon, const int pathOptions,
                     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);
 
    GNEDemandElement(GNEDemandElement* demandElementParent, GNENet* net, GUIGlObjectType type, SumoXMLTag tag, FXIcon* icon, const int pathOptions,
                     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 ~GNEDemandElement();
 
    virtual GNEMoveOperation* getMoveOperation() = 0;
 
    void removeGeometryPoint(const Position clickedPosition, GNEUndoList* undoList);
 
    GUIGlObject* getGUIGlObject();
 
    const GUIGlObject* getGUIGlObject() const;
 
    const GUIGeometry& getDemandElementGeometry();
 
    GNEDemandElement* getPreviousChildDemandElement(const GNEDemandElement* demandElement) const;
 
    GNEDemandElement* getNextChildDemandElement(const GNEDemandElement* demandElement) const;
 
    void updateDemandElementGeometry(const GNELane* lane, const double posOverLane);
 
    void updateDemandElementStackLabel(const int stack);
 
    void updateDemandElementSpreadGeometry(const GNELane* lane, const double posOverLane);
 
 
    virtual SUMOVehicleClass getVClass() const = 0;
 
    virtual const RGBColor& getColor() const = 0;
 
 
 
    virtual void writeDemandElement(OutputDevice& device) const = 0;
 
    virtual Problem isDemandElementValid() const = 0;
 
    virtual std::string getDemandElementProblem() const = 0;
 
    virtual void fixDemandElementProblem() = 0;
 
    virtual void openDemandElementDialog();
 
 
    virtual void updateGeometry() = 0;
 
    virtual Position getPositionInView() const = 0;
 
    virtual void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList) = 0;
 
    const GUIGeometry& getDemandElementGeometry() const;
 
 
 
    bool checkDrawFromContour() const;
 
    bool checkDrawToContour() const;
 
    bool checkDrawRelatedContour() const;
 
    bool checkDrawOverContour() const;
 
    bool checkDrawDeleteContour() const;
 
    bool checkDrawSelectContour() const;
 
    bool checkDrawMoveContour() const;
 
 
 
    virtual GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    virtual void drawGL(const GUIVisualizationSettings& s) const = 0;
 
    bool isGLObjectLocked() const;
 
    void markAsFrontElement();
 
    void deleteGLObject();
 
    void selectGLObject();
 
    void updateGLObject();
 
 
    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;
 
    /* @brief method for getting the Attribute of an XML key in Position format (used in person plans)
     * @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;
 
    virtual const Parameterised::Map& getACParametersMap() const = 0;
 
    virtual std::string getPopUpID() const = 0;
 
    virtual std::string getHierarchyName() const = 0;
 
 
    std::vector<GNEDemandElement*> getInvalidStops() const;
 
protected:
    GUIGeometry myDemandElementGeometry;
 
    GUIGeometry mySpreadGeometry;
 
    int myStackedLabelNumber;
 
    bool isValidDemandElementID(const std::string& value) const;
 
    bool isValidDemandElementID(const std::vector<SumoXMLTag>& tags, const std::string& value) const;
 
    void setDemandElementID(const std::string& newID);
 
    GNEDemandElement* getTypeParent() const;
 
    GNEDemandElement* getRouteParent() const;
 
    void drawJunctionLine(const GNEDemandElement* element) const;
 
    void drawStackLabel(const int number, const std::string& element, const Position& position, const double rotation,
                        const double width, const double length, const double exaggeration) const;
 
 
    void replaceDemandParentEdges(const std::string& value);
 
    void replaceDemandParentLanes(const std::string& value);
 
    void replaceFirstParentJunction(const std::string& value);
 
    void replaceLastParentJunction(const std::string& value);
 
    void replaceFirstParentEdge(const std::string& value);
 
    void replaceLastParentEdge(const std::string& value);
 
    void replaceFirstParentAdditional(SumoXMLTag tag, const std::string& value);
 
    void replaceLastParentAdditional(SumoXMLTag tag, const std::string& value);
 
    void replaceDemandElementParent(SumoXMLTag tag, const std::string& value, const int parentIndex);
 
    void setVTypeDistributionParent(const std::string& value);
 
 
    struct EdgeStopIndex {
 
        EdgeStopIndex(GNEEdge* edge_, GNEDemandElement* stop) :
            edge(edge_),
            stops({stop}) {}
 
        const GNEEdge* edge = nullptr;
 
        std::vector<GNEDemandElement*> stops;
 
        int stopIndex = -1;
 
    private:
        EdgeStopIndex() {}
    };
 
    std::vector<EdgeStopIndex> getEdgeStopIndex() const;
 
    RGBColor getColorByScheme(const GUIColorer& c, const SUMOVehicleParameter* parameters) const;
 
    std::string getDistributionParents() const;
 
    void buildMenuCommandRouteLength(GUIGLObjectPopupMenu* ret) const;
 
    void buildMenuAddReverse(GUIGLObjectPopupMenu* ret) const;
 
private:
    virtual bool checkChildDemandElementRestriction() const;
 
    virtual void setAttribute(SumoXMLAttr key, const std::string& value) = 0;
 
    virtual void setMoveShape(const GNEMoveResult& moveResult) = 0;
 
    virtual void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList) = 0;
 
    GNEDemandElement(const GNEDemandElement&) = delete;
 
    GNEDemandElement& operator=(const GNEDemandElement&) = delete;
};