Merge branch 'master' of scm.gforge.inria.fr:/gitroot/simgrid/simgrid

[simgrid.git] / include / simgrid / s4u / host.hpp

diff --git a/include/simgrid/s4u/host.hpp b/include/simgrid/s4u/host.hpp
index 2e5144a..ebe969b 100644 (file)
--- a/include/simgrid/s4u/host.hpp
+++ b/include/simgrid/s4u/host.hpp
@@ -21,34 +21,36 @@
 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> {
 
 private:
-  Host(const char *name);
+  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();
@@ -70,6 +72,8 @@ public:
   double speed();
   int core_count();
   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);
@@ -81,7 +85,7 @@ public:
   xbt_dict_t mountedStoragesAsDict(); // HACK
   xbt_dynar_t attachedStorages();
 
-  /** Get an associative list [mount point]->[Storage] off all local mount points.
+  /** Get an associative list [mount point]->[Storage] of all local mount points.
    *
    *  This is defined in the platform file, and cannot be modified programatically (yet).
    */
@@ -89,7 +93,7 @@ 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
@@ -164,7 +168,7 @@ public class Host {
 
   /**
    * This method returns the number of tasks currently running on a host.
-   * The external load (comming from an availability trace) is not taken in account.
+   * The external load (coming from an availability trace) is not taken in account.
    *
    * @return      The number of tasks currently running on a host.
    */