finish the doc under the new format for Host

diff --git a/docs/find-missing.ignore b/docs/find-missing.ignore
index b9309f7324d477c35fdb076d171d2b836089b866..a3f647f12adf77da2f1de2b76ca63e5ae52e80eb 100644 (file)
--- a/docs/find-missing.ignore
+++ b/docs/find-missing.ignore
@@ -165,6 +165,12 @@ It is only used by find-missing, that will not report any definition linked here
 .. autodoxymethod:: ::MSG_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
 .. autodoxymethod:: ::MSG_zone_set_property_value(msg_netzone_t zone, const char *name, const char *value)
 
 .. autodoxymethod:: ::MSG_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto)
 .. autodoxymethod:: ::MSG_zone_set_property_value(msg_netzone_t zone, const char *name, const char *value)
 

+# Storage must die
+.. autodoxymethod:: sg_host_get_attached_storage_list(const_sg_host_t host)
+.. autodoxymethod:: sg_host_get_mounted_storage_list(sg_host_t host)
+.. autodoxymethod:: simgrid::s4u::Host::get_attached_storages()
+.. autodoxymethod:: simgrid::s4u::Host::get_mounted_storages()
+

 # These ones are a bug of Doxygen, that parse them as variables instead of types.
 # So we don't use this bogus parse result, but go directly for cpp:type directives in app_s4u.rst
 .. autodoxyvar:: ::const_sg_actor_t
 # These ones are a bug of Doxygen, that parse them as variables instead of types.
 # So we don't use this bogus parse result, but go directly for cpp:type directives in app_s4u.rst
 .. autodoxyvar:: ::const_sg_actor_t


@@ -172,3 +178,4 @@ It is only used by find-missing, that will not report any definition linked here
 .. autodoxyvar:: ::const_sg_mutex_t
 .. autodoxyvar:: ::const_sg_sem_t
 .. autodoxyvar:: ::const_sg_host_t
 .. autodoxyvar:: ::const_sg_mutex_t
 .. autodoxyvar:: ::const_sg_sem_t
 .. autodoxyvar:: ::const_sg_host_t

+.. autodoxyvar:: ::const_sg_storage_t

diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst
index f66286ea01c0e121c82ce33a1743699728f31837..ee8e75352bfcc7ef6a90a81039019ecc76de7fe2 100644 (file)
--- a/docs/source/app_s4u.rst
+++ b/docs/source/app_s4u.rst
@@ -1080,6 +1080,8 @@ Basic management
       idiom on hosts because SimGrid does not allow (yet) to create nor
       destroy resources once the simulation is started. 
 
       idiom on hosts because SimGrid does not allow (yet) to create nor
       destroy resources once the simulation is started. 
 

+      .. autodoxymethod:: simgrid::s4u::Host::destroy()
+

    .. group-tab:: Python
 
       .. code:: Python
    .. group-tab:: Python
 
       .. code:: Python


@@ -1133,18 +1135,80 @@ Querying info
 
       .. autodoxymethod:: simgrid::s4u::Host::get_cname()
       .. autodoxymethod:: simgrid::s4u::Host::get_core_count()
 
       .. autodoxymethod:: simgrid::s4u::Host::get_cname()
       .. autodoxymethod:: simgrid::s4u::Host::get_core_count()

-      .. autodoxymethod:: simgrid::s4u::Host::get_disks()

       .. autodoxymethod:: simgrid::s4u::Host::get_name()
       .. autodoxymethod:: simgrid::s4u::Host::get_name()

+      .. autodoxymethod:: simgrid::s4u::Host::get_available_speed()
+      .. autodoxymethod:: simgrid::s4u::Host::get_load()
+      .. autodoxymethod:: simgrid::s4u::Host::get_speed()

 
    .. group-tab:: Python
 
 
    .. group-tab:: Python
 

-      .. autoattribute:: simgrid.Exec.host

       .. autoattribute:: simgrid.Host.name
       .. autoattribute:: simgrid.Host.name

+      .. autoattribute:: simgrid.Host.load
+      .. autoattribute:: simgrid.Host.pstate
+      .. autoattribute:: simgrid.Host.speed

 
    .. group-tab:: C
 
 
    .. group-tab:: C
 

-      .. autodoxymethod:: ::sg_host_core_count(const_sg_host_t host)
+      .. autodoxymethod:: sg_host_core_count(const_sg_host_t host)
+      .. autodoxymethod:: sg_host_dump(const_sg_host_t ws)

       .. autodoxymethod:: sg_host_get_name(const_sg_host_t host)
       .. autodoxymethod:: sg_host_get_name(const_sg_host_t host)

+      .. autodoxymethod:: sg_host_load(const_sg_host_t host)
+      .. autodoxymethod:: sg_host_speed(const_sg_host_t host)
+
+User data and properties
+------------------------
+
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. autodoxymethod:: simgrid::s4u::Host::get_properties()
+      .. autodoxymethod:: simgrid::s4u::Host::get_property(const std::string &key)
+      .. autodoxymethod:: simgrid::s4u::Host::set_properties(const std::map< std::string, std::string > &properties)
+      .. autodoxymethod:: simgrid::s4u::Host::set_property(const std::string &key, const std::string &value)
+
+   .. group-tab:: C
+
+      .. autodoxymethod:: ::sg_host_set_property_value(sg_host_t host, const char *name, const char *value)
+      .. autodoxymethod:: ::sg_host_get_properties(const_sg_host_t host)
+      .. autodoxymethod:: ::sg_host_get_property_value(const_sg_host_t host, const char *name)
+      .. autodoxymethod:: ::sg_host_extension_create(void(*deleter)(void *))
+      .. autodoxymethod:: ::sg_host_extension_get(const_sg_host_t host, size_t rank)
+
+Retrieve components
+-------------------
+
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. autodoxymethod:: simgrid::s4u::Host::add_disk(Disk *disk)
+      .. autodoxymethod:: simgrid::s4u::Host::get_actor_count()
+      .. autodoxymethod:: simgrid::s4u::Host::get_all_actors()
+      .. autodoxymethod:: simgrid::s4u::Host::get_disks()
+      .. autodoxymethod:: simgrid::s4u::Host::remove_disk(const std::string &disk_name)
+
+   .. group-tabs:: C
+
+      .. autodoxymethod:: ::sg_host_get_actor_list(const_sg_host_t host, xbt_dynar_t whereto)
+
+
+On/Off
+------
+
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. autodoxymethod:: simgrid::s4u::Host::is_on()
+      .. autodoxymethod:: simgrid::s4u::Host::turn_off()
+      .. autodoxymethod:: simgrid::s4u::Host::turn_on()
+
+   .. group-tab:: C
+
+      .. autodoxymethod:: ::sg_host_is_on(const_sg_host_t host)
+      .. autodoxymethod:: ::sg_host_turn_off(sg_host_t host)
+      .. autodoxymethod:: ::sg_host_turn_on(sg_host_t host)

 
 DVFS
 ----
 
 DVFS
 ----


@@ -1173,10 +1237,48 @@ DVFS
       .. autodoxymethod:: sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
       .. autodoxymethod:: sg_host_set_pstate(sg_host_t host, int pstate)
 
       .. autodoxymethod:: sg_host_get_pstate_speed(const_sg_host_t host, int pstate_index)
       .. autodoxymethod:: sg_host_set_pstate(sg_host_t host, int pstate)
 

-.. doxygenclass:: simgrid::s4u::Host
-   :members:
-   :protected-members:
-   :undoc-members:
+Execution
+---------
+
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. autodoxymethod:: simgrid::s4u::Host::exec_async(double flops_amounts)
+      .. autodoxymethod:: simgrid::s4u::Host::execute(double flops)
+      .. autodoxymethod:: simgrid::s4u::Host::execute(double flops, double priority)
+
+Platform and routing
+--------------------
+
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. autodoxymethod:: simgrid::s4u::Host::get_englobing_zone()
+      .. autodoxymethod:: simgrid::s4u::Host::get_netpoint()
+      .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency)
+      .. autodoxymethod:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency)
+      .. autodoxymethod:: simgrid::s4u::Host::send_to(Host *dest, double byte_amount)
+
+   .. group-tab:: C
+
+      .. autodoxymethod:: ::sg_host_route(const_sg_host_t from, const_sg_host_t to, xbt_dynar_t links)
+      .. autodoxymethod:: ::sg_host_route_bandwidth(const_sg_host_t from, const_sg_host_t to)
+      .. autodoxymethod:: ::sg_host_route_latency(const_sg_host_t from, const_sg_host_t to)
+      .. autodoxymethod:: ::sg_host_send_to(sg_host_t from, sg_host_t to, double byte_amount)
+
+Signals
+-------
+
+.. tabs::
+
+   .. group-tab:: C++
+
+      .. autodoxyvar:: simgrid::s4u::Host::on_creation
+      .. autodoxyvar:: simgrid::s4u::Host::on_destruction
+      .. autodoxyvar:: simgrid::s4u::Host::on_speed_change
+      .. autodoxyvar:: simgrid::s4u::Host::on_state_change

 
 .. _API_s4u_Link:
 
 
 .. _API_s4u_Link:
 


@@ -1562,13 +1664,6 @@ Class Exec
 .. autoclass:: simgrid.Exec
    :members:
 
 .. autoclass:: simgrid.Exec
    :members:
 

-==========
-Class Host
-==========
-
-.. autoclass:: simgrid.Host
-   :members:
-

 .. |hr| raw:: html
 
    <hr />
 .. |hr| raw:: html
 
    <hr />

diff --git a/include/simgrid/host.h b/include/simgrid/host.h
index 85d17a22c399c464cfa422b22c1353fa27ecb856..843c0fcfb41ee7bd6b24c0cfa51027d8e52b3b9b 100644 (file)
--- a/include/simgrid/host.h
+++ b/include/simgrid/host.h
@@ -38,6 +38,7 @@ XBT_PUBLIC sg_host_t sg_host_by_name(const char* name);
 /** @brief Return the name of the sg_host_t. */
 XBT_PUBLIC const char* sg_host_get_name(const_sg_host_t host);
 
 /** @brief Return the name of the sg_host_t. */
 XBT_PUBLIC const char* sg_host_get_name(const_sg_host_t host);
 

+#ifndef DOXYGEN

 // ========== User Data ==============
 /** @brief Return the user data of a #sg_host_t.
  *
 // ========== User Data ==============
 /** @brief Return the user data of a #sg_host_t.
  *


@@ -53,6 +54,7 @@ XBT_PUBLIC void sg_host_data_set(sg_host_t host, void* userdata);
 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set()") XBT_PUBLIC
     void sg_host_user_set(sg_host_t host, void* userdata);
 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set(h, NULL)") XBT_PUBLIC void sg_host_user_destroy(sg_host_t host);
 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set()") XBT_PUBLIC
     void sg_host_user_set(sg_host_t host, void* userdata);
 XBT_ATTRIB_DEPRECATED_v328("Please use sg_host_data_set(h, NULL)") XBT_PUBLIC void sg_host_user_destroy(sg_host_t host);

+#endif

 
 // ========= storage related functions ============
 /** @brief Return the list of mount point names on an host.
 
 // ========= storage related functions ============
 /** @brief Return the list of mount point names on an host.

diff --git a/src/s4u/s4u_Host.cpp b/src/s4u/s4u_Host.cpp
index d4841f2ca829d10c28b0d9d7b694924595c37e54..a2985101656fb549c2e67bacb7746b5c38a03ad0 100644 (file)
--- a/src/s4u/s4u_Host.cpp
+++ b/src/s4u/s4u_Host.cpp
@@ -50,7 +50,7 @@ Host::~Host()
  *
  * Don't delete directly a host, call h->destroy() instead.
  *
  *
  * Don't delete directly a host, call h->destroy() instead.
  *

- * This is cumbersome but this is the simplest solution to ensure that the onDestruction() callback receives a valid
+ * This is cumbersome but this is the simplest solution to ensure that the on_destruction() callback receives a valid

  * object (because of the destructor order in a class hierarchy).
  */
 void Host::destroy()
  * object (because of the destructor order in a class hierarchy).
  */
 void Host::destroy()