X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/88474126433cd47e2289512aef9f6e0ddd260a4a..4fd0a2b6cf055692f936e29294496d14a6091ff1:/include/simgrid/s4u/host.hpp

diff --git a/include/simgrid/s4u/host.hpp b/include/simgrid/s4u/host.hpp
index 3cec9864d0..4283ab5f1d 100644
--- a/include/simgrid/s4u/host.hpp
+++ b/include/simgrid/s4u/host.hpp
@@ -21,21 +21,22 @@
 namespace simgrid {
 
 namespace xbt {
-extern template class XBT_PUBLIC() Extendable<simgrid::s4u::Host>;
+  extern template class XBT_PUBLIC() Extendable<simgrid::s4u::Host>;
 }
-
 namespace s4u {
 
-/** @brief Simulated machine that can host some actors
+/** @ingroup s4u_api
+ *
+ * @tableofcontents
  *
- * It represents some physical resource with computing and networking capabilities.
+ * An host represents some physical resource with computing and networking capabilities.
  *
  * All hosts are automatically created during the call of the method
  * @link{simgrid::s4u::Engine::loadPlatform()}.
  * You cannot create a host yourself.
  *
- * You can retrieve a particular host using @link{simgrid::s4u::Host.byName()},
- * and actors can retrieve the host on which they run using @link{simgrid::s4u::Host.current()}.
+ * You can retrieve a particular host using simgrid::s4u::Host::byName()
+ * and actors can retrieve the host on which they run using simgrid::s4u::Host::current().
  */
 XBT_PUBLIC_CLASS Host :
   public simgrid::xbt::Extendable<Host> {
@@ -44,11 +45,12 @@ private:
   explicit Host(const char *name);
 public: // TODO, make me private
   ~Host();
-public:
+  /** Do not use this function, it should be private */
+  static Host* by_name_or_create(const char* name);
 
+  /** Retrieves an host from its name, or return nullptr */
   static Host* by_name_or_null(const char* name);
-  static Host* by_name_or_create(const char* name);
-  /** Retrieves an host from its name. */
+  /** Retrieves an host from its name, or die */
   static s4u::Host *by_name(std::string name);
   /** Retrieves the host on which the current actor is running */
   static s4u::Host *current();
@@ -68,13 +70,13 @@ public:
   bool isOff() { return !isOn(); }
 
   double speed();
-  int core_count();
+  int coresCount();
   xbt_dict_t properties();
   const char*property(const char*key);
   void setProperty(const char*key, const char *value);
   xbt_swag_t processes();
-  double currentPowerPeak();
-  double powerPeakAt(int pstate_index);
+  double getPstateSpeedCurrent();
+  double getPstateSpeed(int pstate_index);
   int pstatesCount() const;
   void setPstate(int pstate_index);
   int pstate();
@@ -91,14 +93,14 @@ public:
 
 private:
   simgrid::xbt::string name_ = "noname";
-  boost::unordered_map<std::string, Storage*> *mounts = NULL; // caching
+  boost::unordered_map<std::string, Storage*> *mounts = nullptr; // caching
 
 public:
-  // FIXME: these should be protected, but it leads to many errors
-  // Use the extensions stuff for this? Go through simgrid::surf::Host?
   // TODO, this could be a unique_ptr
+  /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
   surf::Cpu     *pimpl_cpu = nullptr;
-  surf::NetCard *pimpl_netcard = nullptr;
+  /** DO NOT USE DIRECTLY (@todo: these should be protected, once our code is clean) */
+  routing::NetCard *pimpl_netcard = nullptr;
 
 public:
   /*** Called on each newly created object */
@@ -128,20 +130,6 @@ extern int USER_HOST_LEVEL;
 
 package org.simgrid.msg;
 
-import org.simgrid.msg.Storage;
-
-/*
-Host jacquelin;
-
-try { 
-  jacquelin = Host.getByName("Jacquelin");
-} catch(HostNotFoundException e) {
-  System.err.println(e.toString());
-}
-...
-\endverbatim
- *
- */ 
 public class Host {
   /**
    * This static method returns all of the hosts of the installed platform.
@@ -172,32 +160,6 @@ public class Host {
    */ 
   public native int getLoad();
 
-  /**
-   * This method returns the speed of the processor of a host,
-   * regardless of the current load of the machine.
-   *
-   * @return      The speed of the processor of the host in flops.
-   *
-   */ 
-  public native double getSpeed();
-
-  /**
-   * This method returns the number of core of a host.
-   *
-   * @return      The speed of the processor of the host in flops.
-   *
-   */ 
-  public native double getCoreNumber();
-
-  /**
-   * Returns the value of a given host property (set from the platform file).
-   */
-  public native String getProperty(String name);
-
-  /**
-   * Change the value of a given host property. 
-   */
-  public native void setProperty(String name, String value);
 
   /** This methods returns the list of storages attached to an host
    * @return An array containing all storages (name) attached to the host