Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add some s4u::Link setters, and doc improvements
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Wed, 26 Aug 2020 08:00:41 +0000 (10:00 +0200)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Wed, 26 Aug 2020 08:01:29 +0000 (10:01 +0200)
docs/source/app_s4u.rst
examples/README.rst
include/simgrid/s4u/Link.hpp

index 4fd78f7..eaf51dd 100644 (file)
@@ -1365,6 +1365,16 @@ Querying info
       .. autodoxymethod:: sg_link_latency(const_sg_link_t link)
       .. autodoxymethod:: sg_link_name(const_sg_link_t link)
 
+Modifying characteristics
+-------------------------
+
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. autodoxymethod:: simgrid::s4u::Link::set_bandwidth(double value)
+      .. autodoxymethod:: simgrid::s4u::Link::set_latency(double value)
+
 User data and properties
 ------------------------
 
@@ -1413,7 +1423,7 @@ WIFI links
 
    .. group-tab:: C++
 
-      .. autodoxymethod:: simgrid::s4u::Link::set_host_wifi_rate(s4u::Host* host, int level)
+      .. autodoxymethod:: simgrid::s4u::Link::set_host_wifi_rate(const s4u::Host* host, int level) const
 
 Signals
 -------
index 7a4d9fd..32222e3 100644 (file)
@@ -147,7 +147,7 @@ Starting and Stopping Actors
 
   - **Specify the stack size to use**
     The stack size can be specified by default on the command line,
-    globally by changing the configuration with :cpp:func:`simgrid::s4u::Engine::set_config(std::string)`, 
+    globally by changing the configuration with :cpp:func:`simgrid::s4u::Engine::set_config`,
     or for a specific actor using :cpp:func:`simgrid::s4u::Actor::set_stacksize` before its start.
     
     .. tabs::
index 6dbf49e..11212f9 100644 (file)
@@ -52,12 +52,14 @@ public:
   /** @brief Retrieves the name of that link as a C string */
   const char* get_cname() const;
 
-  /** @brief Get the bandwidth in bytes per second of current Link */
+  /** Get the bandwidth of the current Link (in bytes per second) */
   double get_bandwidth() const;
+  /** Set the bandwidth of the current Link (in bytes per second) */
   void set_bandwidth(double value);
 
-  /** @brief Get the latency in seconds of current Link */
+  /** Get the latency of the current Link (in seconds) */
   double get_latency() const;
+  /** Set the latency of the current Link (in seconds) */
   void set_latency(double value);
 
   /** @brief Describes how the link is shared between flows */