Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cleanups in Action::State
[simgrid.git] / include / simgrid / s4u / Storage.hpp
index 7dd83db..13ae9be 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2006-2015, 2017-2018. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2006-2018. 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. */
@@ -7,13 +6,13 @@
 #ifndef INCLUDE_SIMGRID_S4U_STORAGE_HPP_
 #define INCLUDE_SIMGRID_S4U_STORAGE_HPP_
 
-#include "xbt/Extendable.hpp"
+#include <simgrid/forward.h>
+#include <xbt/Extendable.hpp>
+#include <xbt/base.h>
+
 #include <map>
-#include <simgrid/s4u/forward.hpp>
-#include <simgrid/simix.h>
 #include <string>
 #include <unordered_map>
-#include <xbt/base.h>
 
 namespace simgrid {
 namespace xbt {
@@ -21,10 +20,11 @@ extern template class XBT_PUBLIC Extendable<simgrid::s4u::Storage>;
 }
 namespace s4u {
 
-XBT_PUBLIC void getStorageList(std::map<std::string, Storage*>* whereTo);
+XBT_ATTRIB_DEPRECATED_v322(
+    "simgrid::s4u::getStorageList() is deprecated in favor of Engine::getAllStorages(). Please switch before v3.22")
+    XBT_PUBLIC void getStorageList(std::map<std::string, Storage*>* whereTo);
 
-XBT_PUBLIC_CLASS Storage : public simgrid::xbt::Extendable<Storage>
-{
+class XBT_PUBLIC Storage : public simgrid::xbt::Extendable<Storage> {
   friend s4u::Engine;
   friend simgrid::surf::StorageImpl;
 
@@ -33,10 +33,15 @@ public:
   virtual ~Storage() = default;
   /** Retrieve a Storage by its name. It must exist in the platform file */
   static Storage* byName(std::string name);
+
+  XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_name()") std::string const& getName() const { return get_name(); }
+  XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_cname()") const char* getCname() const { return get_cname(); }
+
   /** @brief Retrieves the name of that storage as a C++ string */
-  std::string const& getName() const;
+  std::string const& get_name() const;
   /** @brief Retrieves the name of that storage as a C string */
-  const char* getCname() const;
+  const char* get_cname() const;
+
   const char* getType();
   Host* getHost();
 
@@ -52,11 +57,12 @@ public:
   surf::StorageImpl* getImpl() { return pimpl_; }
 
   /* The signals */
-  /** @brief Callback signal fired when a new Link is created */
-  static simgrid::xbt::signal<void(s4u::Storage&)> onCreation;
-
-  /** @brief Callback signal fired when a Link is destroyed */
-  static simgrid::xbt::signal<void(s4u::Storage&)> onDestruction;
+  /** @brief Callback signal fired when a new Storage is created */
+  static simgrid::xbt::signal<void(s4u::Storage&)> on_creation;
+  /** @brief Callback signal fired when a Storage is destroyed */
+  static simgrid::xbt::signal<void(s4u::Storage&)> on_destruction;
+  /** @brief Callback signal fired when a Storage's state changes */
+  static simgrid::xbt::signal<void(s4u::Storage&)> on_state_change;
 
   Host* attached_to_              = nullptr;