GUIRunThread.h

Go to the documentation of this file.

/****************************************************************************/
// The thread that runs the simulation
/****************************************************************************/
// SUMO, Simulation of Urban MObility; see http://sumo.dlr.de/
// Copyright (C) 2001-2017 DLR (http://www.dlr.de/) and contributors
/****************************************************************************/
//
//   This file is part of SUMO.
//   SUMO is free software: you can redistribute it and/or modify
//   it under the terms of the GNU General Public License as published by
//   the Free Software Foundation, either version 3 of the License, or
//   (at your option) any later version.
//
/****************************************************************************/
#ifndef GUIRunThread_h
#define GUIRunThread_h


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#include <string>
#include <iostream>
#include <fx.h>
#include <utils/foxtools/FXSingleEventThread.h>
#include <utils/foxtools/FXRealSpinDial.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,
                 FXRealSpinDial& 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;

    FXRealSpinDial& mySimDelay;

    MFXEventQue<GUIEvent*>& myEventQue;

    FXEX::FXThreadEvent& myEventThrow;

    MFXMutex mySimulationLock;

    std::vector<SUMOTime> myBreakpoints;

    FXMutex myBreakpointLock;

    std::set<SUMOTime> myApplicationSnapshots;

    FXMutex myApplicationSnapshotsLock;

};


#endif

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