Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
kill hollow doxygen comments
[simgrid.git] / src / surf / surf_interface.hpp
index 3bd2394..01623b2 100644 (file)
@@ -11,6 +11,8 @@
 #include <string>
 #include <vector>
 #include <memory>
+#include <utility>
+
 #include <boost/function.hpp>
 #include <boost/intrusive/list.hpp>
 #include "surf/trace_mgr.h"
 
 #ifdef LIBSIGC
 #include <sigc++/sigc++.h>
-#define surf_callback(arg1, ...)  sigc::signal<arg1,__VA_ARGS__>
-#define surf_callback_connect(callback, fun_ptr) callback.connect(sigc::ptr_fun(fun_ptr))
-#define surf_callback_emit(callback, ...) callback.emit(__VA_ARGS__)
+namespace simgrid {
+namespace surf {
+  // Wraps sigc++ signals with the interface of boost::signals2:
+  template<class T> class signal;
+  template<class R, class... P>
+  class signal<R(P...)> {
+  private:
+    sigc::signal<R, P...> sig_;
+  public:
+    template<class T> XBT_ALWAYS_INLINE
+    void connect(T&& slot)
+    {
+      sig_.connect(std::forward<T>(slot));
+    }
+    template<class Res, class... Args> XBT_ALWAYS_INLINE
+    void connect(Res(*slot)(Args...))
+    {
+      sig_.connect(sigc::ptr_fun(slot));
+    }
+    template<class... Args>
+    R operator()(Args&&... args) const
+    {
+      return sig_.emit(std::forward<Args>(args)...);
+    }
+  };
+}
+}
 #else
 #include <boost/signals2.hpp>
-#define surf_callback(arg1, ...)  boost::signals2::signal<arg1(__VA_ARGS__)>
+namespace simgrid {
+namespace surf {
+  template<class T>
+  using signal = ::boost::signals2::signal<T>;
+}
+}
+#endif
+
+// Deprecated:
+#define surf_callback(arg1, ...)  ::simgrid::surf::signal<arg1(__VA_ARGS__)>
 #define surf_callback_connect(callback, fun_ptr) callback.connect(fun_ptr)
 #define surf_callback_emit(callback, ...) callback(__VA_ARGS__)
-#endif
 
 #ifdef _MSC_VER
 #pragma warning( disable : 4251)
@@ -281,74 +315,40 @@ XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
  */
 XBT_PUBLIC_CLASS Model {
 public:
-  /** @brief Constructor */
   Model();
-  /** @brief Destructor */
   virtual ~Model();
 
   virtual void addTraces() =0;
 
-  /**
-   * @brief Get the set of [actions](@ref Action) in *ready* state
-   *
-   * @return The set of [actions](@ref Action) in *ready* state
-   */
+  /** @brief Get the set of [actions](@ref Action) in *ready* state */
   virtual ActionList* getReadyActionSet() {return p_readyActionSet;}
 
-  /**
-   * @brief Get the set of [actions](@ref Action) in *running* state
-   *
-   * @return The set of [actions](@ref Action) in *running* state
-   */
+  /** @brief Get the set of [actions](@ref Action) in *running* state */
   virtual ActionList* getRunningActionSet() {return p_runningActionSet;}
 
-  /**
-   * @brief Get the set of [actions](@ref Action) in *failed* state
-   *
-   * @return The set of [actions](@ref Action) in *failed* state
-   */
+  /** @brief Get the set of [actions](@ref Action) in *failed* state */
   virtual ActionList* getFailedActionSet() {return p_failedActionSet;}
 
-  /**
-   * @brief Get the set of [actions](@ref Action) in *done* state
-   *
-   * @return The set of [actions](@ref Action) in *done* state
-   */
+  /** @brief Get the set of [actions](@ref Action) in *done* state */
   virtual ActionList* getDoneActionSet() {return p_doneActionSet;}
 
-  /**
-   * @brief Get the set of modified [actions](@ref Action)
-   *
-   * @return The set of modified [actions](@ref Action)
-   */
+  /** @brief Get the set of modified [actions](@ref Action) */
   virtual ActionLmmListPtr getModifiedSet() {return p_modifiedSet;}
 
-  /**
-   * @brief Get the maxmin system of the current Model
-   *
-   * @return The maxmin system of the current Model
-   */
+  /** @brief Get the maxmin system of the current Model */
   lmm_system_t getMaxminSystem() {return p_maxminSystem;}
 
   /**
    * @brief Get the update mechanism of the current Model
    * @see e_UM_t
-   *
-   * @return [description]
    */
   e_UM_t getUpdateMechanism() {return p_updateMechanism;}
 
-  /**
-   * @brief Get Action heap
-   * @details [TODO]
-   *
-   * @return The Action heap
-   */
+  /** @brief Get Action heap */
   xbt_heap_t getActionHeap() {return p_actionHeap;}
 
   /**
-   * @brief share the resources
-   * @details Share the resources between the actions
+   * @brief Share the resources between the actions
    *
    * @param now The current time of the simulation
    * @return The delta of time till the next action will finish
@@ -361,8 +361,7 @@ public:
                                       void (*solve) (lmm_system_t));
 
   /**
-   * @brief Update state of actions
-   * @details Update action to the current time
+   * @brief Update action to the current time
    *
    * @param now The current time of the simulation
    * @param delta The delta of time since the last update
@@ -411,13 +410,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
@@ -426,7 +422,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
@@ -434,6 +430,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
    *
@@ -444,30 +443,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();
 
   /**
@@ -480,41 +464,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:
@@ -524,13 +486,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;