GUIRunThread.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
/****************************************************************************/
// The thread that runs the simulation
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <string>
#include <vector>
#include <set>
#include <iostream>
#include <utils/foxtools/fxheader.h>
#include <utils/foxtools/MFXSingleEventThread.h>
#include <utils/foxtools/MFXThreadEvent.h>
#include <utils/foxtools/MFXSynchQue.h>
#include <utils/common/SUMOTime.h>
 
 
// ===========================================================================
// class declarations
// ===========================================================================
class GUINet;
class GUIEvent;
class OutputDevice;
 
// ===========================================================================
// class definition
// ===========================================================================
class GUIRunThread : public MFXSingleEventThread {
 
public:
    GUIRunThread(FXApp* app, MFXInterThreadEventClient* mw,
                 double& simDelay, MFXSynchQue<GUIEvent*>& eq,
                 FXEX::MFXThreadEvent& ev);
 
    virtual ~GUIRunThread();
 
    virtual bool init(GUINet* net, SUMOTime start, SUMOTime end);
 
    virtual FXint run();
 
    void resume();
 
    void singleStep();
 
    virtual void begin();
 
    void stop();
 
    bool networkAvailable() const;
 
    virtual bool simulationIsStartable() const;
 
    virtual bool simulationIsStopable() const;
 
    virtual bool simulationIsStepable() const;
 
    virtual void deleteSim();
 
    GUINet& getNet() const;
 
    void prepareDestruction();
 
    void retrieveMessage(const MsgHandler::MsgType type, const std::string& msg);
 
    SUMOTime getSimBegin() {
        return mySimStartTime;
    }
 
    SUMOTime getSimEndTime() const {
        return mySimEndTime;
    }
 
    std::vector<SUMOTime>& getBreakpoints() {
        return myBreakpoints;
    }
 
    FXMutex& getBreakpointLock() {
        return myBreakpointLock;
    }
 
    void enableLibsumo() {
        myAmLibsumo = true;
    }
 
    void tryStep();
 
protected:
    void makeStep();
 
    void waitForSnapshots(const SUMOTime snapshotTime);
 
protected:
    GUINet* myNet;
 
    SUMOTime mySimStartTime, mySimEndTime;
 
    bool myHalting;
 
    bool myQuit;
 
    bool mySimulationInProgress;
 
    bool myOk;
 
    bool mySingle;
 
    bool myHaveSignaledEnd;
 
    OutputDevice* myErrorRetriever, *myMessageRetriever, *myWarningRetriever;
 
    double& mySimDelay;
 
    MFXSynchQue<GUIEvent*>& myEventQue;
 
    FXEX::MFXThreadEvent& myEventThrow;
 
    FXMutex mySimulationLock;
 
    std::vector<SUMOTime> myBreakpoints;
 
    FXMutex myBreakpointLock;
 
    long myLastEndMillis;
 
    long myLastBreakMillis;
 
    bool myAmLibsumo;
};