Updated GNEDemandElementPlan. Refs #13784

src/netedit/elements/demand/GNEContainer.h

@@ -27,9 +27,7 @@
 // ===========================================================================
 // class definitions
 // ===========================================================================
-/**
- * @class GNEContainer
- */
+
 class GNEContainer : public GNEDemandElement, public GNEDemandElementFlow {
 
 public:

src/netedit/elements/demand/GNEDemandElement.h

@@ -48,16 +48,13 @@ class GNEJunction;
 // class definitions
 // ===========================================================================
 
-/**
- * @class GNEDemandElement
- * @brief An Element which don't belong to GNENet but has influence in the simulation
- */
 class GNEDemandElement : public GNEPathManager::PathElement, public GNEHierarchicalElement, public GNEMoveElement, public GNEDemandElementDistribution {
 
 public:
     /// @brief friend declaration (needed for vTypes)
     friend class GNERouteHandler;
     friend class GNEDemandElementFlow;
+    friend class GNEDemandElementPlan;
 
     /// @brief enum class for demandElement problems
     enum class Problem {
@@ -352,33 +349,6 @@ class GNEDemandElement : public GNEPathManager::PathElement, public GNEHierarchi
     /// @brief get route parent (always the second parent demand element)
     GNEDemandElement* getRouteParent() const;
 
-    /// @name Only for person plans
-    /// @{
-    /// @brief check if person plan can be drawn
-    bool drawPersonPlan() const;
-
-    /// @brief check if container plan can be drawn
-    bool drawContainerPlan() const;
-
-    /// @brief draw person plan partial lane
-    void drawPersonPlanPartial(const bool drawPlan, const GUIVisualizationSettings& s, const GNELane* lane, const GNEPathManager::Segment* segment, const double offsetFront,
-                               const double personPlanWidth, const RGBColor& personPlanColor) const;
-
-    /// @brief draw person plan partial junction
-    void drawPersonPlanPartial(const bool drawPlan, const GUIVisualizationSettings& s, const GNELane* fromLane, const GNELane* toLane, const GNEPathManager::Segment* segment,
-                               const double offsetFront, const double personPlanWidth, const RGBColor& personPlanColor) const;
-
-    /// @brief check if person plan is valid
-    Problem isPersonPlanValid() const;
-
-    /// @brief get person plan problem
-    std::string getPersonPlanProblem() const;
-
-    /// @brief person plans arrival position radius
-    static const double myPersonPlanArrivalPositionDiameter;
-
-    /// @}
-
     /// @brief draw line between junctions
     void drawJunctionLine(const GNEDemandElement* element) const;
 

src/netedit/elements/demand/GNEDemandElementDistribution.h

@@ -32,10 +32,6 @@ class GNEUndoList;
 // class definitions
 // ===========================================================================
 
-/**
- * @class GNEDemandElementDistribution
- * @brief Module used for represent attribute distributions
- */
 class GNEDemandElementDistribution {
 
     /// @brief friend declaration

src/netedit/elements/demand/GNEDemandElementPlan.h

@@ -0,0 +1,77 @@
+/****************************************************************************/
+// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
+// Copyright (C) 2001-2023 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
+/****************************************************************************/
+/// @file    GNEDemandElementPlan.h
+/// @author  Pablo Alvarez Lopez
+/// @date    Sep 2023
+///
+// An auxiliar, asbtract class for plan elements
+/****************************************************************************/
+#pragma once
+#include <config.h>
+
+#include <utils/geom/Position.h>
+#include <utils/xml/SUMOXMLDefinitions.h>
+#include <utils/vehicle/SUMOVehicleParameter.h>
+
+// ===========================================================================
+// class declaration
+// ===========================================================================
+
+class SUMOVehicleParameter;
+class GNEDemandElement;
+
+// ===========================================================================
+// class definitions
+// ===========================================================================
+
+class GNEDemandElementPlan {
+
+protected:
+    /// @brief constructor
+    GNEDemandElementPlan(const GNEDemandElement* planElement);
+
+    /// @brief check if person plan can be drawn
+    bool drawPersonPlan() const;
+
+    /// @brief check if container plan can be drawn
+    bool drawContainerPlan() const;
+
+    /// @brief draw person plan partial lane
+    void drawPersonPlanPartial(const bool drawPlan, const GUIVisualizationSettings& s, const GNELane* lane, const GNEPathManager::Segment* segment, const double offsetFront,
+                               const double personPlanWidth, const RGBColor& personPlanColor) const;
+
+    /// @brief draw person plan partial junction
+    void drawPersonPlanPartial(const bool drawPlan, const GUIVisualizationSettings& s, const GNELane* fromLane, const GNELane* toLane, const GNEPathManager::Segment* segment,
+                               const double offsetFront, const double personPlanWidth, const RGBColor& personPlanColor) const;
+
+    /// @brief check if person plan is valid
+    GNEDemandElement::Problem isPersonPlanValid() const;
+
+    /// @brief get person plan problem
+    std::string getPersonPlanProblem() const;
+
+protected:
+    /// @brief person plans arrival position radius
+    static const double myPersonPlanArrivalPositionDiameter;
+
+private:
+    /// @brief pointer to plan element
+    const GNEDemandElement* myPlanElement;
+
+    /// @brief Invalidated copy constructor.
+    GNEDemandElementPlan(const GNEDemandElementPlan&) = delete;
+
+    /// @brief Invalidated assignment operator.
+    GNEDemandElementPlan& operator=(const GNEDemandElementPlan&) = delete;
+};

src/netedit/elements/demand/GNEPerson.h

@@ -27,9 +27,7 @@
 // ===========================================================================
 // class definitions
 // ===========================================================================
-/**
- * @class GNEPerson
- */
+
 class GNEPerson : public GNEDemandElement, public GNEDemandElementFlow {
 
 public:

src/netedit/elements/demand/GNEPersonTrip.cpp

@@ -38,6 +38,7 @@
 GNEPersonTrip::GNEPersonTrip(SumoXMLTag tag, GNENet* net) :
     GNEDemandElement("", net, GLO_PERSONTRIP, tag, GUIIconSubSys::getIcon(GUIIcon::PERSONTRIP_FROMTO),
                      GNEPathManager::PathElement::Options::DEMAND_ELEMENT, {}, {}, {}, {}, {}, {}),
+    GNEDemandElementPlan(this),
     myArrivalPosition(0) {
     // reset default values
     resetDefaultValues();
@@ -49,6 +50,7 @@ GNEPersonTrip::GNEPersonTrip(GNENet* net, GNEDemandElement* personParent, GNEEdg
                              const std::vector<std::string>& lines) :
     GNEDemandElement(personParent, net, GLO_PERSONTRIP, GNE_TAG_PERSONTRIP_EDGE, GUIIconSubSys::getIcon(GUIIcon::PERSONTRIP_FROMTO),
                      GNEPathManager::PathElement::Options::DEMAND_ELEMENT, {}, {fromEdge, toEdge}, {}, {}, {personParent}, {}),
+    GNEDemandElementPlan(this),
     myArrivalPosition(arrivalPosition),
     myVTypes(types),
     myModes(modes),
@@ -62,6 +64,7 @@ GNEPersonTrip::GNEPersonTrip(bool isTrain, GNENet* net, GNEDemandElement* person
     GNEDemandElement(personParent, net, GLO_PERSONTRIP, isTrain ? GNE_TAG_PERSONTRIP_TRAINSTOP : GNE_TAG_PERSONTRIP_BUSSTOP,
                      GUIIconSubSys::getIcon(isTrain ? GUIIcon::PERSONTRIP_TRAINSTOP : GUIIcon::PERSONTRIP_BUSSTOP),
                      GNEPathManager::PathElement::Options::DEMAND_ELEMENT, {}, {fromEdge}, {}, {toStoppingPlace}, {personParent}, {}),
+    GNEDemandElementPlan(this),
     myArrivalPosition(arrivalPosition),
     myVTypes(types),
     myModes(modes),
@@ -74,6 +77,7 @@ GNEPersonTrip::GNEPersonTrip(GNENet* net, GNEDemandElement* personParent, GNEJun
                              const std::vector<std::string>& lines) :
     GNEDemandElement(personParent, net, GLO_PERSONTRIP, GNE_TAG_PERSONTRIP_JUNCTIONS, GUIIconSubSys::getIcon(GUIIcon::PERSONTRIP_JUNCTIONS),
                      GNEPathManager::PathElement::Options::DEMAND_ELEMENT, {fromJunction, toJunction}, {}, {}, {}, {personParent}, {}),
+    GNEDemandElementPlan(this),
     myArrivalPosition(arrivalPosition),
     myVTypes(types),
     myModes(modes),
@@ -86,6 +90,7 @@ GNEPersonTrip::GNEPersonTrip(GNENet* net, GNEDemandElement* personParent, GNEAdd
                              const std::vector<std::string>& lines) :
     GNEDemandElement(personParent, net, GLO_PERSONTRIP, GNE_TAG_PERSONTRIP_TAZS, GUIIconSubSys::getIcon(GUIIcon::PERSONTRIP_JUNCTIONS),
                      GNEPathManager::PathElement::Options::DEMAND_ELEMENT, {}, {}, {}, {fromTAZ, toTAZ}, {personParent}, {}),
+    GNEDemandElementPlan(this),
     myArrivalPosition(arrivalPosition),
     myVTypes(types),
     myModes(modes),

src/netedit/elements/demand/GNEPersonTrip.h

@@ -19,21 +19,25 @@
 /****************************************************************************/
 #pragma once
 #include <config.h>
-#include "GNEDemandElement.h"
 #include <utils/gui/globjects/GUIGLObjectPopupMenu.h>
 
+#include "GNEDemandElement.h"
+#include "GNEDemandElementPlan.h"
+
 // ===========================================================================
 // class declarations
 // ===========================================================================
+
 class GNEEdge;
 class GNEConnection;
 class GNEVehicle;
 
-
 // ===========================================================================
 // class definitions
-// ===========================================================================
-class GNEPersonTrip : public GNEDemandElement, public Parameterised {
+// ====================================================================
+
+class GNEPersonTrip : public GNEDemandElement, public Parameterised, public GNEDemandElementPlan {
+
 public:
     /// @brief default constructor
     GNEPersonTrip(SumoXMLTag tag, GNENet* net);

src/netedit/elements/demand/GNERide.cpp

@@ -36,7 +36,8 @@
 GNERide::GNERide(SumoXMLTag tag, GNENet* net) :
     GNEDemandElement("", net, GLO_RIDE, tag, GUIIconSubSys::getIcon(GUIIcon::RIDE_FROMTO),
                      GNEPathManager::PathElement::Options::DEMAND_ELEMENT, {}, {}, {}, {}, {}, {}),
-myArrivalPosition(0) {
+    GNEDemandElementPlan(this),
+    myArrivalPosition(0) {
     // reset default values
     resetDefaultValues();
 }
@@ -46,8 +47,9 @@ GNERide::GNERide(GNENet* net, GNEDemandElement* personParent, GNEEdge* fromEdge,
                  double arrivalPosition, const std::vector<std::string>& lines) :
     GNEDemandElement(personParent, net, GLO_RIDE, GNE_TAG_RIDE_EDGE, GUIIconSubSys::getIcon(GUIIcon::RIDE_FROMTO),
                      GNEPathManager::PathElement::Options::DEMAND_ELEMENT, {}, {fromEdge, toEdge}, {}, {}, {personParent}, {}),
-myArrivalPosition(arrivalPosition),
-myLines(lines) {
+    GNEDemandElementPlan(this),
+    myArrivalPosition(arrivalPosition),
+    myLines(lines) {
 }
 
 
@@ -56,8 +58,9 @@ GNERide::GNERide(bool isTrain, GNENet* net, GNEDemandElement* personParent, GNEE
     GNEDemandElement(personParent, net, GLO_RIDE, isTrain ? GNE_TAG_RIDE_TRAINSTOP : GNE_TAG_RIDE_BUSSTOP,
                      GUIIconSubSys::getIcon(isTrain ? GUIIcon::RIDE_TRAINSTOP : GUIIcon::RIDE_BUSSTOP),
                      GNEPathManager::PathElement::Options::DEMAND_ELEMENT, {}, {fromEdge}, {}, {toBusStop}, {personParent}, {}),
-myArrivalPosition(arrivalPosition),
-myLines(lines) {
+    GNEDemandElementPlan(this),
+    myArrivalPosition(arrivalPosition),
+    myLines(lines) {
 }
 
 

src/netedit/elements/demand/GNERide.h

@@ -19,12 +19,15 @@
 /****************************************************************************/
 #pragma once
 #include <config.h>
-#include "GNEDemandElement.h"
 #include <utils/gui/globjects/GUIGLObjectPopupMenu.h>
 
+#include "GNEDemandElement.h"
+#include "GNEDemandElementPlan.h"
+
 // ===========================================================================
 // class declarations
 // ===========================================================================
+
 class GNEEdge;
 class GNEConnection;
 class GNEVehicle;
@@ -33,7 +36,7 @@ class GNEVehicle;
 // class definitions
 // ===========================================================================
 
-class GNERide : public GNEDemandElement, public Parameterised {
+class GNERide : public GNEDemandElement, public Parameterised, public GNEDemandElementPlan {
 
 public:
     /// @brief default constructor

src/netedit/elements/demand/GNERoute.h

@@ -28,6 +28,7 @@
 // ===========================================================================
 // class declarations
 // ===========================================================================
+
 class GNEEdge;
 class GNEConnection;
 class GNEVehicle;

src/netedit/elements/demand/GNEStop.cpp

@@ -42,7 +42,8 @@
 GNEStop::GNEStop(SumoXMLTag tag, GNENet* net) :
     GNEDemandElement("", net, GLO_STOP, tag, GUIIconSubSys::getIcon(GUIIcon::STOP),
                      GNEPathManager::PathElement::Options::DEMAND_ELEMENT, {}, {}, {}, {}, {}, {}),
-myCreationIndex(myNet->getAttributeCarriers()->getStopIndex()) {
+    GNEDemandElementPlan(this),
+    myCreationIndex(myNet->getAttributeCarriers()->getStopIndex()) {
     // reset default values
     resetDefaultValues();
     // enable parking for stops in parkin)gAreas
@@ -65,8 +66,9 @@ myCreationIndex(myNet->getAttributeCarriers()->getStopIndex()) {
 GNEStop::GNEStop(SumoXMLTag tag, GNENet* net, GNEDemandElement* stopParent, GNEAdditional* stoppingPlace, const SUMOVehicleParameter::Stop& stopParameter) :
     GNEDemandElement(stopParent, net, GLO_STOP, tag, GUIIconSubSys::getIcon(GUIIcon::STOP),
                      GNEPathManager::PathElement::Options::DEMAND_ELEMENT, {}, {}, {}, {stoppingPlace}, {stopParent}, {}),
-SUMOVehicleParameter::Stop(stopParameter),
-myCreationIndex(myNet->getAttributeCarriers()->getStopIndex()) {
+    SUMOVehicleParameter::Stop(stopParameter),
+    GNEDemandElementPlan(this),
+    myCreationIndex(myNet->getAttributeCarriers()->getStopIndex()) {
     // enable parking for stops in parkingAreas
     if ((tag == GNE_TAG_STOP_PARKINGAREA) || (tag == GNE_TAG_WAYPOINT_PARKINGAREA)) {
         parametersSet |= STOP_PARKING_SET;
@@ -91,8 +93,9 @@ myCreationIndex(myNet->getAttributeCarriers()->getStopIndex()) {
 GNEStop::GNEStop(SumoXMLTag tag, GNENet* net, GNEDemandElement* stopParent, GNELane* lane, const SUMOVehicleParameter::Stop& stopParameter) :
     GNEDemandElement(stopParent, net, GLO_STOP, tag, GUIIconSubSys::getIcon(GUIIcon::STOP),
                      GNEPathManager::PathElement::Options::DEMAND_ELEMENT, {}, {}, {lane}, {}, {stopParent}, {}),
-SUMOVehicleParameter::Stop(stopParameter),
-myCreationIndex(myNet->getAttributeCarriers()->getStopIndex()) {
+    SUMOVehicleParameter::Stop(stopParameter),
+    GNEDemandElementPlan(this),
+    myCreationIndex(myNet->getAttributeCarriers()->getStopIndex()) {
     // set parking
     if (parametersSet & STOP_PARKING_SET) {
         parking = ParkingType::OFFROAD;
@@ -113,8 +116,9 @@ myCreationIndex(myNet->getAttributeCarriers()->getStopIndex()) {
 GNEStop::GNEStop(SumoXMLTag tag, GNENet* net, GNEDemandElement* stopParent, GNEEdge* edge, const SUMOVehicleParameter::Stop& stopParameter) :
     GNEDemandElement(stopParent, net, GLO_STOP, tag, GUIIconSubSys::getIcon(GUIIcon::STOP),
                      GNEPathManager::PathElement::Options::DEMAND_ELEMENT, {}, {edge}, {}, {}, {stopParent}, {}),
-SUMOVehicleParameter::Stop(stopParameter),
-myCreationIndex(myNet->getAttributeCarriers()->getStopIndex()) {
+    SUMOVehicleParameter::Stop(stopParameter),
+    GNEDemandElementPlan(this),
+    myCreationIndex(myNet->getAttributeCarriers()->getStopIndex()) {
     // enable parking for stops in parkingAreas
     if ((tag == GNE_TAG_STOP_PARKINGAREA) || (tag == GNE_TAG_WAYPOINT_PARKINGAREA)) {
         parametersSet |= STOP_PARKING_SET;

src/netedit/elements/demand/GNEStop.h

@@ -21,14 +21,13 @@
 #include <config.h>
 
 #include "GNEDemandElement.h"
+#include "GNEDemandElementPlan.h"
 
 // ===========================================================================
 // class definitions
 // ===========================================================================
-/**
- * @class GNEStop
- */
-class GNEStop : public GNEDemandElement, public SUMOVehicleParameter::Stop {
+
+class GNEStop : public GNEDemandElement, public SUMOVehicleParameter::Stop, public GNEDemandElementPlan {
 
 public:
     /// @brief default constructor