Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Dynamic cast without checking result is slow and useless. Use static cast.
[simgrid.git] / include / simgrid / s4u / Engine.hpp
index 7a06b51..cc6a2a8 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,7 +63,7 @@ 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] {
@@ -73,7 +73,7 @@ public:
     });
   }
 
-  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)); });
@@ -81,7 +81,7 @@ public:
   }
 
   /** @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*/
@@ -106,14 +106,14 @@ public:
   /** @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);
+  simgrid::s4u::Host* host_by_name(const std::string& name);
+  simgrid::s4u::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);
+  simgrid::s4u::Link* link_by_name(const std::string& name);
+  simgrid::s4u::Link* link_by_name_or_null(const std::string& name);
 
   size_t get_actor_count();
   std::vector<ActorPtr> get_all_actors();
@@ -121,16 +121,16 @@ public:
 
   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);
+  simgrid::s4u::Storage* storage_by_name(const std::string& name);
+  simgrid::s4u::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);
+  simgrid::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);
 
-  simgrid::s4u::NetZone* netzone_by_name_or_null(std::string name);
+  simgrid::s4u::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()
@@ -155,10 +155,11 @@ public:
   void set_config(std::string str);
 
 private:
-  simgrid::kernel::EngineImpl* pimpl;
+  simgrid::kernel::EngineImpl* const pimpl;
   static s4u::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)
@@ -278,6 +279,7 @@ public:
   }
   /** @deprecated See Engine::set_config() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(std::string str) { set_config(str); }
+#endif
 };
 
 /** Callback fired when the platform is created (ie, the xml file parsed),
@@ -297,16 +299,19 @@ extern XBT_PUBLIC xbt::signal<void(double)> on_time_advance;
 /** Callback fired when the time cannot advance because of inter-actors deadlock */
 extern XBT_PUBLIC xbt::signal<void(void)> on_deadlock;
 
+#ifndef DOXYGEN /* Internal use only, no need to expose it */
 template <class T> XBT_PRIVATE void get_filtered_netzones_recursive(s4u::NetZone* current, std::vector<T*>* whereto)
 {
   static_assert(std::is_base_of<kernel::routing::NetZoneImpl, T>::value,
                 "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