GNERoute.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2016-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 class for visualizing routes in Netedit
/****************************************************************************/
#pragma once
#include <config.h>
#include <utils/gui/globjects/GUIGLObjectPopupMenu.h>
 
#include "GNEDemandElement.h"
 
// ===========================================================================
// class declarations
// ===========================================================================
 
class GNEEdge;
class GNEVehicle;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNERoute : public GNEDemandElement, public Parameterised {
 
public:
 
    class GNERoutePopupMenu : public GUIGLObjectPopupMenu {
        FXDECLARE(GNERoutePopupMenu)
 
    public:
        GNERoutePopupMenu(GUIMainWindow& app, GUISUMOAbstractView& parent, GUIGlObject* o);
 
        ~GNERoutePopupMenu();
 
        long onCmdApplyDistance(FXObject*, FXSelector, void*);
 
    protected:
        GNERoutePopupMenu() {}
    };
 
    GNERoute(SumoXMLTag tag, GNENet* net);
 
    GNERoute(GNEAdditional* calibrator);
 
    GNERoute(const std::string& id, const GNEDemandElement* originalRoute);
 
    GNERoute(GNEVehicle* vehicleParent, const GNEDemandElement* originalRoute);
 
    GNERoute(const std::string& id, GNENet* net, const std::string& filename, SUMOVehicleClass vClass, const std::vector<GNEEdge*>& edges,
             const RGBColor& color, const int repeat, const SUMOTime cycleTime, const Parameterised::Map& parameters);
 
    GNERoute(GNEDemandElement* vehicleParent, const std::vector<GNEEdge*>& edges, const RGBColor& color,
             const int repeat, const SUMOTime cycleTime, const Parameterised::Map& parameters);
 
    ~GNERoute();
 
    GNEMoveOperation* getMoveOperation();
 
    void writeDemandElement(OutputDevice& device) const;
 
    Problem isDemandElementValid() const;
 
    std::string getDemandElementProblem() const;
 
    void fixDemandElementProblem();
 
    SUMOVehicleClass getVClass() const;
 
    const RGBColor& getColor() const;
 
 
    void updateGeometry();
 
    Position getPositionInView() const;
 
 
    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
    std::string getParentName() const;
 
    double getExaggeration(const GUIVisualizationSettings& s) const;
 
    Boundary getCenteringBoundary() const;
 
    void splitEdgeGeometry(const double splitPosition, const GNENetworkElement* originalElement, const GNENetworkElement* newElement, GNEUndoList* undoList);
 
    void drawGL(const GUIVisualizationSettings& s) const;
 
 
 
    void computePathElement();
 
    void drawLanePartialGL(const GUIVisualizationSettings& s, const GNESegment* segment, const double offsetFront) const;
 
    void drawJunctionPartialGL(const GUIVisualizationSettings& s, const GNESegment* segment, const double offsetFront) const;
 
    GNELane* getFirstPathLane() const;
 
    GNELane* getLastPathLane() 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;
 
    /* @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;
 
    /* @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
     */
    Position getAttributePosition(SumoXMLAttr key) const;
 
    /* @brief method for check if the value for certain attribute is set
     * @param[in] key The attribute key
     */
    bool isAttributeEnabled(SumoXMLAttr key) const;
 
    /* @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
     * @param[in] net optionally the GNENet to inform about gui updates
     */
    void setAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
 
    /* @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
     */
    bool isValid(SumoXMLAttr key, const std::string& value);
 
    std::string getPopUpID() const;
 
    std::string getHierarchyName() const;
 
    const Parameterised::Map& getACParametersMap() const;
 
    static std::string isRouteValid(const std::vector<GNEEdge*>& edges);
 
    static GNEDemandElement* copyRoute(const GNERoute* originalRoute);
 
protected:
    RGBColor myColor = RGBColor::INVISIBLE;
 
    int myRepeat = 0;
 
    SUMOTime myCycleTime = 0;
 
    SUMOVehicleClass myVClass = SVC_PASSENGER;
 
private:
    void drawRoutePartialLane(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                              const GNESegment* segment, const double offsetFront,
                              const GUIGeometry& geometry, const double exaggeration) const;
 
    void drawRoutePartialJunction(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d,
                                  const double offsetFront, const GUIGeometry& geometry, const double exaggeration) const;
 
    void setAttribute(SumoXMLAttr key, const std::string& value);
 
    void setMoveShape(const GNEMoveResult& moveResult);
 
    void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
 
    GNERoute(GNERoute*) = delete;
 
    GNERoute& operator=(GNERoute*) = delete;
};