artis-star/src/artis-star/common/RootCoordinator.hpp

/**
 * @file RootCoordinator.hpp
 * @author The ARTIS Development Team
 * See the AUTHORS or Authors.txt file
 */

/*
 * ARTIS - the multimodeling and simulation environment
 * This file is a part of the ARTIS environment
 *
 * Copyright (C) 2013-2019 ULCO http://www.univ-littoral.fr
 *
 * This program 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef COMMON_ROOT_COORDINATOR
#define COMMON_ROOT_COORDINATOR

#include <artis-star/common/context/Context.hpp>
#include <artis-star/common/observer/Observer.hpp>
#include <artis-star/common/observer/View.hpp>
#include <artis-star/common/Parameters.hpp>

#include <sstream>
#include <string>

namespace artis {
    namespace common {

        template<class Time, class Coordinator>
        class RootCoordinator {
        public :
            RootCoordinator(const common::context::Context<Time>& context,
                    const std::string& root_name,
                    const typename Coordinator::parameters_type& parameters,
                    const typename Coordinator::graph_parameters_type& graph_parameters)
                    :
                    _root(root_name, parameters, graph_parameters), _observer(&_root),
                    _t_max(context.end()), _tn(context.begin()) { }

            RootCoordinator(const common::context::Context<Time>& context,
                    const std::string& root_name,
                    const typename Coordinator::parameters_type& parameters)
                    :
                    _root(root_name, parameters, NoParameters()), _observer(&_root),
                    _t_max(context.end()), _tn(context.begin()) { }

            RootCoordinator(const common::context::Context<Time>& context,
                    const std::string& root_name)
                    :
                    _root(root_name, NoParameters(), NoParameters()), _observer(&_root),
                    _t_max(context.end()), _tn(context.begin()) { }

            virtual ~RootCoordinator() { }

            void attachView(const std::string& name, observer::View<Time>* view)
            {
                _observer.attachView(name, view);
            }

            const observer::Observer<Time>& observer() const { return _observer; }

            void run(const common::context::Context<Time>& context)
            {
//             DSDE synchroniser
//               When receive (START,t)
//                  send (START,0) to child
//                  while (t N,child ≠ ∞) do
//                    "Computes the output of all the models"
//                    send (OUTPUT,t N,child ) to child
//                    "Makes the transition"
//                    send (TRANSITION,t N,child ,φ) to child
//                  endWhile
//               end

                _observer.init();
                if (context.valid()) {
                    _root.restore(context.state());
                    _tn = _root.get_tn();
                } else {
                    _tn = _root.start(_tn);
                }
                while (_tn <= _t_max) {
                    typename Time::type next_tn;

                    _root.output(_tn);
                    next_tn = _root.transition(_tn);
                    _observer.observe(_tn, _t_max < next_tn ? _t_max : next_tn);
                    _tn = next_tn;
                }
            }

            void save(common::context::Context<Time>& context) const
            {
                _root.save(context.state());
                context.saved();
            }

            void switch_to_timed_observer(double step) { _observer.switch_to_timed_observer(step); }

            std::string to_string() const
            {
                std::ostringstream ss;

                ss << _root.to_string(0);
                return ss.str();
            }

        private :
            Coordinator _root;
            observer::Observer<Time> _observer;
            typename Time::type _t_max;
            typename Time::type _tn;
        };

    }
} // namespace artis common

#endif