SimSessionCoupled.h

Go to the documentation of this file.

#ifndef SIM_SESSION_COUPLED_H_INCLUDED
#define SIM_SESSION_COUPLED_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 "session/SimSession.h"
#include "session/ISession.h"
#include "util/misc/Subject.h"

#include <chrono>
#include <memory>
#include <string>
#include <vector>

class QThread;
namespace SimShell{ namespace Ws { class IWorkspace; }}
namespace SimPT_Sim { class CoupledSim; }

namespace SimPT_Shell {
namespace Session {

class SimSessionCoupled : public ISession
{
        Q_OBJECT
public:
        SimSessionCoupled (
                const std::shared_ptr<MergedPreferences>& prefs,
                const ptree& project_info,
                const std::shared_ptr<SimShell::Ws::IWorkspace>& workspaceModel);

        virtual ~SimSessionCoupled();

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

        virtual ExportersType GetExporters();

        virtual const ptree& GetParameters() const;

        std::string GetStatusMessage() const;

        virtual Timings GetTimings() const;

        virtual void ForceExport();

        virtual void RefreshPreferences() {}

        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::vector<std::pair<std::string, std::string>>
        ReadSubprojectList(const boost::property_tree::ptree& pt);

        std::shared_ptr<SimShell::Ws::IProject> OpenSubproject(
                const std::string& projectName,
                const std::string& file,
                const std::shared_ptr<SimShell::Ws::IWorkspace>& workspaceModel);

private:
        std::shared_ptr<SimShell::Ws::MergedPreferences>      m_preferences;

        std::map<std::string, std::shared_ptr<SimShell::Ws::IProject>>  m_projects;

        std::shared_ptr<SimPT_Sim::CoupledSim>               m_sim;

        int                                                   m_steps_limit;


        Timings                                               m_timings;

        bool                                m_running;          


        std::mutex                          m_parameters_mutex; 
        std::mutex                          m_viewers_mutex;    

        QThread*                            m_sim_thread;       

        struct {
                bool   updated;       
                ptree  pt;            
        } m_parameter_buffer; 

};

} // namespace
} // namespace

#endif // end_of_include_guard