New doc section on plugins

[simgrid.git] / src / plugins / link_energy.cpp

diff --git a/src/plugins/link_energy.cpp b/src/plugins/link_energy.cpp
index 20c9873..01b0bab 100644 (file)
--- a/src/plugins/link_energy.cpp
+++ b/src/plugins/link_energy.cpp
@@ -14,8 +14,7 @@
 
 SIMGRID_REGISTER_PLUGIN(link_energy, "Link energy consumption.", &sg_link_energy_plugin_init)
 
 
 SIMGRID_REGISTER_PLUGIN(link_energy, "Link energy consumption.", &sg_link_energy_plugin_init)
 

-/** @addtogroup SURF_plugin_energy
-
+/** @defgroup plugin_link_energy

 
  This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
 
 
  This is the link energy plugin, accounting for the dissipated energy in the simulated platform.
 


@@ -24,8 +23,8 @@ SIMGRID_REGISTER_PLUGIN(link_energy, "Link energy consumption.", &sg_link_energy
 
  @verbatim
  <link id="SWITCH1" bandwidth="125Mbps" latency="5us" sharing_policy="SHARED" >
 
  @verbatim
  <link id="SWITCH1" bandwidth="125Mbps" latency="5us" sharing_policy="SHARED" >

- <prop id="watt_range" value="100.0:200.0" />
- <prop id="watt_off" value="10" />
+ <prop id="wattage_range" value="100.0:200.0" />
+ <prop id="wattage_off" value="10" />

  </link>
  @endverbatim
 
  </link>
  @endverbatim
 


@@ -87,7 +86,12 @@ void LinkEnergy::init_watts_range_list()
     return;
   inited_ = true;
 
     return;
   inited_ = true;
 

-  const char* all_power_values_str = this->link_->get_property("watt_range");
+  const char* all_power_values_str = this->link_->get_property("wattage_range");
+  if (all_power_values_str == nullptr) {
+    all_power_values_str = this->link_->get_property("watt_range");
+    if (all_power_values_str != nullptr)
+      XBT_WARN("Please rename the 'watt_range' property of link %s into 'wattage_range'.", link_->get_cname());
+  }

 
   if (all_power_values_str == nullptr)
     return;
 
   if (all_power_values_str == nullptr)
     return;


@@ -179,7 +183,7 @@ int sg_link_energy_is_inited()
 {
   return LinkEnergy::EXTENSION_ID.valid();
 }
 {
   return LinkEnergy::EXTENSION_ID.valid();
 }

-/** @ingroup SURF_plugin_energy
+/** @ingroup plugin_link_energy

  * @brief Enable energy plugin
  * @details Enable energy plugin to get joules consumption of each cpu. You should call this function before
  * #MSG_init().
  * @brief Enable energy plugin
  * @details Enable energy plugin to get joules consumption of each cpu. You should call this function before
  * #MSG_init().


@@ -215,7 +219,7 @@ void sg_link_energy_plugin_init()
   simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
 }
 
   simgrid::s4u::Engine::on_simulation_end.connect(&on_simulation_end);
 }
 

-/** @ingroup plugin_energy
+/** @ingroup plugin_link_energy

  *  @brief Returns the total energy consumed by the link so far (in Joules)
  *
  *  Please note that since the consumption is lazily updated, it may require a simcall to update it.
  *  @brief Returns the total energy consumed by the link so far (in Joules)
  *
  *  Please note that since the consumption is lazily updated, it may require a simcall to update it.