Fix doxygen warnings.

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

diff --git a/src/surf/storage_interface.hpp b/src/surf/storage_interface.hpp
index c606e11..d70771c 100644 (file)
--- a/src/surf/storage_interface.hpp
+++ b/src/surf/storage_interface.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
  * All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
@@ -30,6 +30,34 @@ typedef StorageAction *StorageActionPtr;
 class StorageAction;
 typedef StorageAction *StorageActionPtr;
 
+/*************
+ * Callbacks *
+ *************/
+
+/** @ingroup SURF_callbacks
+ * @brief Callbacks handler which emit the callbacks after Storage creation *
+ * @details Callback functions have the following signature: `void(StoragePtr)`
+ */
+extern surf_callback(void, StoragePtr) storageCreatedCallbacks;
+
+/** @ingroup SURF_callbacks
+ * @brief Callbacks handler which emit the callbacks after Storage destruction *
+ * @details Callback functions have the following signature: `void(StoragePtr)`
+ */
+extern surf_callback(void, StoragePtr) storageDestructedCallbacks;
+
+/** @ingroup SURF_callbacks
+ * @brief Callbacks handler which emit the callbacks after Storage State changed *
+ * @details Callback functions have the following signature: `void(StorageActionPtr)`
+ */
+extern surf_callback(void, StoragePtr) storageStateChangedCallbacks;
+
+/** @ingroup SURF_callbacks
+ * @brief Callbacks handler which emit the callbacks after StorageAction State changed *
+ * @details Callback functions have the following signature: `void(StorageActionPtr)`
+ */
+extern surf_callback(void, StorageActionPtr) storageActionStateChangedCallbacks;
+
 /*********
  * Model *
  *********/
@@ -57,10 +85,15 @@ public:
    * @param content_name [description]
    * @param content_type [description]
    * @param properties [description]
+   * @param attach [description]
    * @return The created Storage
    */
-  virtual StoragePtr createResource(const char* id, const char* type_id,
-                  const char* content_name, const char* content_type, xbt_dict_t properties)=0;
+  virtual StoragePtr createResource(const char* id,
+                                    const char* type_id,
+                                    const char* content_name,
+                                    const char* content_type,
+                                    xbt_dict_t properties,
+                                    const char *attach) = 0;
 
   xbt_dynar_t p_storageList;
 };
@@ -80,17 +113,14 @@ public:
    * @param model StorageModel associated to this Storage
    * @param name The name of the Storage
    * @param props Dictionary of properties associated to this Storage
-   * @param constraint The lmm constraint associated to this Storage if it is part of a LMM component
-   * @param model [description]
-   * @param name [description]
-   * @param props [description]
    * @param type_id [description]
    * @param content_name [description]
    * @param content_type [description]
    * @param size [description]
    */
   Storage(ModelPtr model, const char *name, xbt_dict_t props,
-                 const char* type_id, char *content_name, char *content_type, sg_size_t size);
+          const char* type_id, char *content_name, char *content_type,
+          sg_size_t size);
 
   /**
    * @brief Storage constructor
@@ -98,7 +128,6 @@ public:
    * @param model StorageModel associated to this Storage
    * @param name The name of the Storage
    * @param props Dictionary of properties associated to this Storage
-   * @param constraint The lmm constraint associated to this Storage if it is part of a LMM component
    * @param maxminSystem [description]
    * @param bread [description]
    * @param bwrite [description]
@@ -107,10 +136,13 @@ public:
    * @param content_name [description]
    * @param content_type [description]
    * @param size [description]
+   * @param attach [description]
    */
   Storage(ModelPtr model, const char *name, xbt_dict_t props,
-                 lmm_system_t maxminSystem, double bread, double bwrite, double bconnection,
-                 const char* type_id, char *content_name, char *content_type, sg_size_t size);
+          lmm_system_t maxminSystem, double bread, double bwrite,
+          double bconnection,
+          const char* type_id, char *content_name, char *content_type,
+          sg_size_t size, char *attach);
 
   /**
    * @brief Storage destructor
@@ -133,11 +165,14 @@ public:
    */
   void updateState(tmgr_trace_event_t event_type, double value, double date);
 
+  void setState(e_surf_resource_state_t state);
+
   xbt_dict_t p_content;
   char* p_contentType;
   sg_size_t m_size;
   sg_size_t m_usedSize;
   char * p_typeId;
+  char* p_attach;
 
   /**
    * @brief Open a file
@@ -265,6 +300,8 @@ public:
   StorageAction(ModelPtr model, double cost, bool failed, lmm_variable_t var,
                            StoragePtr storage, e_surf_action_storage_type_t type);
 
+  void setState(e_surf_action_state_t state);
+
   e_surf_action_storage_type_t m_type;
   StoragePtr p_storage;
   surf_file_t p_file;
@@ -277,6 +314,7 @@ typedef struct s_storage_type {
   char *content_type;
   char *type_id;
   xbt_dict_t properties;
+  xbt_dict_t model_properties;
   sg_size_t size;
 } s_storage_type_t, *storage_type_t;