ISession.h

Go to the documentation of this file.

#ifndef ISESSION_H_INCLUDED
#define ISESSION_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 "util/clock_man/Timeable.h"
#include "viewer/IViewerNode.h"

#include <boost/property_tree/ptree.hpp>
#include <QObject>
#include <QMetaType>

#include <functional>
#include <string>
#include <utility>
#include <vector>

class QAction;
class QWidget;
Q_DECLARE_METATYPE(std::string)

namespace SimShell {

namespace Gui {namespace Controller {class AppController;}}

namespace Session {

class ISession : public QObject, public SimPT_Sim::ClockMan::Timeable<>
{
        Q_OBJECT
public:
        using ExportCallbackType     = std::function<void(const std::string&)>;
        struct ExporterType {
                std::string            extension;
                ExportCallbackType     callback;
        };
        using ExportersType          = std::vector<std::pair<std::string, ExporterType>>;

        using RootViewerType         = Viewer::IViewerNode  ;

public:
        virtual ~ISession() {}

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

        virtual void ForceExport() = 0;

        virtual ExportersType GetExporters() = 0;

        virtual const boost::property_tree::ptree& GetParameters() const = 0;

        virtual void SetParameters(const boost::property_tree::ptree&) = 0;

        virtual void StartSimulation(int steps = -1) = 0;

        virtual void StopSimulation() = 0;

        virtual void TimeStep() = 0;

        enum class InfoMessageReason {
                Stepped,        // A time step was done
                Started,        // The simulation has been started
                Stopped,        // The simulation has been stopped
                Terminated      // The simulation terminated (because of the termination condition)
        };

signals:
        void InfoMessage(const std::string &message, const InfoMessageReason &reason);

        void ErrorMessage(const std::string &error);
};

} // namespace
} // namespace

#endif // end_of_inclde_guard