GUINet.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2001-2026 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 MSNet extended by some values for usage within the gui
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <utility>
#include <microsim/MSNet.h>
#include <microsim/devices/MSDevice_Tripinfo.h>
#include <utils/geom/Boundary.h>
#include <utils/geom/Position.h>
#include <utils/xml/SUMOSAXHandler.h>
#include <utils/xml/SAXWeightsHandler.h>
#include <foreign/rtree/SUMORTree.h>
#include <foreign/rtree/LayeredRTree.h>
#include <utils/geom/PositionVector.h>
#include <utils/gui/globjects/GUIGlObjectStorage.h>
#include <utils/gui/globjects/GUIGLObjectPopupMenu.h>
#include <utils/gui/globjects/GUIGlObject.h>
#include <utils/gui/globjects/GUIGlObject_AbstractAdd.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class MSEdgeControl;
class MSJunctionControl;
class MSTLLogicControl;
class MSTrafficLightLogic;
class MSLink;
class GUIJunctionWrapper;
class GUIDetectorWrapper;
class GUICalibrator;
class GUITrafficLightLogicWrapper;
class RGBColor;
class GUIEdge;
class OutputDevice;
class GUIVehicle;
class GUIVehicleControl;
class MSVehicleControl;
class GUIMEVehicleControl;
class Command;
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class GUINet : public MSNet, public GUIGlObject {
 
    friend class GUITrafficLightLogicWrapper; // see createTLWrapper
 
public:
    GUINet(MSVehicleControl* vc, MSEventControl* beginOfTimestepEvents,
           MSEventControl* endOfTimestepEvents,
           MSEventControl* insertionEvents);
 
 
    ~GUINet();
 
 
    bool isGUINet() const override {
        return true;
    }
 
 
 
 
    GUIGLObjectPopupMenu* getPopUpMenu(GUIMainWindow& app, GUISUMOAbstractView& parent) override;
 
    GUIParameterTableWindow* getParameterWindow(GUIMainWindow& app, GUISUMOAbstractView& parent) override;
 
    Boundary getCenteringBoundary() const override;
 
    void drawGL(const GUIVisualizationSettings& s) const override;
 
 
    const Boundary& getBoundary() const;
 
    Position getJunctionPosition(const std::string& name) const;
 
    bool vehicleExists(const std::string& name) const;
 
    void guiSimulationStep();
 
    void simulationStep();
 
 
    int getWholeDuration() const;
 
 
    int getSimDuration() const;
 
 
    double getRTFactor() const;
 
    double getUPS() const;
 
    double getMeanRTFactor(int duration) const;
 
    double getMeanUPS() const;
 
    // Returns the duration of the last step's visualisation part (in ms)
    //int getVisDuration() const;
 
    int getIdleDuration() const;
 
    void setSimDuration(int val);
 
    // Sets the duration of the last step's visualisation part
    //void setVisDuration(int val);
 
    void setIdleDuration(int val);
    //}
 
    double getAvgRouteLength() const {
        return MSDevice_Tripinfo::getAvgRouteLength();
    }
    double getAvgDuration() const {
        return MSDevice_Tripinfo::getAvgDuration();
    }
    double getAvgWaitingTime() const {
        return MSDevice_Tripinfo::getAvgWaitingTime();
    }
    double getAvgTimeLoss() const {
        return MSDevice_Tripinfo::getAvgTimeLoss();
    }
    double getAvgDepartDelay() const {
        return MSDevice_Tripinfo::getAvgDepartDelay();
    }
    double getAvgTripSpeed() const {
        return MSDevice_Tripinfo::getAvgDuration() != 0 ? MSDevice_Tripinfo::getAvgRouteLength() / MSDevice_Tripinfo::getAvgDuration() : 0;
    }
    double getAvgWalkRouteLength() const {
        return MSDevice_Tripinfo::getAvgWalkRouteLength();
    }
    double getAvgWalkDuration() const {
        return MSDevice_Tripinfo::getAvgWalkDuration();
    }
    double getAvgWalkTimeLoss() const {
        return MSDevice_Tripinfo::getAvgWalkTimeLoss();
    }
 
    MSTransportableControl& getPersonControl() override;
 
 
    MSTransportableControl& getContainerControl() override;
 
 
    int getLinkTLID(const MSLink* const link) const;
 
    int getLinkTLIndex(const MSLink* const link) const;
 
    GUITrafficLightLogicWrapper* getTLLWrapper(MSTrafficLightLogic* tll);
 
 
 
    /* @brief Returns the gl-ids of all junctions within the net
     * @param[in] includeInternal Whether to include ids of internal junctions
     */
    std::vector<GUIGlID> getJunctionIDs(bool includeInternal) const;
 
    std::vector<GUIGlID> getTLSIDs() const;
 
 
    void initGUIStructures();
 
 
    SUMORTree& getVisualisationSpeedUp() {
        return myGrid;
    }
 
 
    const SUMORTree& getVisualisationSpeedUp(bool secondary = false) const {
        return secondary ? myGrid2 : myGrid;
    }
 
    void registerRenderedObject(GUIGlObject* o);
 
    GUIVehicleControl* getGUIVehicleControl();
 
    GUIMEVehicleControl* getGUIMEVehicleControl();
 
    double getEdgeData(const MSEdge* edge, const std::string& attr);
 
    double getMeanData(const MSLane* lane, const std::string& id, const std::string& attr);
 
    bool loadEdgeData(const std::string& file);
 
    std::vector<std::string> getEdgeDataAttrs() const;
 
    std::vector<std::string> getMeanDataIDs() const;
 
    std::vector<std::string> getMeanDataAttrs(const std::string& meanDataID) const;
 
#ifdef HAVE_OSG
    void updateColor(const GUIVisualizationSettings& s);
#endif
 
    void lock();
 
    void unlock();
 
    void lockPendingEmits() const override;
 
    void unlockPendingEmits() const override;
 
    static GUINet* getGUIInstance();
 
    void createTLWrapper(MSTrafficLightLogic* tll) override;
 
    bool isSelected(const MSTrafficLightLogic* tll) const override;
 
    void updateGUI() const override;
 
    void addHotkey(int key, Command* press, Command* release = nullptr);
 
    void flushOutputsAtEnd();
 
    virtual bool skipFinalReset() const override {
        return mySkipFinalReset;
    }
 
private:
    void initTLMap();
 
    friend class GUIOSGBuilder;
 
protected:
    LayeredRTree myGrid;
 
    SUMORTree myGrid2;
 
    Boundary myBoundary;
 
    std::vector<GUIEdge*> myEdgeWrapper;
 
    std::vector<GUIJunctionWrapper*> myJunctionWrapper;
 
    std::vector<GUIDetectorWrapper*> myDetectorWrapper;
 
    std::vector<GUICalibrator*> myCalibratorWrapper;
 
    typedef std::map<const MSLink*, std::string> Links2LogicMap;
    Links2LogicMap myLinks2Logic;
 
 
    typedef std::map<MSTrafficLightLogic*, GUITrafficLightLogicWrapper*> Logics2WrapperMap;
    Logics2WrapperMap myLogics2Wrapper;
 
 
    int myLastSimDuration, /*myLastVisDuration, */myLastIdleDuration;
 
    long myLastVehicleMovementCount, myOverallVehicleCount;
    long myOverallSimDuration;
 
    std::map<std::string, MSEdgeWeightsStorage*> myLoadedEdgeData;
 
    bool mySkipFinalReset = false;
 
    class DiscoverAttributes : public SUMOSAXHandler {
    public:
        DiscoverAttributes(const std::string& file):
            SUMOSAXHandler(file), firstIntervalBegin(SUMOTime_MAX), lastIntervalEnd(0), numIntervals(0) {};
        ~DiscoverAttributes() {};
        void myStartElement(int element, const SUMOSAXAttributes& attrs);
        std::vector<std::string> getEdgeAttrs();
        SUMOTime firstIntervalBegin;
        SUMOTime lastIntervalEnd;
        int numIntervals;
    private:
        std::set<std::string> edgeAttrs;
    };
 
    class EdgeFloatTimeLineRetriever_GUI : public SAXWeightsHandler::EdgeFloatTimeLineRetriever {
    public:
        EdgeFloatTimeLineRetriever_GUI(MSEdgeWeightsStorage* weightStorage) : myWeightStorage(weightStorage) {}
 
        ~EdgeFloatTimeLineRetriever_GUI() { }
 
        void addEdgeWeight(const std::string& id, double val, double beg, double end) const;
        void addEdgeRelWeight(const std::string& from, const std::string& to, double val, double beg, double end) const;
 
    private:
        MSEdgeWeightsStorage* myWeightStorage;
 
    };
 
private:
    mutable FXMutex myLock;
 
    //MSInsertionControl (avoid the need to create GUIInsertionControl)
    mutable FXMutex myPendingEmitsLock;
 
};