X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/ca7838c3440b5dab4545fc2ebdfc52ff0717cf3a..659ba669d7e5726c70f22d33f62efec4f267f994:/src/simdag/sd_link.c

diff --git a/src/simdag/sd_link.c b/src/simdag/sd_link.c
index 637a6e28eb..33448bf354 100644
--- a/src/simdag/sd_link.c
+++ b/src/simdag/sd_link.c
@@ -4,24 +4,67 @@
 #include "xbt/sysdep.h"
 #include "surf/surf.h"
 
-/* Creates a link.
+/* Creates a link and registers it in SD.
  */
 SD_link_t __SD_link_create(void *surf_link, void *data) {
   SD_CHECK_INIT_DONE();
   xbt_assert0(surf_link != NULL, "surf_link is NULL !");
 
-
   SD_link_t link = xbt_new0(s_SD_link_t, 1);
   link->surf_link = surf_link;
   link->data = data; /* user data */
 
   const char *name = SD_link_get_name(link);
-  xbt_dict_set(sd_global->links, name, link, __SD_link_destroy); /* add the workstation to the dictionary */
+  xbt_dict_set(sd_global->links, name, link, __SD_link_destroy); /* add the link to the dictionary */
+  sd_global->link_count++;
 
   return link;
 }
+/**
+ * \brief Returns the link list
+ *
+ * Use SD_link_get_number() to know the array size.
+ *
+ * \return an array of \ref SD_link_t containing all links
+ * \see SD_link_get_number()
+ */
+const SD_link_t*  SD_link_get_list(void) {
+  SD_CHECK_INIT_DONE();
+  xbt_assert0(SD_link_get_number() > 0, "There is no link!");
+
+  xbt_dict_cursor_t cursor;
+  char *key;
+  void *data;
+  int i;
+
+  if (sd_global->link_list == NULL) { /* this is the first time the function is called */
+    sd_global->link_list = xbt_new0(SD_link_t, sd_global->link_count);
+  
+    i = 0;
+    xbt_dict_foreach(sd_global->links, cursor, key, data) {
+      sd_global->link_list[i++] = (SD_link_t) data;
+    }
+  }
+  return sd_global->link_list;
+}
 
-/* Returns the user data of a link. The user data can be NULL.
+/**
+ * \brief Returns the number of links
+ *
+ * \return the number of existing links
+ * \see SD_link_get_list()
+ */
+int SD_link_get_number(void) {
+  SD_CHECK_INIT_DONE();
+  return sd_global->link_count;
+}
+
+/**
+ * \brief Returns the user data of a link
+ *
+ * \param link a link
+ * \return the user data associated with this link (can be \c NULL)
+ * \see SD_link_set_data()
  */
 void* SD_link_get_data(SD_link_t link) {
   SD_CHECK_INIT_DONE();
@@ -29,7 +72,15 @@ void* SD_link_get_data(SD_link_t link) {
   return link->data;
 }
 
-/* Sets the user data of a link. The new data can be NULL. The old data should have been freed first if it was not NULL.
+/**
+ * \brief Sets the user data of a link
+ *
+ * The new data can be \c NULL. The old data should have been freed first
+ * if it was not \c NULL.
+ *
+ * \param link a link
+ * \param data the new data you want to associate with this link
+ * \see SD_link_get_data()
  */
 void SD_link_set_data(SD_link_t link, void *data) {
   SD_CHECK_INIT_DONE();
@@ -37,7 +88,11 @@ void SD_link_set_data(SD_link_t link, void *data) {
   link->data = data;
 }
 
-/* Returns the name of a link. The name cannot be NULL.
+/**
+ * \brief Returns the name of a link
+ *
+ * \param link a link
+ * \return the name of this link (cannot be \c NULL)
  */
 const char* SD_link_get_name(SD_link_t link) {
   SD_CHECK_INIT_DONE();
@@ -45,15 +100,11 @@ const char* SD_link_get_name(SD_link_t link) {
   return surf_workstation_resource->extension_public->get_link_name(link->surf_link);
 }
 
-/* Returns the capacity of a link.
- */
-/*
-double SD_link_get_capacity(SD_link_t link) {
-  xbt_assert0(link, "Invalid parameter");
-  return link->capacity;
-}*/
-
-/* Return the current bandwidth of a link.
+/**
+ * \brief Returns the current bandwidth of a link
+ *
+ * \param link a link
+ * \return the current bandwidth of this link, in Flops
  */
 double SD_link_get_current_bandwidth(SD_link_t link) {
   SD_CHECK_INIT_DONE();
@@ -61,7 +112,11 @@ double SD_link_get_current_bandwidth(SD_link_t link) {
   return surf_workstation_resource->extension_public->get_link_bandwidth(link->surf_link);
 }
 
-/* Return the current latency of a link.
+/**
+ * \brief Returns the current latency of a link
+ *
+ * \param link a link
+ * \return the current latency of this link, in seconds
  */
 double SD_link_get_current_latency(SD_link_t link) {
   SD_CHECK_INIT_DONE();
@@ -69,7 +124,7 @@ double SD_link_get_current_latency(SD_link_t link) {
   return surf_workstation_resource->extension_public->get_link_latency(link->surf_link);
 }
 
-/* Destroys a link. The user data (if any) should have been destroyed first.
+/* Destroys a link.
  */
 void __SD_link_destroy(void *link) {
   SD_CHECK_INIT_DONE();