Update copyright lines for 2023.

[simgrid.git] / include / simgrid / kernel / resource / Model.hpp

diff --git a/include/simgrid/kernel/resource/Model.hpp b/include/simgrid/kernel/resource/Model.hpp
index 9520ef2..c5c09e4 100644 (file)
--- a/include/simgrid/kernel/resource/Model.hpp
+++ b/include/simgrid/kernel/resource/Model.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2023. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -6,7 +6,9 @@
 #ifndef SIMGRID_KERNEL_RESOURCE_MODEL_HPP
 #define SIMGRID_KERNEL_RESOURCE_MODEL_HPP
 
+#include <memory>
 #include <simgrid/kernel/resource/Action.hpp>
+#include <unordered_map>
 
 namespace simgrid {
 namespace kernel {
@@ -26,37 +28,38 @@ public:
                    gets recomputed anyway. In that case, you'd better not try to be cleaver with lazy and go for
                    a simple full update.  */
   };
-
-  explicit Model(Model::UpdateAlgo algo);
+  explicit Model(const std::string& name);
+  Model(const Model&) = delete;
+  Model& operator=(const Model&) = delete;
 
   virtual ~Model();
 
+  bool is_update_lazy() const { return update_algorithm_ == UpdateAlgo::LAZY; }
+  Model* set_update_algorithm(UpdateAlgo algo);
+
   /** @brief Get the set of [actions](@ref Action) in *inited* state */
-  Action::StateSet* get_inited_action_set() const { return inited_action_set_; }
+  Action::StateSet* get_inited_action_set() { return &inited_action_set_; }
 
   /** @brief Get the set of [actions](@ref Action) in *started* state */
-  Action::StateSet* get_started_action_set() const { return started_action_set_; }
+  Action::StateSet* get_started_action_set() { return &started_action_set_; }
 
   /** @brief Get the set of [actions](@ref Action) in *failed* state */
-  Action::StateSet* get_failed_action_set() const { return failed_action_set_; }
+  Action::StateSet* get_failed_action_set() { return &failed_action_set_; }
 
   /** @brief Get the set of [actions](@ref Action) in *finished* state */
-  Action::StateSet* get_finished_action_set() const { return finished_action_set_; }
+  Action::StateSet* get_finished_action_set() { return &finished_action_set_; }
 
   /** @brief Get the set of [actions](@ref Action) in *ignored* state */
-  Action::StateSet* get_ignored_action_set() const { return ignored_action_set_; }
+  Action::StateSet* get_ignored_action_set() { return &ignored_action_set_; }
 
   /** @brief Get the set of modified [actions](@ref Action) */
   Action::ModifiedSet* get_modified_set() const;
 
   /** @brief Get the maxmin system of the current Model */
-  lmm::System* get_maxmin_system() const { return maxmin_system_; }
+  lmm::System* get_maxmin_system() const { return maxmin_system_.get(); }
 
   /** @brief Set the maxmin system of the current Model */
-  void set_maxmin_system(lmm::System* system) { maxmin_system_ = system; }
-
-  /** @brief Get the update algorithm of the current Model */
-  UpdateAlgo get_update_algorithm() const { return update_algorithm_; }
+  void set_maxmin_system(lmm::System* system);
 
   /** @brief Get Action heap */
   ActionHeap& get_action_heap() { return action_heap_; }
@@ -67,9 +70,9 @@ public:
    * @param now The current time of the simulation
    * @return The delta of time till the next action will finish
    */
-  virtual double next_occuring_event(double now);
-  virtual double next_occuring_event_lazy(double now);
-  virtual double next_occuring_event_full(double now);
+  virtual double next_occurring_event(double now);
+  virtual double next_occurring_event_lazy(double now);
+  virtual double next_occurring_event_full(double now);
 
 private:
   Action* extract_action(Action::StateSet* list);
@@ -90,19 +93,23 @@ public:
 
   /** @brief Returns whether this model have an idempotent share_resource()
    *
-   * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
+   * The only model that is not is ns-3: computing the next timestamp moves the model up to that point,
    * so we need to call it only when the next timestamp of other sources is computed.
    */
-  virtual bool next_occuring_event_is_idempotent() { return true; }
+  virtual bool next_occurring_event_is_idempotent() { return true; }
+
+  /** @brief Gets the model name */
+  std::string get_name() const { return name_; }
 
 private:
-  lmm::System* maxmin_system_           = nullptr;
-  const UpdateAlgo update_algorithm_;
-  Action::StateSet* inited_action_set_  = new Action::StateSet(); /**< Created not started */
-  Action::StateSet* started_action_set_  = new Action::StateSet(); /**< Started not done */
-  Action::StateSet* failed_action_set_  = new Action::StateSet(); /**< Done with failure */
-  Action::StateSet* finished_action_set_ = new Action::StateSet(); /**< Done successful */
-  Action::StateSet* ignored_action_set_  = new Action::StateSet(); /**< not considered (failure detectors?) */
+  UpdateAlgo update_algorithm_ = UpdateAlgo::FULL;
+  std::unique_ptr<lmm::System> maxmin_system_;
+  Action::StateSet inited_action_set_;   /**< Created not started */
+  Action::StateSet started_action_set_;  /**< Started not done */
+  Action::StateSet failed_action_set_;   /**< Done with failure */
+  Action::StateSet finished_action_set_; /**< Done successful */
+  Action::StateSet ignored_action_set_;  /**< not considered (failure detectors?) */
+  const std::string name_;               /**< Model name */
 
   ActionHeap action_heap_;
 };
@@ -111,9 +118,4 @@ private:
 } // namespace kernel
 } // namespace simgrid
 
-/** @ingroup SURF_models
- *  @brief List of initialized models
- */
-XBT_PUBLIC_DATA std::vector<simgrid::kernel::resource::Model*> all_existing_models;
-
 #endif