X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/717bb82fd56727b8a066418eaa654290373736ea..e080adacaf1ba847ad467f5b8d21da385636ed3c:/src/bindings/java/org/simgrid/msg/Host.java

diff --git a/src/bindings/java/org/simgrid/msg/Host.java b/src/bindings/java/org/simgrid/msg/Host.java
index b40704c5c6..0fbbdaf60c 100644
--- a/src/bindings/java/org/simgrid/msg/Host.java
+++ b/src/bindings/java/org/simgrid/msg/Host.java
@@ -1,14 +1,12 @@
 /* Bindings to the MSG hosts */
 
-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 package org.simgrid.msg;
 
-import org.simgrid.msg.Storage;
-
 /**
  * A host object represents a location (any possible place) where a process may run.
  * Thus it is represented as a physical resource with computing capabilities, some
@@ -19,11 +17,11 @@ import org.simgrid.msg.Storage;
  * platform file which describes all elements of the platform (host, link, root..).
  * You cannot create a host yourself.
  *
- * The best way to get an host instance is to call the static method
+ * The best way to get a host instance is to call the static method
  * Host.getByName().
  *
  * For example to get the instance of the host. If your platform
- * file description contains an host named "Jacquelin" :
+ * file description contains a host named "Jacquelin" :
  *
  * \verbatim
 Host jacquelin;
@@ -63,7 +61,7 @@ public class Host {
 	}
 
 	/**
-	 * This static method gets an host instance associated with a native
+	 * This static method gets a host instance associated with a native
 	 * host of your platform. This is the best way to get a java host object.
 	 *
 	 * @param name		The name of the host to get.
@@ -113,7 +111,7 @@ public class Host {
 	/** Starts the host if it is off */
 	public native void on();
 	/** Stops the host if it is on */
-	public native void off();
+	public native void off() throws ProcessKilledError;
 
 	/**
 	 * This method returns the speed of the processor of a host (in flops),
@@ -124,12 +122,12 @@ public class Host {
 
 	public native String getProperty(String name);
 	public native void setProperty(String name, String value);
-	/** Tests if an host is up and running. */
+	/** Tests if a host is up and running. */
 	public native boolean isOn();
 
-	/** Returns the list of mount point names on an host */
+	/** Returns the list of mount point names on a host */
 	public native Storage[] getMountedStorage();
-	/** This methods returns the list of storages (names) attached to an host */
+	/** This methods returns the list of storages (names) attached to a host */
 	public native String[] getAttachedStorage();
 
 	/** After this call, sg_host_get_consumed_energy() will not interrupt your process
@@ -144,12 +142,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 */