GNEPlanCreator.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
/****************************************************************************/
// Frame for create paths
/****************************************************************************/
#pragma once
#include <config.h>
 
#include "GNEPlanSelector.h"
 
// ===========================================================================
// class declaration
// ===========================================================================
 
class GNEFrame;
class GNEPathManager;
 
// ===========================================================================
// class definitions
// ===========================================================================
 
class GNEPlanCreator : public MFXGroupBoxModule {
    FXDECLARE(GNEPlanCreator)
 
public:
    class PlanPath {
 
    public:
        PlanPath(GNEPathManager* pathManager, const SUMOVehicleClass vClass, GNEEdge* fromEdge, GNEEdge* toEdge);
 
        PlanPath(GNEPathManager* pathManager, const SUMOVehicleClass vClass, GNEEdge* fromEdge, GNEJunction* toJunction);
 
        PlanPath(GNEPathManager* pathManager, const SUMOVehicleClass vClass, GNEJunction* fromJunction, GNEEdge* toEdge);
 
        PlanPath(GNEPathManager* pathManager, const SUMOVehicleClass vClass, GNEJunction* fromJunction, GNEJunction* toJunction);
 
        const std::vector<GNEEdge*>& getSubPath() const;
 
        bool isConflictVClass() const;
 
        bool isConflictDisconnected() const;
 
    protected:
        std::vector<GNEEdge*> mySubPath;
 
        bool myConflictVClass;
 
        bool myConflictDisconnected;
 
    private:
        PlanPath();
 
        PlanPath(PlanPath*) = delete;
 
        PlanPath& operator=(PlanPath*) = delete;
    };
 
    GNEPlanCreator(GNEFrame* frameParent, GNEPathManager* pathManager);
 
    ~GNEPlanCreator();
 
    bool planCanBeCreated(const GNEDemandElement* planTemplate) const;
 
    void showPlanCreatorModule(const GNEPlanSelector* planSelector, const GNEDemandElement* previousPlan);
 
    void hidePathCreatorModule();
 
    bool addRoute(GNEDemandElement* route);
 
    bool addEdge(GNELane* lane);
 
    bool addJunction(GNEJunction* junction);
 
    bool addTAZ(GNEAdditional* taz);
 
    bool addStoppingPlace(GNEAdditional* stoppingPlace);
 
    const CommonXMLStructure::PlanParameters& getPlanParameteres() const;
 
    double getClickedPositionOverLane() const;
 
    const std::vector<PlanPath>& getPath() const;
 
    void drawTemporalRoute(const GUIVisualizationSettings& s) const;
 
    void abortPathCreation();
 
    void removeLastElement();
 
    long onCmdCreatePath(FXObject*, FXSelector, void*);
 
    long onCmdUseLastRoute(FXObject*, FXSelector, void*);
 
    long onUpdUseLastRoute(FXObject*, FXSelector, void*);
 
    long onCmdAbortPathCreation(FXObject*, FXSelector, void*);
 
    long onCmdRemoveLastElement(FXObject*, FXSelector, void*);
 
protected:
    FOX_CONSTRUCTOR(GNEPlanCreator)
 
    // @brief planParents
    enum PlanParents {
        CONSECUTIVE_EDGES   = 1 << 0,   // Plan is placed over consecutive edges
        ROUTE               = 1 << 1,   // Plan is placed over a single route
        EDGE                = 1 << 2,   // Plan is placed over a single edge
        STOPPINGPLACE       = 1 << 3,   // Plan is placed over a stoppingPlace
        START_EDGE          = 1 << 4,   // Plan begins in edge
        START_TAZ           = 1 << 5,   // Plan begins in TAZ
        START_JUNCTION      = 1 << 6,   // Plan begins in junction
        START_STOPPINGPLACE = 1 << 7,   // Plan begins in busStop
        END_EDGE            = 1 << 8,   // Plan ends in edge
        END_TAZ             = 1 << 9,   // Plan ends in TAZ
        END_JUNCTION        = 1 << 10,  // Plan ends in junction
        END_STOPPINGPLACE   = 1 << 11,  // Plan ends in stoppingPlace
    };
 
    void clearPath();
 
    void recalculatePath();
 
    GNEFrame* myFrameParent;
 
    GNEPathManager* myPathManager;
 
    SUMOVehicleClass myVClass;
 
    int myPlanParents;
 
    const GNEDemandElement* myPreviousPlanElement = nullptr;
 
    CommonXMLStructure::PlanParameters myPlanParameteres;
 
    double myClickedPositionOverLane = 0;
 
    std::vector<PlanPath> myPath;
 
    FXButton* myUseLastRoute;
 
    FXButton* myFinishCreationButton;
 
    FXButton* myAbortCreationButton;
 
    FXButton* myRemoveLastInsertedElement;
 
    FXLabel* myInfoLabel;
 
private:
    int getNumberOfSelectedElements() const;
 
    void updateRemoveLastItemButton() const;
 
    void showCreationButtons();
 
    void hideCreationButtons();
 
    void updateInfoLabel();
 
    bool addSingleEdge(GNELane* lane);
 
    bool addSingleStoppingPlace(GNEAdditional* stoppingPlace);
 
    bool addConsecutiveEdge(GNEEdge* edge);
 
    bool addFromToJunction(GNEJunction* junction);
 
    bool addFromToTAZ(GNEAdditional* taz);
 
    bool addFromToEdge(GNEEdge* edge);
 
    bool addFromToStoppingPlace(GNEAdditional* stoppingPlace);
 
    GNEPlanCreator(GNEPlanCreator*) = delete;
 
    GNEPlanCreator& operator=(GNEPlanCreator*) = delete;
};