Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
s4u::Disk allow chaining set_property
[simgrid.git] / include / simgrid / s4u / Disk.hpp
index 106da72..2ef3828 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2019-2021. 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. */
@@ -6,6 +6,7 @@
 #ifndef INCLUDE_SIMGRID_S4U_DISK_HPP_
 #define INCLUDE_SIMGRID_S4U_DISK_HPP_
 
+#include <simgrid/disk.h>
 #include <simgrid/forward.h>
 #include <simgrid/s4u/Io.hpp>
 #include <xbt/Extendable.hpp>
@@ -17,6 +18,9 @@
 #include <unordered_map>
 
 namespace simgrid {
+
+extern template class XBT_PUBLIC xbt::Extendable<s4u::Disk>;
+
 namespace s4u {
 
 /** Disk represent the disk resources associated to a host
@@ -26,17 +30,22 @@ namespace s4u {
  */
 
 class XBT_PUBLIC Disk : public xbt::Extendable<Disk> {
+  kernel::resource::DiskImpl* const pimpl_;
+  std::string name_;
   friend Engine;
   friend Io;
   friend kernel::resource::DiskImpl;
 
-public:
-  explicit Disk(const std::string& name, kernel::resource::DiskImpl* pimpl) : pimpl_(pimpl), name_(name) {}
-
 protected:
+#ifndef DOXYGEN
   virtual ~Disk() = default;
+#endif
 
 public:
+#ifndef DOXYGEN
+  explicit Disk(const std::string& name, kernel::resource::DiskImpl* pimpl) : pimpl_(pimpl), name_(name) {}
+#endif
+
   /** @brief Callback signal fired when a new Disk is created */
   static xbt::signal<void(Disk&)> on_creation;
   /** @brief Callback signal fired when a Disk is destroyed */
@@ -45,27 +54,35 @@ public:
   static xbt::signal<void(Disk const&)> on_state_change;
 
   /** @brief Retrieves the name of that disk as a C++ string */
+  Disk* set_name(std::string const& name);
   std::string const& get_name() const { return name_; }
   /** @brief Retrieves the name of that disk as a C string */
   const char* get_cname() const { return name_.c_str(); }
 
+  Disk* set_read_bandwidth(double read_bw);
+  double get_read_bandwidth() const;
+
+  Disk* set_write_bandwidth(double write_bw);
+  double get_write_bandwidth() const;
+
   const std::unordered_map<std::string, std::string>* get_properties() const;
   const char* get_property(const std::string& key) const;
-  void set_property(const std::string&, const std::string& value);
-  Host* get_host();
+  Disk* set_property(const std::string&, const std::string& value);
+  Disk* set_host(Host* host);
+  Host* get_host() const;
 
-  IoPtr io_init(sg_size_t size, s4u::Io::OpType type);
+  IoPtr io_init(sg_size_t size, s4u::Io::OpType type) const;
 
-  IoPtr read_async(sg_size_t size);
-  sg_size_t read(sg_size_t size);
+  IoPtr read_async(sg_size_t size) const;
+  sg_size_t read(sg_size_t size) const;
 
-  IoPtr write_async(sg_size_t size);
-  sg_size_t write(sg_size_t size);
-  kernel::resource::DiskImpl* get_impl() const { return pimpl_; }
+  IoPtr write_async(sg_size_t size) const;
+  sg_size_t write(sg_size_t size) const;
+  Disk* seal();
 
-private:
-  kernel::resource::DiskImpl* const pimpl_;
-  std::string name_;
+#ifndef DOXYGEN
+  kernel::resource::DiskImpl* get_impl() const { return pimpl_; }
+#endif
 };
 
 } // namespace s4u