GUIRunThread.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.org/sumo
// Copyright (C) 2001-2018 German Aerospace Center (DLR) and others.
// This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v2.0
// which accompanies this distribution, and is available at
// http://www.eclipse.org/legal/epl-v20.html
// SPDX-License-Identifier: EPL-2.0
/****************************************************************************/
// The thread that runs the simulation
/****************************************************************************/
#ifndef GUIRunThread_h
#define GUIRunThread_h


// ===========================================================================
// included modules
// ===========================================================================
#include <config.h>

#include <string>
#include <iostream>
#include <fx.h>
#include <utils/foxtools/FXSingleEventThread.h>
#include <utils/foxtools/FXThreadEvent.h>
#include <utils/foxtools/MFXEventQue.h>
#include <utils/common/SUMOTime.h>


// ===========================================================================
// class declarations
// ===========================================================================
class GUINet;
class GUIEvent;
class OutputDevice;


// ===========================================================================
// class definition
// ===========================================================================
class GUIRunThread : public FXSingleEventThread {
public:
    GUIRunThread(FXApp* app, MFXInterThreadEventClient* mw,
                 double& simDelay, MFXEventQue<GUIEvent*>& eq, FXEX::FXThreadEvent& 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 simulationAvailable() 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 getSimEndTime() const {
        return mySimEndTime;
    }

    std::vector<SUMOTime>& getBreakpoints() {
        return myBreakpoints;
    }

    FXMutex& getBreakpointLock() {
        return myBreakpointLock;
    }

    std::set<SUMOTime>& getSnapshots() {
        return myApplicationSnapshots;
    }

    FXMutex& getSnapshotsLock() {
        return myApplicationSnapshotsLock;
    }

protected:
    void makeStep();

    void waitForSnapshots(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;

    MFXEventQue<GUIEvent*>& myEventQue;

    FXEX::FXThreadEvent& myEventThrow;

    MFXMutex mySimulationLock;

    std::vector<SUMOTime> myBreakpoints;

    FXMutex myBreakpointLock;

    std::set<SUMOTime> myApplicationSnapshots;

    FXMutex myApplicationSnapshotsLock;

};


#endif

/****************************************************************************/