GNEDemandElementPlan.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
/****************************************************************************/
// 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>
 
#include "GNEPlanParents.h"
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class SUMOVehicleParameter;
class GNEDemandElement;
class GNEEdge;
class GNEJunction;
class GNEAdditional;
class GNERoute;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEDemandElementPlan {
 
public:
    static std::pair<SumoXMLTag, GUIIcon> getWalkTagIcon(const CommonXMLStructure::PlanParameters& planParameters);
 
    static std::pair<SumoXMLTag, GUIIcon> getPersonTripTagIcon(const CommonXMLStructure::PlanParameters& planParameters);
 
    static std::pair<SumoXMLTag, GUIIcon> getRideTagIcon(const CommonXMLStructure::PlanParameters& planParameters);
 
    static std::pair<SumoXMLTag, GUIIcon> getTransportTagIcon(const CommonXMLStructure::PlanParameters& planParameters);
 
    static std::pair<SumoXMLTag, GUIIcon> getTranshipTagIcon(const CommonXMLStructure::PlanParameters& planParameters);
 
    static std::pair<SumoXMLTag, GUIIcon> getPersonStopTagIcon(const CommonXMLStructure::PlanParameters& planParameters);
 
    static std::pair<SumoXMLTag, GUIIcon> getContainerStopTagIcon(const CommonXMLStructure::PlanParameters& planParameters);
 
protected:
    GNEContour myPlanContour;
 
    GNEContour myPlanContourEnd;
 
    Boundary myPlanBoundary;
 
    GNEDemandElementPlan(GNEDemandElement* planElement, const double departPosition, const double arrivalPosition);
 
    GNEMoveOperation* getPlanMoveOperation();
 
    void writeLocationAttributes(OutputDevice& device) const;
 
    void writeOriginStop(OutputDevice& device) const;
 
    GUIGLObjectPopupMenu* getPlanPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent);
 
 
    GNELane* getFirstPlanPathLane() const;
 
    GNELane* getLastPlanPathLane() const;
 
    void computePlanPathElement();
 
 
 
    void updatePlanGeometry();
 
    Boundary getPlanCenteringBoundary() const;
 
    void updatePlanCenteringBoundary(const bool updateGrid);
 
    Position getPlanPositionInView() const;
 
 
 
    std::string getPlanAttribute(SumoXMLAttr key) const;
 
    double getPlanAttributeDouble(SumoXMLAttr key) const;
 
    Position getPlanAttributePosition(SumoXMLAttr key) const;
 
    void setPlanAttribute(SumoXMLAttr key, const std::string& value, GNEUndoList* undoList);
 
    bool isPlanValid(SumoXMLAttr key, const std::string& value);
 
    bool isPlanAttributeEnabled(SumoXMLAttr key) const;
 
    void setPlanAttribute(SumoXMLAttr key, const std::string& value);
 
    std::string getPlanHierarchyName() const;
 
 
 
    bool checkDrawPersonPlan() const;
 
    bool checkDrawContainerPlan() const;
 
    void drawPlanGL(const bool drawPlan, const GUIVisualizationSettings& s, const RGBColor& planColor, const RGBColor& planSelectedColor) const;
 
    void drawPlanLanePartial(const bool drawPlan, const GUIVisualizationSettings& s, const GNEPathManager::Segment* segment, const double offsetFront,
                             const double planWidth, const RGBColor& planColor, const RGBColor& planSelectedColor) const;
 
    void drawPlanJunctionPartial(const bool drawPlan, const GUIVisualizationSettings& s, const GNEPathManager::Segment* segment, const double offsetFront,
                                 const double planWidth, const RGBColor& planColor, const RGBColor& planSelectedColor) const;
 
 
    GNEDemandElement::Problem isPlanPersonValid() const;
 
    std::string getPersonPlanProblem() const;
 
    double myDepartPosition;
 
    double myArrivalPosition;
 
private:
    double getEndPosRadius(const GUIVisualizationSettings& s, const GNEPathManager::Segment* segment, const bool drawHalfWidth) const;
 
    void drawFromArrow(const GUIVisualizationSettings& s, const GNELane* lane, const GNEPathManager::Segment* segment) const;
 
    void drawToArrow(const GUIVisualizationSettings& s, const GNELane* lane, const GNEPathManager::Segment* segment) const;
 
    void drawEndPosition(const GUIVisualizationSettings& s, const GUIVisualizationSettings::Detail d, const double endPosRadius) const;
 
    bool replacePlanParent(const std::string& newParentID);
 
    GNEDemandElement* myPlanElement;
 
    static const double myArrivalPositionDiameter;
 
    GNEDemandElementPlan(const GNEDemandElementPlan&) = delete;
 
    GNEDemandElementPlan& operator=(const GNEDemandElementPlan&) = delete;
};