Deprecate the is_off() methods.

[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 3ae1096..ced4543 100644 (file)
--- a/include/simgrid/kernel/resource/Resource.hpp
+++ b/include/simgrid/kernel/resource/Resource.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2019. 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. */
@@ -45,26 +45,31 @@ public:
   bool operator==(const Resource& other) const;
 
   /** @brief Apply an event of external load event to that resource */
-  virtual void apply_event(TraceEvent* event, double value) = 0;
+  virtual void apply_event(profile::Event* 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 due to activities (in flops per second, byte per second or similar)
    *
-   * The load due to external usages modeled by trace files is ignored.*/
+   * The load due to external usages modeled by profile files is ignored.*/
   virtual double get_load();
 
   /** @brief Check if the current Resource is active */
   virtual bool is_on() const;
   /** @brief Check if the current Resource is shut down */
-  virtual bool is_off() const;
+  XBT_ATTRIB_DEPRECATED_v325("Please use !is_on()") virtual bool is_off() const;
   /** @brief Turn on the current Resource */
   virtual void turn_on();
   /** @brief Turn off the current Resource */
   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);
+  /** @brief setup the profile file with states events (ON or OFF). The profile must contain boolean values. */
+  virtual void set_state_profile(profile::Profile* profile);
+
+#ifndef DOXYGEN
+  XBT_ATTRIB_DEPRECATED_v325("Please use Resource::set_state_profile()") virtual void set_state_trace(
+      profile::Profile* profile) { set_state_profile(profile); }
+#endif
 
 private:
   std::string name_;
@@ -79,13 +84,13 @@ private:
   kernel::lmm::Constraint* const constraint_ = nullptr;
 
 public:
-  TraceEvent* state_event_ = nullptr;
+  profile::Event* state_event_ = nullptr;
 
 protected:
   struct Metric {
     double peak;       /**< The peak of the metric, ie its max value */
-    double scale;      /**< Current availability of the metric according to the traces, in [0,1] */
-    TraceEvent* event; /**< The associated trace event associated to the metric */
+    double scale;      /**< Current availability of the metric according to the profiles, in [0,1] */
+    profile::Event* event; /**< The associated profile event associated to the metric */
   };
 };
 } // namespace resource