X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/85ec20d003755c203949f738568940c30e3159de..3907e83884bae6278656e9cd2cb7ef92a8f707fb:/docs/source/Plugins.rst diff --git a/docs/source/Plugins.rst b/docs/source/Plugins.rst index a0a4f4863d..aab0fe0968 100644 --- a/docs/source/Plugins.rst +++ b/docs/source/Plugins.rst @@ -23,6 +23,9 @@ documents some of the plugins distributed with SimGrid: - :ref:`Host Energy `: models the energy dissipation of the compute units. - :ref:`Link Energy `: models the energy dissipation of the network. - :ref:`WiFi Energy `: models the energy dissipation of wifi links. + - :ref:`Battery `: models batteries that get discharged by the energy consumption of a given host. + - :ref:`Solar Panel `: models solar panels which energy production depends on the solar irradiance. + - :ref:`Chiller `: models chillers which dissipate heat by consuming energy. You can activate these plugins with the :ref:`--cfg=plugin ` command line option, for example with ``--cfg=plugin:host_energy``. You can get the full @@ -67,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 ` @@ -135,20 +141,35 @@ Partial list of existing signals in s4u: - :cpp:func:`Comm::on_send ` :cpp:func:`Comm::on_recv ` - :cpp:func:`Comm::on_start ` + :cpp:func:`Comm::on_this_start ` :cpp:func:`Comm::on_completion ` - :cpp:func:`Comm::on_suspend ` + :cpp:func:`Comm::on_this_completion ` + :cpp:func:`Comm::on_suspended ` + :cpp:func:`Comm::on_this_suspended ` :cpp:func:`Comm::on_resume ` + :cpp:func:`Comm::on_this_resumed ` :cpp:func:`Comm::on_veto ` + :cpp:func:`Comm::on_this_veto ` - :cpp:func:`Exec::on_start ` + :cpp:func:`Exec::on_this_start ` :cpp:func:`Exec::on_completion ` - :cpp:func:`Exec::on_suspend ` + :cpp:func:`Exec::on_this_completion ` + :cpp:func:`Exec::on_suspended ` + :cpp:func:`Exec::on_this_suspended ` :cpp:func:`Exec::on_resume ` + :cpp:func:`Exec::on_this_resume ` :cpp:func:`Exec::on_veto ` + :cpp:func:`Exec::on_this_veto ` - :cpp:func:`Io::on_start ` + :cpp:func:`Io::on_this_start ` :cpp:func:`Io::on_completion ` - :cpp:func:`Io::on_suspend ` + :cpp:func:`Io::on_this_completion ` + :cpp:func:`Io::on_suspended ` + :cpp:func:`Io::on_this_suspended ` :cpp:func:`Io::on_resume ` + :cpp:func:`Io::on_this_resumed ` :cpp:func:`Io::on_veto ` + :cpp:func:`Io::on_this_veto ` Existing Plugins **************** @@ -188,8 +209,6 @@ Host Load .. doxygengroup:: plugin_host_load - - .. _plugin_filesystem: File System @@ -200,22 +219,22 @@ File System .. _plugin_battery: Battery -=========== +======= .. doxygengroup:: plugin_battery -.. _plugin_operation: +.. _plugin_solar_panel: -Operation +Solar Panel =========== -.. doxygengroup:: plugin_operation +.. doxygengroup:: plugin_solar_panel -.. _plugin_photovoltaic: +.. _plugin_chiller: -Photovoltaic -=========== +Chiller +======= -.. doxygengroup:: plugin_photovoltaic +.. doxygengroup:: plugin_chiller .. LocalWords: SimGrid