snake_case and cleanup some more methods of s4u::Engine

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

diff --git a/include/simgrid/s4u/Engine.hpp b/include/simgrid/s4u/Engine.hpp
index f71fff5..c55e376 100644 (file)
--- a/include/simgrid/s4u/Engine.hpp
+++ b/include/simgrid/s4u/Engine.hpp
@@ -33,6 +33,14 @@ public:
   /** Finalize the default engine and all its dependencies */
   static void shutdown();
 
+  /** @brief Run the simulation */
+  void run();
+
+  /** @brief Retrieve the simulation time */
+  static double get_clock();
+  /** @brief Retrieve the engine singleton */
+  static s4u::Engine* get_instance();
+
   /** @brief Load a platform file describing the environment
    *
    * The environment is either a XML file following the simgrid.dtd formalism, or a lua file.
@@ -75,10 +83,14 @@ public:
 protected:
   friend s4u::Host;
   friend s4u::Storage;
-  void add_host(std::string name, simgrid::s4u::Host* host);
-  void del_host(std::string name);
-  void add_storage(std::string name, simgrid::s4u::Storage* storage);
-  void del_storage(std::string name);
+  friend kernel::routing::NetPoint;
+  friend kernel::routing::NetZoneImpl;
+  void host_register(std::string name, simgrid::s4u::Host* host);
+  void host_unregister(std::string name);
+  void storage_register(std::string name, simgrid::s4u::Storage* storage);
+  void storage_unregister(std::string name);
+  void netpoint_register(simgrid::kernel::routing::NetPoint* card);
+  void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
 
 public:
   size_t get_host_count();
@@ -94,41 +106,38 @@ public:
   simgrid::s4u::Storage* storage_by_name(std::string name);
   simgrid::s4u::Storage* storage_by_name_or_null(std::string name);
 
-  /** @brief Run the simulation */
-  void run();
-
-  /** @brief Retrieve the simulation time */
-  static double get_clock();
-
-  /** @brief Retrieve the engine singleton */
-  static s4u::Engine* getInstance();
+  std::vector<simgrid::kernel::routing::NetPoint*> get_all_netpoints();
 
   /** @brief Retrieve the root netzone, containing all others */
   simgrid::s4u::NetZone* getNetRoot();
 
-  /** @brief Retrieve the netzone of the given name (or nullptr if not found) */
   simgrid::s4u::NetZone* getNetzoneByNameOrNull(const char* name);
 
   /** @brief Retrieves all netzones of the same type than the subtype of the whereto vector */
   template <class T> void getNetzoneByType(std::vector<T*> * whereto) { netzoneByTypeRecursive(getNetRoot(), whereto); }
+
   /** @brief Retrieve the netcard of the given name (or nullptr if not found) */
   simgrid::kernel::routing::NetPoint* getNetpointByNameOrNull(std::string name);
-  void getNetpointList(std::vector<simgrid::kernel::routing::NetPoint*> * list);
-  void netpointRegister(simgrid::kernel::routing::NetPoint * card);
-  void netpointUnregister(simgrid::kernel::routing::NetPoint * card);
 
   /** Returns whether SimGrid was initialized yet -- mostly for internal use */
-  static bool isInitialized();
-
+  static bool is_initialized();
   /** @brief set a configuration variable
    *
-   * Do --help on any simgrid binary to see the list of currently existing configuration variables (see @ref options).
+   * Do --help on any simgrid binary to see the list of currently existing configuration variables (see also @ref
+   * options).
    *
    * Example:
-   * e->setConfig("host/model","ptask_L07");
+   * e->set_config("host/model:ptask_L07");
    */
-  void setConfig(std::string str);
+  void set_config(std::string str);
 
+  simgrid::kernel::EngineImpl* pimpl;
+
+private:
+  static s4u::Engine* instance_;
+
+  //////////////// Deprecated functions
+public:
   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::load_platform()") void loadPlatform(const char* platf)
   {
     load_platform(platf);
@@ -197,11 +206,17 @@ public:
     return get_all_storages();
   }
   XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_clock()") static double getClock() { return get_clock(); }
-
-  simgrid::kernel::EngineImpl* pimpl;
-
-private:
-  static s4u::Engine* instance_;
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_all_netpoints()") void getNetpointList(
+      std::vector<simgrid::kernel::routing::NetPoint*>* list);
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::get_instance()") static s4u::Engine* getInstance()
+  {
+    return get_instance();
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::is_initialized()") static bool isInitialized()
+  {
+    return is_initialized();
+  }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Engine::set_config()") void setConfig(std::string str) { set_config(str); }
 };
 
 /** Callback fired when the platform is created (ie, the xml file parsed),