Make vm_by_name() public and modify c-cloud-migration to use new functions

[simgrid.git] / include / simgrid / s4u / Host.hpp

diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp
index 000ed7e..8fbe494 100644 (file)
--- a/include/simgrid/s4u/Host.hpp
+++ b/include/simgrid/s4u/Host.hpp
@@ -152,13 +152,19 @@ public:
   /** @brief Get the peak computing speed in flops/s at the current pstate, NOT taking the external load into account.
    *
    *  The amount of flops per second available for computing depends on several things:
-   *    - The current pstate determines the maximal peak computing speed (use @ref get_pstate_speed() to retrieve the
-   *      computing speed you would get at another pstate)
-   *    - If you declared an external load (with @ref set_speed_profile()), you must multiply the
-   * result of get_speed() by get_available_speed() to retrieve what a new computation would get.
+   *    - The current pstate determines the maximal peak computing speed (use
+   *      @verbatim embed:rst:inline :cpp:func:`get_pstate_speed() <simgrid::s4u::Host::get_pstate_speed>` @endverbatim
+   *      to retrieve the computing speed you would get at another pstate)
+   *    - If you declared an external load (with
+   *      @verbatim embed:rst:inline :cpp:func:`set_speed_profile() <simgrid::s4u::Host::set_speed_profile>` @endverbatim ),
+   *      you must multiply the result of
+   *      @verbatim embed:rst:inline :cpp:func:`get_speed() <simgrid::s4u::Host::get_speed>` @endverbatim by
+   *      @verbatim embed:rst:inline :cpp:func:`get_available_speed() <simgrid::s4u::Host::get_available_speed>` @endverbatim
+   *      to retrieve what a new computation would get.
    *
    *  The remaining speed is then shared between the executions located on this host.
-   *  You can retrieve the amount of tasks currently running on this host with @ref get_load().
+   *  You can retrieve the amount of tasks currently running on this host with
+   *  @verbatim embed:rst:inline :cpp:func:`get_load() <simgrid::s4u::Host::get_load>` @endverbatim .
    *
    *  The host may have multiple cores, and your executions may be able to use more than a single core.
    *
@@ -167,7 +173,8 @@ public:
   double get_speed() const;
   /** @brief Get the available speed ratio, between 0 and 1.
    *
-   * This accounts for external load (see @ref set_speed_profile()).
+   * This accounts for external load (see
+   * @verbatim embed:rst:inline :cpp:func:`set_speed_profile() <simgrid::s4u::Host::set_speed_profile>` @endverbatim ).
    */
   double get_available_speed() const;
 
@@ -220,6 +227,8 @@ public:
 
   VirtualMachine* create_vm(const std::string& name, int core_amount);
   VirtualMachine* create_vm(const std::string& name, int core_amount, size_t ramsize);
+  /** Retrieve a VM running on this host from its name, or return nullptr */
+  VirtualMachine* vm_by_name_or_null(const std::string& name);
 
   void route_to(const Host* dest, std::vector<Link*>& links, double* latency) const;
   void route_to(const Host* dest, std::vector<kernel::resource::StandardLinkImpl*>& links, double* latency) const;
@@ -230,11 +239,6 @@ public:
    */
   Host* seal();
 
-#ifndef DOXYGEN
-  XBT_ATTRIB_DEPRECATED_v331("Please use Comm::sendto()") void sendto(Host* dest, double byte_amount);
-  XBT_ATTRIB_DEPRECATED_v331("Please use Comm::sendto_async()") CommPtr sendto_async(Host* dest, double byte_amount);
-#endif
-
   NetZone* get_englobing_zone() const;
   /** Block the calling actor on an execution located on the called host
    *