SimSession.h

Go to the documentation of this file.

#ifndef SIMPT_SESSION_SIM_SESSION_H_INCLUDED
#define SIMPT_SESSION_SIM_SESSION_H_INCLUDED
/*
 * Copyright 2011-2016 Universiteit Antwerpen
 *
 * Licensed under the EUPL, Version 1.1 or  as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at: http://ec.europa.eu/idabc/eupl5
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing
 * permissions and limitations under the Licence.
 */
#include "ISimSession.h"
#include "gui/controller/AppController.h"

#include <boost/property_tree/ptree.hpp>
#include <functional>
#include <memory>
#include <mutex>
#include <thread>


namespace SimShell { namespace Ws { class MergedPreferences; } }
namespace SimPT_Sim { class Sim; }
class QMainWindow;
class QTimer;

namespace SimPT_Shell {
namespace Session {

class SimWorker;

using boost::property_tree::ptree;
using namespace SimShell;
using namespace SimShell::Session;
using namespace SimShell::Ws;

class SimSession : public ISimSession,
                     public std::enable_shared_from_this<SimSession>
{
        Q_OBJECT
public:
        SimSession(const std::shared_ptr<MergedPreferences>& prefs, const ptree& sim);

        SimSession(const std::shared_ptr<MergedPreferences>& prefs, const SimPT_Sim::SimState& sim);

        virtual ~SimSession();

        virtual std::shared_ptr<RootViewerType>
        CreateRootViewer(SimShell::Gui::Controller::AppController* parent = nullptr);

        virtual std::shared_ptr<SimPT_Sim::Sim> GetSim();

        virtual ExportersType GetExporters();

        virtual const ptree& GetParameters() const;

        virtual std::string GetStatusMessage() const;

        virtual Timings GetTimings() const;

        virtual void ForceExport();

        virtual void SetParameters(const ptree&);

        virtual void StartSimulation(int steps = -1);

        virtual void StopSimulation();

public slots:
        virtual void TimeStep();

private slots:
        virtual void ExecuteViewUnit(QString);

signals:
        void ExecuteWorkUnit();

private:
        std::shared_ptr<SimPT_Sim::Sim>     m_sim;              
        std::mutex                          m_parameters_mutex; 
        std::mutex                          m_viewers_mutex;    
        Timings                             m_timings;          
        std::shared_ptr<MergedPreferences>  m_preferences;      

        QThread*                            m_sim_thread;       
        bool                                m_running;          

        int                                 m_steps_limit;      

        struct {
                bool   updated;       
                ptree  pt;            
        } m_parameter_buffer;         
};

} // namespace
} // namespace

#endif // end_of_include_guard