GNEVehicle.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
/****************************************************************************/
// Representation of vehicles in netedit
/****************************************************************************/
#pragma once
#include <config.h>
#include <utils/gui/globjects/GUIGLObjectPopupMenu.h>
 
#include "GNEDemandElement.h"
#include "GNEDemandElementFlow.h"
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEVehicle : public GNEDemandElement, public GNEDemandElementFlow {
 
public:
    class GNESingleVehiclePopupMenu : public GUIGLObjectPopupMenu {
        FXDECLARE(GNESingleVehiclePopupMenu)
 
    public:
        GNESingleVehiclePopupMenu(GNEVehicle* vehicle, GUIMainWindow& app, GUISUMOAbstractView& parent);
 
        ~GNESingleVehiclePopupMenu();
 
        long onCmdTransform(FXObject*, FXSelector sel, void*);
 
    protected:
        FOX_CONSTRUCTOR(GNESingleVehiclePopupMenu);
 
    private:
        GNEVehicle* myVehicle;
    };
 
    class GNESelectedVehiclesPopupMenu : public GUIGLObjectPopupMenu {
        FXDECLARE(GNESelectedVehiclesPopupMenu)
 
    public:
        GNESelectedVehiclesPopupMenu(GNEVehicle* vehicle, const std::vector<GNEVehicle*>& selectedVehicle, GUIMainWindow& app, GUISUMOAbstractView& parent);
 
        ~GNESelectedVehiclesPopupMenu();
 
        long onCmdTransform(FXObject* obj, FXSelector sel, void*);
 
    protected:
        FOX_CONSTRUCTOR(GNESelectedVehiclesPopupMenu);
 
    private:
        std::vector<GNEVehicle*> mySelectedVehicles;
 
        std::map<FXObject*, SumoXMLTag> myRestrictedMenuCommands;
 
        SumoXMLTag myVehicleTag;
    };
 
    GNEVehicle(SumoXMLTag tag, GNENet* net);
 
    GNEVehicle(SumoXMLTag tag, GNENet* net, const std::string& vehicleID, GNEDemandElement* vehicleType, GNEDemandElement* route);
 
    GNEVehicle(SumoXMLTag tag, GNENet* net, GNEDemandElement* vehicleType, GNEDemandElement* route, const SUMOVehicleParameter& vehicleParameters);
 
    GNEVehicle(SumoXMLTag tag, GNENet* net, GNEDemandElement* vehicleType, const SUMOVehicleParameter& vehicleParameters);
 
    GNEVehicle(SumoXMLTag tag, GNENet* net, const std::string& vehicleID, GNEDemandElement* vehicleType, GNEEdge* fromEdge, GNEEdge* toEdge);
 
    GNEVehicle(SumoXMLTag tag, GNENet* net, GNEDemandElement* vehicleType, GNEEdge* fromEdge, GNEEdge* toEdge, const SUMOVehicleParameter& vehicleParameters);
 
    GNEVehicle(SumoXMLTag tag, GNENet* net, const std::string& vehicleID, GNEDemandElement* vehicleType, GNEJunction* fromJunction, GNEJunction* toJunction);
 
    GNEVehicle(SumoXMLTag tag, GNENet* net, GNEDemandElement* vehicleType, GNEJunction* fromJunction, GNEJunction* toJunction, const SUMOVehicleParameter& vehicleParameters);
 
    GNEVehicle(SumoXMLTag tag, GNENet* net, GNEDemandElement* vehicleType, GNEAdditional* fromTAZ, GNEAdditional* toTAZ, const SUMOVehicleParameter& vehicleParameters);
 
    ~GNEVehicle();
 
    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;
 
 
    bool checkDrawRelatedContour() 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 setting the attribute and letting the object perform demand element 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 demand element 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);
 
    /* @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
     */
    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
     */
    void disableAttribute(SumoXMLAttr key, GNEUndoList* undoList);
 
    /* @brief method for check if the value for certain attribute is set
     * @param[in] key The attribute key
     */
    bool isAttributeEnabled(SumoXMLAttr key) const;
 
    std::string getPopUpID() const;
 
    std::string getHierarchyName() const;
 
    const Parameterised::Map& getACParametersMap() const;
 
    static GNEDemandElement* copyVehicle(const GNEVehicle* originalVehicle);
 
protected:
    GNEContour myVehicleContour;
 
    RGBColor getDrawingColor(const GUIVisualizationSettings& s) const;
 
    const SUMOVehicleParameter& getSUMOVehicleParameter() const;
 
private:
    static const double myArrivalPositionDiameter;
 
    void setAttribute(SumoXMLAttr key, const std::string& value);
 
    void toggleAttribute(SumoXMLAttr key, const bool value);
 
    void setMoveShape(const GNEMoveResult& moveResult);
 
    void commitMoveShape(const GNEMoveResult& moveResult, GNEUndoList* undoList);
 
    GNEVehicle(const GNEVehicle&) = delete;
 
    GNEVehicle& operator=(const GNEVehicle&) = delete;
};