Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix some more doc bugs
[simgrid.git] / docs / source / Plugins.rst
index 9e4d12a..aab0fe0 100644 (file)
@@ -24,7 +24,8 @@ documents some of the plugins distributed with SimGrid:
   - :ref:`Link Energy <plugin_link_energy>`: models the energy dissipation of the network.
   - :ref:`WiFi Energy <plugin_link_energy_wifi>`: models the energy dissipation of wifi links.
   - :ref:`Battery <plugin_battery>`: models batteries that get discharged by the energy consumption of a given host.
-  - :ref:`Photovoltaic <plugin_photovoltaic>`: models photovoltaic panels which energy production depends on the solar irradiance.
+  - :ref:`Solar Panel <plugin_solar_panel>`: models solar panels which energy production depends on the solar irradiance.
+  - :ref:`Chiller <plugin_chiller>`: models chillers which dissipate heat by consuming energy.
 
 You can activate these plugins with the :ref:`--cfg=plugin <cfg=plugin>` command
 line option, for example with ``--cfg=plugin:host_energy``. You can get the full
@@ -69,7 +70,10 @@ kind of objects, please let us now.
 
   Fire that signal, invoking all callbacks.
 
-Partial list of existing signals in s4u:
+.. _s4u_API_signals:
+
+Existing signals
+================
 
 - In actors:
   :cpp:func:`Actor::on_creation <simgrid::s4u::Actor::on_creation_cb>`
@@ -140,18 +144,18 @@ Partial list of existing signals in s4u:
     :cpp:func:`Comm::on_this_start <simgrid::s4u::Comm::on_this_start_cb>`
     :cpp:func:`Comm::on_completion <simgrid::s4u::Comm::on_completion_cb>`
     :cpp:func:`Comm::on_this_completion <simgrid::s4u::Comm::on_this_completion_cb>`
-    :cpp:func:`Comm::on_suspend <simgrid::s4u::Comm::on_suspend_cb>`
-    :cpp:func:`Comm::on_this_suspend <simgrid::s4u::Comm::on_this_suspend_cb>`
+    :cpp:func:`Comm::on_suspended <simgrid::s4u::Comm::on_suspended_cb>`
+    :cpp:func:`Comm::on_this_suspended <simgrid::s4u::Comm::on_this_suspended_cb>`
     :cpp:func:`Comm::on_resume <simgrid::s4u::Comm::on_resume_cb>`
-    :cpp:func:`Comm::on_this_resume <simgrid::s4u::Comm::on_this_resume_cb>`
+    :cpp:func:`Comm::on_this_resumed <simgrid::s4u::Comm::on_this_resumed_cb>`
     :cpp:func:`Comm::on_veto <simgrid::s4u::Comm::on_veto_cb>`
     :cpp:func:`Comm::on_this_veto <simgrid::s4u::Comm::on_this_veto_cb>`
   - :cpp:func:`Exec::on_start <simgrid::s4u::Exec::on_start_cb>`
     :cpp:func:`Exec::on_this_start <simgrid::s4u::Exec::on_this_start_cb>`
     :cpp:func:`Exec::on_completion <simgrid::s4u::Exec::on_completion_cb>`
     :cpp:func:`Exec::on_this_completion <simgrid::s4u::Exec::on_this_completion_cb>`
-    :cpp:func:`Exec::on_suspend <simgrid::s4u::Exec::on_suspend_cb>`
-    :cpp:func:`Exec::on_this_suspend <simgrid::s4u::Exec::on_this_suspend_cb>`
+    :cpp:func:`Exec::on_suspended <simgrid::s4u::Exec::on_suspended_cb>`
+    :cpp:func:`Exec::on_this_suspended <simgrid::s4u::Exec::on_this_suspended_cb>`
     :cpp:func:`Exec::on_resume <simgrid::s4u::Exec::on_resume_cb>`
     :cpp:func:`Exec::on_this_resume <simgrid::s4u::Exec::on_this_resume_cb>`
     :cpp:func:`Exec::on_veto <simgrid::s4u::Exec::on_veto_cb>`
@@ -160,10 +164,10 @@ Partial list of existing signals in s4u:
     :cpp:func:`Io::on_this_start <simgrid::s4u::Io::on_this_start_cb>`
     :cpp:func:`Io::on_completion <simgrid::s4u::Io::on_completion_cb>`
     :cpp:func:`Io::on_this_completion <simgrid::s4u::Io::on_this_completion_cb>`
-    :cpp:func:`Io::on_suspend <simgrid::s4u::Io::on_suspend_cb>`
-    :cpp:func:`Io::on_this_suspend <simgrid::s4u::Io::on_this_suspend_cb>`
+    :cpp:func:`Io::on_suspended <simgrid::s4u::Io::on_suspended_cb>`
+    :cpp:func:`Io::on_this_suspended <simgrid::s4u::Io::on_this_suspended_cb>`
     :cpp:func:`Io::on_resume <simgrid::s4u::Io::on_resume_cb>`
-    :cpp:func:`Io::on_this_resume <simgrid::s4u::Io::on_this_resume_cb>`
+    :cpp:func:`Io::on_this_resumed <simgrid::s4u::Io::on_this_resumed_cb>`
     :cpp:func:`Io::on_veto <simgrid::s4u::Io::on_veto_cb>`
     :cpp:func:`Io::on_this_veto <simgrid::s4u::Io::on_this_veto_cb>`
 
@@ -205,8 +209,6 @@ Host Load
 
 .. doxygengroup:: plugin_host_load
 
-
-
 .. _plugin_filesystem:
 
 File System
@@ -217,15 +219,22 @@ File System
 .. _plugin_battery:
 
 Battery
-===========
+=======
 
 .. doxygengroup:: plugin_battery
 
-.. _plugin_photovoltaic:
+.. _plugin_solar_panel:
 
-Photovoltaic
+Solar Panel
 ===========
 
-.. doxygengroup:: plugin_photovoltaic
+.. doxygengroup:: plugin_solar_panel
+
+.. _plugin_chiller:
+
+Chiller
+=======
+
+.. doxygengroup:: plugin_chiller
 
 ..  LocalWords:  SimGrid