factor attachment of state traces to resources

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

diff --git a/include/simgrid/kernel/resource/Resource.hpp b/include/simgrid/kernel/resource/Resource.hpp
index 7c8c075..3ae1096 100644 (file)
--- a/include/simgrid/kernel/resource/Resource.hpp
+++ b/include/simgrid/kernel/resource/Resource.hpp
@@ -35,37 +35,36 @@ public:
   virtual ~Resource();
 
   /** @brief Get the Model of the current Resource */
-  Model* model() const;
+  Model* get_model() const;
 
   /** @brief Get the name of the current Resource */
-  const std::string& getName() const;
+  const std::string& get_name() const;
   /** @brief Get the name of the current Resource */
-  const char* getCname() const;
+  const char* get_cname() const;
 
   bool operator==(const Resource& other) const;
 
-  /**
-   * @brief Apply an event of external load event to that resource
-   *
-   * @param event What happened
-   * @param value [TODO]
-   */
+  /** @brief Apply an event of external load event to that resource */
   virtual void apply_event(TraceEvent* event, double value) = 0;
 
   /** @brief Check if the current Resource is used (if it currently serves an action) */
   virtual bool is_used() = 0;
 
-  /** @brief returns the current load (in flops per second, byte per second or similar) */
-  virtual double getLoad();
+  /** @brief returns the current load due to activities (in flops per second, byte per second or similar)
+   *
+   * The load due to external usages modeled by trace files is ignored.*/
+  virtual double get_load();
 
   /** @brief Check if the current Resource is active */
-  virtual bool isOn() const;
+  virtual bool is_on() const;
   /** @brief Check if the current Resource is shut down */
-  virtual bool isOff() const;
+  virtual bool is_off() const;
   /** @brief Turn on the current Resource */
-  virtual void turnOn();
+  virtual void turn_on();
   /** @brief Turn off the current Resource */
-  virtual void turnOff();
+  virtual void turn_off();
+  /** @brief setup the trace file with states events (ON or OFF). Trace must contain boolean values. */
+  virtual void set_state_trace(tmgr_trace_t trace);
 
 private:
   std::string name_;
@@ -74,11 +73,14 @@ private:
 
 public: /* LMM */
   /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component (or null if none) */
-  kernel::lmm::Constraint* constraint() const;
+  lmm::Constraint* get_constraint() const;
 
 private:
   kernel::lmm::Constraint* const constraint_ = nullptr;
 
+public:
+  TraceEvent* state_event_ = nullptr;
+
 protected:
   struct Metric {
     double peak;       /**< The peak of the metric, ie its max value */
@@ -95,7 +97,7 @@ template <> class hash<simgrid::kernel::resource::Resource> {
 public:
   std::size_t operator()(const simgrid::kernel::resource::Resource& r) const
   {
-    return (std::size_t)xbt_str_hash(r.getCname());
+    return (std::size_t)xbt_str_hash(r.get_cname());
   }
 };
 } // namespace std