123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156 |
- /**
- * @file common/Coordinator.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-2022 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_COORDINATOR
- #define COMMON_COORDINATOR
- #include "artis-star/common/event/Bag.hpp"
- #include "artis-star/common/event/ExternalEvent.hpp"
- #include <artis-star/common/Links.hpp>
- #include <artis-star/common/Model.hpp>
- #include <artis-star/common/Node.hpp>
- #include <sstream>
- namespace artis::common {
- template<typename Time>
- class Model;
- template<typename Time>
- class GraphManager;
- template<typename Time>
- class Coordinator : public virtual Model<Time> {
- public :
- Coordinator(const std::string &name)
- : Model<Time>(name) {}
- virtual ~Coordinator() {}
- virtual GraphManager<Time> &get_graph_manager() = 0;
- virtual const GraphManager<Time> &get_graph_manager() const = 0;
- virtual const Model<Time> *get_sub_model(unsigned int index) const {
- const GraphManager<Time> &graph_manager = get_graph_manager();
- typename common::ModelMap<Time>::const_iterator it = graph_manager.child_map().find(
- index);
- if (it != graph_manager.child_map().end()) {
- return it->second;
- } else {
- return nullptr;
- }
- }
- virtual const Model<Time> *get_sub_model(unsigned int index, unsigned int rank) const {
- const GraphManager<Time> &graph_manager = get_graph_manager();
- typename common::ModelsMap<Time>::const_iterator it = graph_manager.children_map().find(
- index);
- if (it != graph_manager.children_map().end() and it->second.size() > rank) {
- return it->second.at(rank);
- } else {
- return nullptr;
- }
- }
- virtual unsigned int get_sub_model_number(unsigned int index) const {
- const GraphManager<Time> &graph_manager = get_graph_manager();
- typename common::ModelsMap<Time>::const_iterator it = graph_manager.children_map().find(
- index);
- if (it != graph_manager.children_map().end()) {
- return it->second.size();
- } else {
- return 0;
- }
- }
- void input_port(common::Port p) { Coordinator<Time>::add_in_port(p); }
- void input_ports(std::initializer_list<common::Port> list) {
- for (typename std::initializer_list<common::Port>::iterator it = list.begin();
- it != list.end();
- ++it) {
- Coordinator<Time>::add_in_port(*it);
- }
- }
- virtual bool is_atomic() const { return false; }
- void output_port(common::Port p) { Coordinator<Time>::add_out_port(p); }
- void output_ports(std::initializer_list<common::Port> list) {
- for (typename std::initializer_list<common::Port>::iterator it = list.begin();
- it != list.end();
- ++it) {
- Coordinator<Time>::add_out_port(*it);
- }
- }
- virtual void remove_model(const typename Time::type &t, common::Model<Time> *model) {
- model->finish(t);
- }
- void restore(const common::context::State<Time> &state) {
- Model<Time>::restore(state);
- get_graph_manager().restore(state);
- }
- void save(common::context::State<Time> &state) const {
- Model<Time>::save(state);
- get_graph_manager().save(state);
- }
- virtual std::string to_string(int /* level */) const {
- std::ostringstream ss;
- ss << "Coordinator " << Coordinator<Time>::get_name();
- return ss.str();
- }
- // DEVS methods
- virtual void finish(const typename Time::type &t) = 0;
- virtual common::event::Value observe(const typename Time::type &t, unsigned int index) const = 0;
- virtual void output(const typename Time::type &t) = 0;
- virtual void post_event(const typename Time::type &t, const common::event::ExternalEvent<Time> &event) = 0;
- virtual typename Time::type dispatch_events(const common::event::Bag<Time> &bag,
- const typename Time::type &t) = 0;
- virtual typename Time::type start(const typename Time::type &t) = 0;
- virtual typename Time::type transition(const typename Time::type &t) = 0;
- };
- } // namespace artis common
- #endif
|