Document simgrid.Engine.instance in Python

[simgrid.git] / docs / source / app_s4u.rst

diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst
index 09faa66..36c6dd3 100644 (file)
--- a/docs/source/app_s4u.rst
+++ b/docs/source/app_s4u.rst
@@ -406,9 +406,18 @@ Simulation objects
 ⁣  class Actor
 ==============
 
-.. doxygenclass:: simgrid::s4u::Actor
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. doxygenclass:: simgrid::s4u::Actor
 
-.. doxygentypedef:: aid_t
+      .. doxygentypedef:: aid_t
+
+
+   .. group-tab:: Python
+   
+      .. autoclass:: simgrid.Actor
 
 Basic management
 ----------------
@@ -429,8 +438,6 @@ Basic management
 
          from simgrid import Actor
 
-      .. autoclass:: simgrid.Actor
-
    .. group-tab:: C
 
       .. code:: C
@@ -781,10 +788,18 @@ Exiting
 ⁣  Simulation Engine
 ====================
 
-.. doxygenclass:: simgrid::s4u::Engine
+.. tabs::
 
-Initialization
---------------
+   .. group-tab:: C++
+
+      .. doxygenclass:: simgrid::s4u::Engine
+
+   .. group-tab:: Python
+   
+      .. autoclass:: simgrid.Engine
+
+Engin initialization
+--------------------
 
 .. tabs::
 
@@ -793,6 +808,23 @@ Initialization
       .. doxygenfunction:: simgrid::s4u::Engine::Engine(int *argc, char **argv)
       .. doxygenfunction:: simgrid::s4u::Engine::is_initialized()
       .. doxygenfunction:: simgrid::s4u::Engine::shutdown()
+      .. doxygenfunction:: simgrid::s4u::Engine::get_instance()
+
+   .. group-tab:: Python
+
+       .. automethod:: simgrid.Engine.instance
+
+   .. group-tab:: C
+
+      .. doxygenfunction:: simgrid_init
+
+Simulation setup
+----------------
+
+.. tabs::
+
+   .. group-tab:: C++
+
       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &str)
       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, bool value)
       .. doxygenfunction:: simgrid::s4u::Engine::set_config(const std::string &name, double value)
@@ -818,13 +850,12 @@ Initialization
 
    .. group-tab:: C
 
-      .. doxygenfunction:: simgrid_init
-
       .. doxygenfunction:: simgrid_load_deployment
       .. doxygenfunction:: simgrid_load_platform
       .. doxygenfunction:: simgrid_register_default
       .. doxygenfunction:: simgrid_register_function
 
+
 Run the simulation
 ------------------
 
@@ -834,16 +865,19 @@ Run the simulation
 
       .. doxygenfunction:: simgrid::s4u::Engine::get_clock()
       .. doxygenfunction:: simgrid::s4u::Engine::run
+      .. doxygenfunction:: simgrid::s4u::Engine::run_until
 
    .. group-tab:: Python
 
       .. automethod:: simgrid.Engine.get_clock
       .. automethod:: simgrid.Engine.run
+      .. automethod:: simgrid.Engine.run_until
 
    .. group-tab:: C
 
       .. doxygenfunction:: simgrid_get_clock
       .. doxygenfunction:: simgrid_run
+      .. doxygenfunction:: simgrid_run_until
 
 Retrieving actors
 -----------------
@@ -903,7 +937,6 @@ Interacting with the routing
 
       .. doxygenfunction:: simgrid::s4u::Engine::get_all_netpoints
       .. doxygenfunction:: simgrid::s4u::Engine::get_filtered_netzones
-      .. doxygenfunction:: simgrid::s4u::Engine::get_instance()
       .. doxygenfunction:: simgrid::s4u::Engine::get_netzone_root
       .. doxygenfunction:: simgrid::s4u::Engine::netpoint_by_name_or_null
       .. doxygenfunction:: simgrid::s4u::Engine::netzone_by_name_or_null
@@ -928,7 +961,15 @@ Signals
 ⁣  class Mailbox
 ================
 
-.. doxygenclass:: simgrid::s4u::Mailbox
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. doxygenclass:: simgrid::s4u::Mailbox
+
+   .. group-tab:: Python
+   
+      .. autoclass:: simgrid.Mailbox
 
 Please also refer to the :ref:`full doc on s4u::Mailbox <s4u_mailbox>`.
 
@@ -956,8 +997,6 @@ Basic management
 
          #include <simgrid/mailbox.h>
 
-      .. autoclass:: simgrid.Mailbox
-
       .. automethod:: simgrid.Mailbox.by_name
 
    .. group-tab:: C
@@ -1067,7 +1106,15 @@ Resources
 ⁣  class Disk
 =============
 
-.. doxygenclass:: simgrid::s4u::Disk
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. doxygenclass:: simgrid::s4u::Disk
+
+   .. group-tab:: Python
+   
+      .. autoclass:: simgrid.Disk
 
 Basic management
 ----------------
@@ -1155,7 +1202,15 @@ Signals
 ⁣  class Host
 =============
 
-.. doxygenclass:: simgrid::s4u::Host
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. doxygenclass:: simgrid::s4u::Host
+
+   .. group-tab:: Python
+   
+      .. autoclass:: simgrid.Host
 
 Basic management
 ----------------
@@ -1409,9 +1464,18 @@ Signals
 ⁣  class Link
 =============
 
-.. doxygenclass:: simgrid::s4u::Link
-.. doxygenclass:: simgrid::s4u::SplitDuplexLink
-.. doxygenclass:: simgrid::s4u::LinkInRoute
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. doxygenclass:: simgrid::s4u::Link
+      .. doxygenclass:: simgrid::s4u::SplitDuplexLink
+      .. doxygenclass:: simgrid::s4u::LinkInRoute
+
+
+   .. group-tab:: Python
+   
+      .. autoclass:: simgrid.Link
 
 Basic management
 ----------------
@@ -1463,6 +1527,7 @@ Retrieving links
 
    .. group-tab:: Python
 
+      .. automethod:: simgrid.Link.by_name
       .. autoattribute:: simgrid.Link.name
 
    .. group-tab:: C
@@ -1590,7 +1655,15 @@ Signals
 ⁣  class NetZone
 ================
 
-.. doxygenclass:: simgrid::s4u::NetZone
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. doxygenclass:: simgrid::s4u::NetZone
+
+   .. group-tab:: Python
+   
+      .. autoclass:: simgrid.NetZone
 
 Basic management
 ----------------
@@ -1615,7 +1688,6 @@ Basic management
 
          from simgrid import NetZone
 
-      .. autoclass:: simgrid.NetZone
       .. automethod:: simgrid.NetZone.seal
 
    .. group-tab:: C
@@ -1853,8 +1925,8 @@ Creating VMs
 
    .. group-tab:: C++
 
-      .. doxygenfunction:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount)
-      .. doxygenfunction:: simgrid::s4u::VirtualMachine::VirtualMachine(const std::string &name, Host *physical_host, int core_amount, size_t ramsize)
+      .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount)
+      .. doxygenfunction:: simgrid::s4u::Host::create_vm(const std::string &name, int core_amount, size_t ramsize)
       .. doxygenfunction:: simgrid::s4u::VirtualMachine::destroy
 
    .. group-tab:: C
@@ -1916,6 +1988,8 @@ Signals
 
    .. group-tab:: C++
 
+      .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_creation
+      .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_destruction
       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_migration_end
       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_migration_start
       .. doxygenvariable:: simgrid::s4u::VirtualMachine::on_resume
@@ -2002,7 +2076,15 @@ Suspending and resuming an activity
 ⁣  class Comm
 =============
 
-.. doxygenclass:: simgrid::s4u::Comm
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. doxygenclass:: simgrid::s4u::Comm
+
+   .. group-tab:: Python
+   
+      .. autoclass:: simgrid.Comm
 
 Basic management
 ----------------
@@ -2023,8 +2105,6 @@ Basic management
 
          from simgrid import Comm
 
-      .. autoclass:: simgrid.Comm
-
    .. group-tab:: c
 
       .. code:: c
@@ -2065,7 +2145,8 @@ also start direct communications as shown below.
    .. group-tab:: C++
 
       .. doxygenfunction:: simgrid::s4u::Comm::sendto
-      .. doxygenfunction:: simgrid::s4u::Comm::sendto_init
+      .. doxygenfunction:: simgrid::s4u::Comm::sendto_init()
+      .. doxygenfunction:: simgrid::s4u::Comm::sendto_init(Host *from, Host *to)
       .. doxygenfunction:: simgrid::s4u::Comm::sendto_async
 
       .. doxygenfunction:: simgrid::s4u::Comm::cancel
@@ -2110,7 +2191,15 @@ Signals
 ⁣  class Exec
 =============
 
-.. doxygenclass:: simgrid::s4u::Exec
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. doxygenclass:: simgrid::s4u::Exec
+
+   .. group-tab:: Python
+   
+      .. autoclass:: simgrid.Exec
 
 Basic management
 ----------------
@@ -2131,8 +2220,6 @@ Basic management
 
          from simgrid import Exec
 
-      .. autoclass:: simgrid.Exec
-
    .. group-tab:: C
 
       .. code-block:: C
@@ -2223,7 +2310,15 @@ Signals
 ⁣  class Io
 ===========
 
-.. doxygenclass:: simgrid::s4u::Io
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. doxygenclass:: simgrid::s4u::Io
+
+   .. group-tab:: Python
+   
+      .. autoclass:: simgrid.Io
 
 Basic management
 ----------------