Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
MSG_host_get_pstate_number() -> MSG_host_get_pstate_count()
[simgrid.git] / src / msg / msg_host.c
index 1f36f3b..6254436 100644 (file)
@@ -350,13 +350,13 @@ void MSG_host_get_params(msg_host_t host, ws_params_t params)
 }
 
 /** \ingroup m_host_management
- * \brief Return the speed of the processor (in flop/s) at a given pstate
+ * \brief Return the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
  *
  * \param  host host to test
  * \param pstate_index pstate to test
  * \return Returns the processor speed associated with pstate_index
  */
-double MSG_get_host_power_peak_at(msg_host_t host, int pstate_index) {
+double MSG_host_get_power_peak_at(msg_host_t host, int pstate_index) {
          xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
          return (simcall_host_get_power_peak_at(host, pstate_index));
 }
@@ -367,41 +367,41 @@ double MSG_get_host_power_peak_at(msg_host_t host, int pstate_index) {
  * \param  host host to test
  * \return Returns the current processor speed
  */
-double MSG_get_host_current_power_peak(msg_host_t host) {
+double MSG_host_get_current_power_peak(msg_host_t host) {
          xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
          return simcall_host_get_current_power_peak(host);
 }
 
 /** \ingroup m_host_management
- * \brief Return the number of pstates defined for a host
+ * \brief Return the total count of pstates defined for a host. See also @ref SURF_plugin_energy.
  *
  * \param  host host to test
  */
-int MSG_get_host_nb_pstates(msg_host_t host) {
+int MSG_host_get_pstate_count(msg_host_t host) {
 
          xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
          return (simcall_host_get_nb_pstates(host));
 }
 
 /** \ingroup m_host_management
- * \brief Sets the speed of the processor (in flop/s) at a given pstate
+ * \brief Sets the speed of the processor (in flop/s) at a given pstate. See also @ref SURF_plugin_energy.
  *
  * \param  host host to test
  * \param pstate_index pstate to switch to
  */
-void MSG_set_host_power_peak_at(msg_host_t host, int pstate_index) {
+void MSG_host_set_pstate(msg_host_t host, int pstate_index) {
          xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
 
          simcall_host_set_power_peak_at(host, pstate_index);
 }
 
 /** \ingroup m_host_management
- * \brief Return the total energy consumed by a host (in Joules)
+ * \brief Return the total energy consumed by a host (in Joules). See also @ref SURF_plugin_energy.
  *
  * \param  host host to test
  * \return Returns the consumed energy
  */
-double MSG_get_host_consumed_energy(msg_host_t host) {
+double MSG_host_get_consumed_energy(msg_host_t host) {
          xbt_assert((host != NULL), "Invalid parameters (host is NULL)");
          return simcall_host_get_consumed_energy(host);
 }