Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
improve the doc of the host plugin API
[simgrid.git] / src / bindings / java / org / simgrid / msg / Host.java
index b40704c..53ccd99 100644 (file)
@@ -144,12 +144,16 @@ public class Host {
         */
        public native double getConsumedEnergy();
 
-       /** Returns the current load of the host */
+       /** Returns the current load of the host, as a ratio = achieved_flops / (core_current_speed * core_amount)
+        *      
+        * See simgrid::plugin::HostLoad::get_current_load() for the full documentation.
+        */
        public native double getCurrentLoad();
-       /** Returns the number of flops computed of the host */
+       /** Returns the number of flops computed of the host since the beginning of the simulation */
        public native double getComputedFlops();
-       /** Returns the average load of the host */
+       /** Returns the average load of the host as a ratio since the beginning of the simulation*/
        public native double getAvgLoad();
+   
        /** Returns the current pstate */
        public native int getPstate();
        /** Changes the current pstate */