Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
snake_case s4u::Host and improve doc
[simgrid.git] / include / simgrid / s4u / Host.hpp
index 4ce6a6a..477bb22 100644 (file)
@@ -80,33 +80,50 @@ public:
   /** Retrieves the name of that host as a C string */
   const char* get_cname() const { return name_.c_str(); }
 
-  void actorList(std::vector<ActorPtr> * whereto);
+  int get_actor_count();
+  std::vector<ActorPtr> get_all_actors();
 
   /** Turns that host on if it was previously off
    *
    * All actors on that host which were marked autorestart will be restarted automatically.
    * This call does nothing if the host is already on.
    */
-  void turnOn();
+  void turn_on();
   /** Turns that host off. All actors are forcefully stopped. */
-  void turnOff();
+  void turn_off();
   /** Returns if that host is currently up and running */
-  bool isOn();
+  bool is_on();
   /** Returns if that host is currently down and offline */
-  bool isOff() { return not isOn(); }
+  bool is_off() { return not is_on(); }
+
+  const char* get_property(const char* key);
+  void set_property(std::string key, std::string value);
+  std::unordered_map<std::string, std::string>* get_properties();
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map<std::string, std::string>* getProperties()
+  {
+    std::map<std::string, std::string>* res             = new std::map<std::string, std::string>();
+    std::unordered_map<std::string, std::string>* props = get_properties();
+    for (auto const& kv : *props)
+      res->insert(kv);
+    return res;
+  }
 
-  double getSpeed();
+  double get_speed();
   double get_available_speed();
-  int getCoreCount();
-  std::map<std::string, std::string>* getProperties();
-  const char* getProperty(const char* key);
-  void setProperty(std::string key, std::string value);
-  void getProcesses(std::vector<ActorPtr> * list);
-  int get_actor_count();
-  double getPstateSpeed(int pstate_index);
-  int getPstatesCount() const;
-  void setPstate(int pstate_index);
-  int getPstate();
+  int get_core_count();
+  double get_load();
+
+  double get_pstate_speed(int pstate_index);
+  int get_pstate_count() const;
+  void set_pstate(int pstate_index);
+  int get_pstate();
+
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_speed() instead.") double getSpeed() { return get_speed(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_speed() instead.") double getPstateSpeed(int pstate_index)
+  {
+    return get_pstate_speed(pstate_index);
+  }
+
   std::vector<const char*> get_attached_storages();
   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
       std::vector<const char*>* storages);
@@ -115,10 +132,14 @@ public:
    *
    *  This is defined in the platform file, and cannot be modified programatically (yet).
    */
-  std::unordered_map<std::string, Storage*> const& getMountedStorages();
+  std::unordered_map<std::string, Storage*> const& get_mounted_storages();
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_mounted_storages() instead.") std::unordered_map<std::string, Storage*> const& getMountedStorages()
+  {
+    return get_mounted_storages();
+  }
 
-  void routeTo(Host* dest, std::vector<Link*>& links, double* latency);
-  void routeTo(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
+  void route_to(Host* dest, std::vector<Link*>& links, double* latency);
+  void route_to(Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency);
 
   /** Block the calling actor on an execution located on the called host
    *
@@ -129,19 +150,45 @@ public:
   /** Block the calling actor on an execution located on the called host (with explicit priority) */
   void execute(double flops, double priority);
 
-  /** @brief Returns the current computation load (in flops per second)
-   * The external load (coming from an availability trace) is not taken in account.
-   *
-   * @return      The number of activities currently running on a host (an activity at priority 2 is counted twice).
-   */
-  double getLoad();
-
   // Deprecated functions
   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
   {
     return name_;
   }
   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_cname()") const char* getCname() const { return name_.c_str(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void actorList(std::vector<ActorPtr>* whereto);
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_all_actors()") void getProcesses(std::vector<ActorPtr>* list);
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_on()") void turnOn() { turn_on(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::turn_off()") void turnOff() { turn_off(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_on()") bool isOn() { return is_on(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::is_off()") bool isOff() { return is_off(); }
+
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_property()") const char* getProperty(const char* key)
+  {
+    return get_property(key);
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_property()") void setProperty(std::string key, std::string value)
+  {
+    set_property(key, value);
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::set_pstate()") void setPstate(int idx) { set_pstate(idx); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate()") int getPstate() { return get_pstate(); }
+
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(Host* dest, std::vector<Link*>& links,
+                                                                         double* latency)
+  {
+    route_to(dest, links, latency);
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::route_to()") void routeTo(
+      Host* dest, std::vector<kernel::resource::LinkImpl*>& links, double* latency)
+  {
+    route_to(dest, links, latency);
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_core_count()") int getCoreCount() { return get_core_count(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_pstate_count()") int getPstatesCount() const
+  {
+    return get_pstate_count();
+  }
 
 private:
   simgrid::xbt::string name_{"noname"};