snake_case some resource::Action fields and cleanups

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

diff --git a/include/simgrid/kernel/resource/Action.hpp b/include/simgrid/kernel/resource/Action.hpp
index 39a2a07..47efce3 100644 (file)
--- a/include/simgrid/kernel/resource/Action.hpp
+++ b/include/simgrid/kernel/resource/Action.hpp
@@ -24,23 +24,20 @@ typedef boost::heap::pairing_heap<heap_element_type, boost::heap::constant_time_
                                   boost::heap::compare<simgrid::xbt::HeapComparator<heap_element_type>>>
     heap_type;
 
-/** @ingroup SURF_interface
- * @brief SURF action interface class
- * @details An action is an event generated by a resource (e.g.: a communication for the network)
- */
+/** @details An action is a consumption on a resource (e.g.: a communication for the network) */
 class XBT_PUBLIC Action {
 public:
-  boost::intrusive::list_member_hook<> modifiedSetHook_; /* Used by the lazy update to list the actions to track */
-  bool isLinkedModifiedSet() const { return modifiedSetHook_.is_linked(); }
-
-  typedef boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::modifiedSetHook_>
-      ActionLmmOptions;
-  typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
-
-  boost::intrusive::list_member_hook<> stateSetHook_;
-  typedef boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::stateSetHook_>
-      ActionOptions;
-  typedef boost::intrusive::list<Action, ActionOptions> ActionList;
+  /* Lazy update needs this Set hook to maintain a list of the tracked actions */
+  boost::intrusive::list_member_hook<> modified_set_hook_;
+  bool isLinkedModifiedSet() const { return modified_set_hook_.is_linked(); }
+  typedef boost::intrusive::list<
+      Action, boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::modified_set_hook_>>
+      ModifiedSet;
+
+  boost::intrusive::list_member_hook<> state_set_hook_;
+  typedef boost::intrusive::list<
+      Action, boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::state_set_hook_>>
+      StateSet;
 
   enum class State {
     ready = 0,        /**< Ready        */
@@ -66,7 +63,7 @@ public:
    * @param cost The cost of the Action
    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
    */
-  Action(simgrid::kernel::resource::Model* model, double cost, bool failed);
+  Action(Model* model, double cost, bool failed);
 
   /**
    * @brief Action constructor
@@ -76,7 +73,7 @@ public:
    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
    * @param var The lmm variable associated to this Action if it is part of a LMM component
    */
-  Action(simgrid::kernel::resource::Model* model, double cost, bool failed, kernel::lmm::Variable* var);
+  Action(Model* model, double cost, bool failed, lmm::Variable* var);
 
   virtual ~Action();
 
@@ -88,24 +85,24 @@ public:
   void finish(Action::State state);
 
   /** @brief Get the [state](\ref simgrid::kernel::resource::Action::State) of the current Action */
-  Action::State getState() const; /**< get the state*/
+  Action::State get_state() const; /**< get the state*/
   /** @brief Set the [state](\ref simgrid::kernel::resource::Action::State) of the current Action */
-  virtual void setState(Action::State state);
+  virtual void set_state(Action::State state);
 
   /** @brief Get the bound of the current Action */
-  double getBound() const;
+  double get_bound() const;
   /** @brief Set the bound of the current Action */
-  void setBound(double bound);
+  void set_bound(double bound);
 
   /** @brief Get the start time of the current action */
-  double getStartTime() const { return start_; }
+  double get_start_time() const { return start_time_; }
   /** @brief Get the finish time of the current action */
   double getFinishTime() const { return finish_time_; }
 
   /** @brief Get the user data associated to the current action */
-  void* getData() const { return data_; }
+  void* get_data() const { return data_; }
   /** @brief Set the user data associated to the current action */
-  void setData(void* data) { data_ = data; }
+  void set_data(void* data) { data_ = data; }
 
   /** @brief Get the cost of the current action */
   double getCost() const { return cost_; }
@@ -166,19 +163,19 @@ public:
   void setSharingWeightNoUpdate(double weight) { sharing_weight_ = weight; }
 
   /** @brief Get the state set in which the action is */
-  ActionList* getStateSet() const { return state_set_; };
+  StateSet* getStateSet() const { return state_set_; };
 
   simgrid::kernel::resource::Model* getModel() const { return model_; }
 
 protected:
-  ActionList* state_set_;
+  StateSet* state_set_;
   int refcount_ = 1;
 
 private:
   double sharing_weight_ = 1.0;             /**< priority (1.0 by default) */
   double max_duration_   = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
   double remains_;           /**< How much of that cost remains to be done in the currently running task */
-  double start_;             /**< start time  */
+  double start_time_;        /**< start time  */
   char* category_ = nullptr; /**< tracing category for categorized resource utilization monitoring */
   double finish_time_ =
       -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
@@ -212,9 +209,6 @@ protected:
   Action::SuspendStates suspended_ = Action::SuspendStates::not_suspended;
 };
 
-typedef Action::ActionList ActionList;
-typedef Action::ActionLmmList ActionLmmList;
-typedef Action::ActionLmmList* ActionLmmListPtr;
 } // namespace resource
 } // namespace kernel
 } // namespace simgrid