Dynamics.hpp 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. /**
  2. * @file kernel/pdevs/Dynamics.hpp
  3. * @author The ARTIS Development Team
  4. * See the AUTHORS or Authors.txt file
  5. */
  6. /*
  7. * ARTIS - the multimodeling and simulation environment
  8. * This file is a part of the ARTIS environment
  9. *
  10. * Copyright (C) 2013-2019 ULCO http://www.univ-littoral.fr
  11. *
  12. * This program is free software: you can redistribute it and/or modify
  13. * it under the terms of the GNU General Public License as published by
  14. * the Free Software Foundation, either version 3 of the License, or
  15. * (at your option) any later version.
  16. *
  17. * This program is distributed in the hope that it will be useful,
  18. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  20. * GNU General Public License for more details.
  21. *
  22. * You should have received a copy of the GNU General Public License
  23. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24. */
  25. #ifndef PDEVS_DYNAMICS
  26. #define PDEVS_DYNAMICS
  27. #include <artis-star/common/Bag.hpp>
  28. #include <artis-star/common/ExternalEvent.hpp>
  29. #include <artis-star/common/Parameters.hpp>
  30. #include <artis-star/common/States.hpp>
  31. #include <artis-star/kernel/pdevs/Simulator.hpp>
  32. #include <string>
  33. #include <vector>
  34. namespace artis {
  35. namespace pdevs {
  36. template<class Time, class Dyn, class Parameters = common::NoParameters>
  37. class Dynamics : public common::States<Time, Dyn>
  38. {
  39. typedef pdevs::Simulator<Time, Dyn, Parameters> Simulator;
  40. public:
  41. struct Observable
  42. {
  43. unsigned int index;
  44. std::string name;
  45. };
  46. typedef std::map<unsigned int, std::string> Observables;
  47. Dynamics(const std::string &name, const Context<Time, Dyn, Parameters> &context)
  48. :
  49. _name(name), _simulator(context.simulator())
  50. {}
  51. virtual ~Dynamics()
  52. {}
  53. virtual void
  54. dconf(const typename Time::type & /* t */, const typename Time::type & /* e */,
  55. const common::Bag<Time> & /* bag */)
  56. {}
  57. virtual void dint(const typename Time::type & /* t */)
  58. {}
  59. virtual void
  60. dext(const typename Time::type & /* t */, const typename Time::type & /* e */,
  61. const common::Bag<Time> & /* bag */)
  62. {}
  63. virtual void start(const typename Time::type & /* time */)
  64. {}
  65. virtual typename Time::type
  66. ta(const typename Time::type & /* time */) const
  67. { return Time::infinity; }
  68. virtual common::Bag<Time>
  69. lambda(const typename Time::type & /* time */) const
  70. { return common::Bag<Time>(); }
  71. virtual common::Value observe(const typename Time::type & /* t */,
  72. unsigned int /* index */) const
  73. { return common::Value(); }
  74. virtual typename Time::type lookahead(const typename Time::type &t) const
  75. { return t; }
  76. const std::string &get_name() const
  77. { return _name; }
  78. void input_port(common::Port p)
  79. {
  80. _simulator->add_in_port(p);
  81. }
  82. size_t input_port_number() const
  83. { return _simulator->get_in_port_number(); }
  84. void input_ports(std::initializer_list<common::Port> list)
  85. {
  86. for (typename std::initializer_list<common::Port>::iterator it = list.begin();
  87. it != list.end();
  88. ++it) {
  89. _simulator->add_in_port(*it);
  90. }
  91. }
  92. void observable(Observable observable)
  93. {
  94. _observables[observable.index] = observable.name;
  95. }
  96. void observables(std::initializer_list<Observable> list)
  97. {
  98. for (typename std::initializer_list<Observable>::iterator it = list.begin();
  99. it != list.end();
  100. ++it) {
  101. _observables[it->index] = it->name;
  102. }
  103. }
  104. virtual std::string observable_name(unsigned int observable_index) const
  105. {
  106. assert(_observables.find(observable_index) != _observables.end());
  107. return _observables.find(observable_index)->second;
  108. }
  109. void output_port(common::Port p)
  110. {
  111. _simulator->add_out_port(p);
  112. }
  113. size_t output_port_number() const
  114. { return _simulator->get_out_port_number(); }
  115. void output_ports(std::initializer_list<common::Port> list)
  116. {
  117. for (typename std::initializer_list<common::Port>::iterator it =
  118. list.begin(); it != list.end(); ++it) {
  119. _simulator->add_out_port(*it);
  120. }
  121. }
  122. void restore(const common::context::State<Time> &state)
  123. {
  124. common::States<Time, Dyn>::restore(static_cast<Dyn *>(this), state);
  125. }
  126. void save(common::context::State<Time> &state) const
  127. {
  128. common::States<Time, Dyn>::save(static_cast<const Dyn *>(this), state);
  129. }
  130. private:
  131. std::string _name;
  132. Simulator *_simulator;
  133. Observables _observables;
  134. };
  135. }
  136. } // namespace artis pdevs
  137. #endif