Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Pass std::string parameters by reference too.
[simgrid.git] / include / simgrid / kernel / resource / Action.hpp
index c8e20eb..ca85918 100644 (file)
@@ -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. */
@@ -12,6 +12,7 @@
 
 #include <boost/heap/pairing_heap.hpp>
 #include <boost/optional.hpp>
+#include <string>
 
 static constexpr int NO_MAX_DURATION = -1.0;
 
@@ -41,7 +42,6 @@ public:
   void update(Action* action, double date, ActionHeap::Type type);
   void remove(Action* action);
   Action* pop();
-  bool empty() const { return heap_type::empty(); }
 };
 
 /** @details An action is a consumption on a resource (e.g.: a communication for the network).
@@ -66,11 +66,12 @@ public:
       StateSet;
 
   enum class State {
-    inited,  /**< Created, but not started yet */
-    running, /**< Started, currently running */
-    failed,  /**< Completed (unsuccessfully: either the resource failed, or the action was canceled) */
-    done,    /**< Completed (successfully) */
-    ignored  /**< e.g. failure detectors, these infinite sleep actions that are put on resources which failure should be notified */
+    INITED,   /**< Created, but not started yet */
+    STARTED,  /**< Currently running */
+    FAILED,   /**< either the resource failed, or the action was canceled */
+    FINISHED, /**< Successfully completed  */
+    IGNORED   /**< e.g. failure detectors: infinite sleep actions that are put on resources which failure should get
+                 noticed  */
   };
 
   enum class SuspendStates {
@@ -97,19 +98,21 @@ public:
    * @param var The lmm variable associated to this Action if it is part of a LMM component
    */
   Action(Model* model, double cost, bool failed, lmm::Variable* var);
+  Action(const Action&) = delete;
+  Action& operator=(const Action&) = delete;
 
   virtual ~Action();
 
   /**
    * @brief Mark that the action is now finished
    *
-   * @param state the new [state](\ref simgrid::kernel::resource::Action::State) of the current Action
+   * @param state the new [state](@ref simgrid::kernel::resource::Action::State) of the current Action
    */
   void finish(Action::State state);
 
-  /** @brief Get the [state](\ref simgrid::kernel::resource::Action::State) of the current Action */
+  /** @brief Get the [state](@ref simgrid::kernel::resource::Action::State) of the current Action */
   Action::State get_state() const; /**< get the state*/
-  /** @brief Set the [state](\ref simgrid::kernel::resource::Action::State) of the current Action */
+  /** @brief Set the [state](@ref simgrid::kernel::resource::Action::State) of the current Action */
   virtual void set_state(Action::State state);
 
   /** @brief Get the bound of the current Action */
@@ -157,7 +160,7 @@ public:
   void ref();
   /** @brief Unref that action (and destroy it if refcount reaches 0)
    *  @return true if the action was destroyed and false if someone still has references on it */
-  int unref();
+  bool unref();
 
   /** @brief Cancel the current Action if running */
   virtual void cancel();
@@ -177,9 +180,9 @@ public:
   virtual void set_max_duration(double duration);
 
   /** @brief Get the tracing category associated to the current action */
-  char* get_category() const { return category_; }
+  const std::string& get_category() const { return category_; }
   /** @brief Set the tracing category of the current Action */
-  void set_category(const char* category);
+  void set_category(const std::string& category) { category_ = category; }
 
   /** @brief Get the priority of the current Action */
   double get_priority() const { return sharing_priority_; };
@@ -202,7 +205,7 @@ private:
   double remains_;           /**< How much of that cost remains to be done in the currently running task */
   double start_time_;        /**< start time  */
   double finish_time_ = -1;  /**< finish time (may fluctuate until the task is completed) */
-  char* category_     = nullptr; /**< tracing category for categorized resource utilization monitoring */
+  std::string category_;     /**< tracing category for categorized resource utilization monitoring */
 
   double cost_;
   simgrid::kernel::resource::Model* model_;