Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetic cleanups in S4U
[simgrid.git] / include / simgrid / s4u / Engine.hpp
index b7616a4..0d4aee0 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2019. 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. */
@@ -39,7 +39,7 @@ public:
   /** @brief Run the simulation */
   void run();
 
-  /** @brief Retrieve the simulation time */
+  /** @brief Retrieve the simulation time (in seconds) */
   static double get_clock();
   /** @brief Retrieve the engine singleton */
   static s4u::Engine* get_instance();
@@ -49,12 +49,12 @@ public:
    * The environment is either a XML file following the simgrid.dtd formalism, or a lua file.
    * Some examples can be found in the directory examples/platforms.
    */
-  void load_platform(std::string platf);
+  void load_platform(const std::string& platf);
 
   /** Registers the main function of an actor that will be launched from the deployment file */
-  void register_function(std::string name, int (*code)(int, char**));
+  void register_function(const std::string& name, int (*code)(int, char**));
   /** Registers the main function of an actor that will be launched from the deployment file */
-  void register_function(std::string name, void (*code)(std::vector<std::string>));
+  void register_function(const std::string& name, void (*code)(std::vector<std::string>));
 
   /** Registers a function as the default main function of actors
    *
@@ -63,25 +63,25 @@ public:
    */
   void register_default(int (*code)(int, char**));
 
-  template <class F> void register_actor(std::string name)
+  template <class F> void register_actor(const std::string& name)
   {
-    simgrid::simix::register_function(name, [](std::vector<std::string> args) {
-      return simgrid::simix::ActorCode([args] {
+    simix::register_function(name, [](std::vector<std::string> args) {
+      return simix::ActorCode([args] {
         F code(std::move(args));
         code();
       });
     });
   }
 
-  template <class F> void register_actor(std::string name, F code)
+  template <class F> void register_actor(const std::string& name, F code)
   {
-    simgrid::simix::register_function(name, [code](std::vector<std::string> args) {
-      return simgrid::simix::ActorCode([code, args] { code(std::move(args)); });
+    simix::register_function(name, [code](std::vector<std::string> args) {
+      return simix::ActorCode([code, args] { code(std::move(args)); });
     });
   }
 
   /** @brief Load a deployment file and launch the actors that it contains */
-  void load_deployment(std::string deploy);
+  void load_deployment(const std::string& deploy);
 
 protected:
 #ifndef DOXYGEN
@@ -91,12 +91,12 @@ protected:
   friend kernel::routing::NetPoint;
   friend kernel::routing::NetZoneImpl;
   friend kernel::resource::LinkImpl;
-  void host_register(std::string name, Host* host);
-  void host_unregister(std::string name);
-  void link_register(std::string name, Link* link);
-  void link_unregister(std::string name);
-  void storage_register(std::string name, Storage* storage);
-  void storage_unregister(std::string name);
+  void host_register(const std::string& name, Host* host);
+  void host_unregister(const std::string& name);
+  void link_register(const std::string& name, Link* link);
+  void link_unregister(const std::string& name);
+  void storage_register(const std::string& name, Storage* storage);
+  void storage_unregister(const std::string& name);
   void netpoint_register(simgrid::kernel::routing::NetPoint* card);
   void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
 #endif /*DOXYGEN*/
@@ -105,32 +105,32 @@ public:
   size_t get_host_count();
   /** @brief Returns the list of all hosts found in the platform */
   std::vector<Host*> get_all_hosts();
-  std::vector<Host*> get_filtered_hosts(std::function<bool(Host*)> filter);
-  simgrid::s4u::Host* host_by_name(std::string name);
-  simgrid::s4u::Host* host_by_name_or_null(std::string name);
+  std::vector<Host*> get_filtered_hosts(const std::function<bool(Host*)>& filter);
+  Host* host_by_name(const std::string& name);
+  Host* host_by_name_or_null(const std::string& name);
 
   size_t get_link_count();
   std::vector<Link*> get_all_links();
-  std::vector<Link*> get_filtered_links(std::function<bool(Link*)> filter);
-  simgrid::s4u::Link* link_by_name(std::string name);
-  simgrid::s4u::Link* link_by_name_or_null(std::string name);
+  std::vector<Link*> get_filtered_links(const std::function<bool(Link*)>& filter);
+  Link* link_by_name(const std::string& name);
+  Link* link_by_name_or_null(const std::string& name);
 
   size_t get_actor_count();
   std::vector<ActorPtr> get_all_actors();
-  std::vector<ActorPtr> get_filtered_actors(std::function<bool(ActorPtr)> filter);
+  std::vector<ActorPtr> get_filtered_actors(const std::function<bool(ActorPtr)>& filter);
 
   size_t get_storage_count();
   std::vector<Storage*> get_all_storages();
-  simgrid::s4u::Storage* storage_by_name(std::string name);
-  simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
+  Storage* storage_by_name(const std::string& name);
+  Storage* storage_by_name_or_null(const std::string& name);
 
-  std::vector<simgrid::kernel::routing::NetPoint*> get_all_netpoints();
-  simgrid::kernel::routing::NetPoint* netpoint_by_name_or_null(std::string name);
+  std::vector<kernel::routing::NetPoint*> get_all_netpoints();
+  kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name);
 
-  simgrid::s4u::NetZone* get_netzone_root();
-  void set_netzone_root(s4u::NetZone* netzone);
+  NetZone* get_netzone_root();
+  void set_netzone_root(NetZone* netzone);
 
-  simgrid::s4u::NetZone* netzone_by_name_or_null(std::string name);
+  NetZone* netzone_by_name_or_null(const std::string& name);
 
   /** @brief Retrieves all netzones of the type indicated by the template argument */
   template <class T> std::vector<T*> get_filtered_netzones()
@@ -152,22 +152,22 @@ public:
    * Example:
    * e->set_config("host/model:ptask_L07");
    */
-  void set_config(std::string str);
+  void set_config(const std::string& str);
 
 private:
-  simgrid::kernel::EngineImpl* pimpl;
-  static s4u::Engine* instance_;
+  kernel::EngineImpl* const pimpl;
+  static Engine* instance_;
 
   //////////////// Deprecated functions
 #ifndef DOXYGEN
 public:
   /** @deprecated See Engine::load_platform() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(std::string platf)
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(const std::string& platf)
   {
     load_platform(platf);
   }
   /** @deprecated See Engine::register_function() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(std::string name,
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_function()") void registerFunction(const std::string& name,
                                                                                              int (*code)(int, char**))
   {
     register_function(name, code);
@@ -179,42 +179,44 @@ public:
   }
   /** @deprecated See Engine::register_actor() */
   template <class F>
-  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(std::string name)
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const std::string& name)
   {
     register_actor<F>(name);
   }
   /** @deprecated See Engine::register_actor() */
   template <class F>
-  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(std::string name, F code)
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::register_actor()") void registerFunction(const std::string& name,
+                                                                                          F code)
   {
     register_actor<F>(name, code);
   }
 
   /** @deprecated See Engine::load_deployment() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(std::string deploy)
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_deployment()") void loadDeployment(const std::string& deploy)
   {
     load_deployment(deploy);
   }
   /** @deprecated See Engine::host_by_name() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(std::string name)
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name()") simgrid::s4u::Host* hostByName(
+      const std::string& name)
   {
     return host_by_name(name);
   }
   /** @deprecated See Engine::host_by_name_or_null() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::host_by_name_or_null()") simgrid::s4u::Host* hostByNameOrNull(
-      std::string name)
+      const std::string& name)
   {
     return host_by_name_or_null(name);
   }
   /** @deprecated See Engine::storage_by_name() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name()") simgrid::s4u::Storage* storageByName(
-      std::string name)
+      const std::string& name)
   {
     return storage_by_name(name);
   }
   /** @deprecated See Engine::storage_by_name_or_null() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::storage_by_name_or_null()") simgrid::s4u::Storage* storageByNameOrNull(
-      std::string name)
+      const std::string& name)
   {
     return storage_by_name_or_null(name);
   }
@@ -244,7 +246,8 @@ public:
   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_netpoints()") void getNetpointList(
       std::vector<simgrid::kernel::routing::NetPoint*>* list);
   /** @deprecated See Engine::netpoint_by_name_or_null() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netpoint_by_name_or_null()") simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name)
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netpoint_by_name_or_null()")
+      simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(const std::string& name)
   {
     return netpoint_by_name_or_null(name);
   }
@@ -254,8 +257,8 @@ public:
     return get_netzone_root();
   }
   /** @deprecated See Engine::netzone_by_name_or_null() */
-  XBT_ATTRIB_DEPRECATED_v323(
-      "Please use Engine::netzone_by_name_or_null()") simgrid::s4u::NetZone* getNetzoneByNameOrNull(std::string name)
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::netzone_by_name_or_null()")
+      simgrid::s4u::NetZone* getNetzoneByNameOrNull(const std::string& name)
   {
     return netzone_by_name_or_null(name);
   }
@@ -278,7 +281,10 @@ public:
     return is_initialized();
   }
   /** @deprecated See Engine::set_config() */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(std::string str) { set_config(str); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(const std::string& str)
+  {
+    set_config(str);
+  }
 #endif
 };
 
@@ -306,12 +312,13 @@ template <class T> XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone
                 "Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
   for (auto const& elem : current->get_children()) {
     get_filtered_netzones_recursive(elem, whereto);
-    if (elem->get_impl() == dynamic_cast<T*>(elem->get_impl()))
-      whereto->push_back(dynamic_cast<T*>(elem->get_impl()));
+    T* elem_impl = dynamic_cast<T*>(elem->get_impl());
+    if (elem_impl != nullptr)
+      whereto->push_back(elem_impl);
   }
 }
 #endif
-}
-} // namespace simgrid::s4u
+} // namespace s4u
+} // namespace simgrid
 
 #endif /* SIMGRID_S4U_ENGINE_HPP */