Remove 'using namespace foo;' in headers

[simgrid.git] / src / surf / surf_interface.hpp

diff --git a/src/surf/surf_interface.hpp b/src/surf/surf_interface.hpp
index de1665d..213e6d4 100644 (file)
--- a/src/surf/surf_interface.hpp
+++ b/src/surf/surf_interface.hpp
@@ -75,8 +75,6 @@ namespace surf {
 extern XBT_PRIVATE tmgr_history_t history;
 #define NO_MAX_DURATION -1.0
 
-using namespace std;
-
 /*********
  * Utils *
  *********/
@@ -399,8 +397,8 @@ private:
  * @brief Resource which have a metric handled by a maxmin system
  */
 typedef struct {
-  double scale;             /**< The scale of the metric */
-  double peak;              /**< The peak of the 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] */
   tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
 } s_surf_metric_t;
 
@@ -410,13 +408,10 @@ typedef struct {
  */
 XBT_PUBLIC_CLASS Resource {
 public:
-  /**
-   * @brief Resource constructor
-   */
   Resource();
 
   /**
-   * @brief Resource constructor
+   * @brief Constructor of non-LMM Resources
    *
    * @param model Model associated to this Resource
    * @param name The name of the Resource
@@ -425,7 +420,7 @@ public:
   Resource(Model *model, const char *name, xbt_dict_t props);
 
   /**
-   * @brief Resource constructor
+   * @brief Constructor of LMM Resources
    *
    * @param model Model associated to this Resource
    * @param name The name of the Resource
@@ -433,6 +428,9 @@ public:
    * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
    */
   Resource(Model *model, const char *name, xbt_dict_t props, lmm_constraint_t constraint);
+
+  Resource(Model *model, const char *name, xbt_dict_t props, lmm_constraint_t constraint, e_surf_resource_state_t stateInit);
+
   /**
    * @brief Resource constructor
    *
@@ -443,30 +441,15 @@ public:
    */
   Resource(Model *model, const char *name, xbt_dict_t props, e_surf_resource_state_t stateInit);
 
-  /**
-   * @brief Resource destructor
-   */
   virtual ~Resource();
 
-  /**
-   * @brief Get the Model of the current Resource
-   *
-   * @return The Model of the current Resource
-   */
+  /** @brief Get the Model of the current Resource */
   Model *getModel();
 
-  /**
-   * @brief Get the name of the current Resource
-   *
-   * @return The name of the current Resource
-   */
+  /** @brief Get the name of the current Resource */
   const char *getName();
 
-  /**
-   * @brief Get the properties of the current Resource
-   *
-   * @return The properties of the current Resource
-   */
+  /** @brief Get the properties of the current Resource */
   virtual xbt_dict_t getProperties();
 
   /**
@@ -479,41 +462,19 @@ public:
    */
   virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0;
 
-  /**
-   * @brief Check if the current Resource is used
-   * @return true if the current Resource is used, false otherwise
-   */
+  /** @brief Check if the current Resource is used (if it currently serves an action) */
   virtual bool isUsed()=0;
 
-  /**
-   * @brief Check if the current Resource is active
-   *
-   * @return true if the current Resource is active, false otherwise
-   */
+  /** @brief Check if the current Resource is active */
   bool isOn();
-
-  /**
-   * @brief Turn on the current Resource
-   */
+  /** @brief Turn on the current Resource */
   void turnOn();
-
-  /**
-   * @brief Turn off the current Resource
-   */
+  /** @brief Turn off the current Resource */
   void turnOff();
 
-  /**
-   * @brief Get the [state](\ref e_surf_resource_state_t) of the current Resource
-   *
-   * @return The state of the currenrt Resource
-   */
+  /** @brief Get the [state](\ref e_surf_resource_state_t) of the current Resource */
   virtual e_surf_resource_state_t getState();
-
-  /**
-   * @brief Set the [state](\ref e_surf_resource_state_t) of the current Resource
-   *
-   * @param state The new state of the current Resource
-   */
+  /** @brief Set the [state](\ref e_surf_resource_state_t) of the current Resource */
   virtual void setState(e_surf_resource_state_t state);
 
 private:
@@ -523,13 +484,9 @@ private:
   bool m_running;
   e_surf_resource_state_t m_stateCurrent;
 
-  /* LMM */
-public:
-  /**
-   * @brief Get the lmm constraint associated to this Resource if it is part of a LMM component
-   *
-   * @return The lmm constraint associated to this Resource
-   */
+
+public: /* LMM */
+  /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component */
   lmm_constraint_t getConstraint();
 private:
   lmm_constraint_t p_constraint;