GUITrafficLightLogicWrapper.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
/****************************************************************************/
// A wrapper for tl-logics to allow their visualisation and interaction
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <gui/GUITLLogicPhasesTrackerWindow.h>
#include <utils/gui/globjects/GUIGlObject.h>
#include <utils/gui/globjects/GUIGLObjectPopupMenu.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSTrafficLightLogic;
class GUIMainWindow;
 
 
// ===========================================================================
// class definition
// ===========================================================================
class GUITrafficLightLogicWrapper : public GUIGlObject {
public:
    GUITrafficLightLogicWrapper(MSTLLogicControl& control, MSTrafficLightLogic& tll);
 
    ~GUITrafficLightLogicWrapper();
 
 
 
 
 
    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app,
                                       GUISUMOAbstractView& parent);
 
    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app,
            GUISUMOAbstractView& parent);
 
    Boundary getCenteringBoundary() const;
 
    const std::string getOptionalName() const;
 
    void drawGL(const GUIVisualizationSettings& s) const;
 
 
    void begin2TrackPhases();
 
    void showPhases();
 
    void switchTLSLogic(int to);
 
    int getLinkIndex(const MSLink* const link) const;
 
    MSTrafficLightLogic& getTLLogic() const {
        return myTLLogic;
    }
 
    MSTrafficLightLogic* getActiveTLLogic() const;
 
    int getCurrentPhase() const;
    std::string getCurrentPhaseName() const;
    int getCurrentDurationSeconds() const;
    int getCurrentMinDurSeconds() const;
    int getCurrentMaxDurSeconds() const;
    int getCurrentEarliestEndSeconds() const;
    int getCurrentLatestEndSeconds() const;
    int getDefaultCycleTimeSeconds() const;
    int getCurrentTimeInCycleSeconds() const;
    int getRunningDurationSeconds() const;
 
public:
    class GUITrafficLightLogicWrapperPopupMenu : public GUIGLObjectPopupMenu {
        FXDECLARE(GUITrafficLightLogicWrapperPopupMenu)
    public:
        GUITrafficLightLogicWrapperPopupMenu(GUIMainWindow& app,
                                             GUISUMOAbstractView& parent, GUIGlObject& o);
 
        ~GUITrafficLightLogicWrapperPopupMenu();
 
        long onCmdShowPhases(FXObject*, FXSelector, void*);
 
        long onCmdBegin2TrackPhases(FXObject*, FXSelector, void*);
        long onCmdShowDetectors(FXObject*, FXSelector, void*);
 
        long onCmdSwitchTLS2Off(FXObject*, FXSelector, void*);
        long onCmdSwitchTLSLogic(FXObject*, FXSelector, void*);
 
    protected:
        GUITrafficLightLogicWrapperPopupMenu() { }
 
    };
 
private:
    MSTLLogicControl& myTLLogicControl;
 
    MSTrafficLightLogic& myTLLogic;
 
    GUIMainWindow* myApp;
 
};