X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6bc18b576fa4a890d8b9916d292ca67dfbf60dd3..9e3b2f1d55a07271c05db2ed5b3fec27561097f9:/include/simgrid/s4u/Storage.hpp diff --git a/include/simgrid/s4u/Storage.hpp b/include/simgrid/s4u/Storage.hpp index 85005c1259..752c2895ee 100644 --- a/include/simgrid/s4u/Storage.hpp +++ b/include/simgrid/s4u/Storage.hpp @@ -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. */ @@ -19,19 +19,16 @@ namespace simgrid { namespace s4u { -#ifndef DOXYGEN -/** @deprecated Engine::get_all_storages() */ -XBT_ATTRIB_DEPRECATED_v322("Please use Engine::get_all_storages()") XBT_PUBLIC void getStorageList(std::map* whereTo); -#endif - -/** Storage represent the disk resources, usually associated to a given host */ +/** Storage represent the disk resources, usually associated to a given host + * + * By default, SimGrid does not keep track of the actual data being written but + * only computes the time taken by the corresponding data movement. + */ class XBT_PUBLIC Storage : public simgrid::xbt::Extendable { -#ifndef DOXYGEN - friend s4u::Engine; - friend s4u::Io; + friend simgrid::s4u::Engine; + friend simgrid::s4u::Io; friend simgrid::surf::StorageImpl; -#endif /* DOXYGEN */ public: explicit Storage(std::string name, surf::StorageImpl * pimpl); @@ -47,8 +44,8 @@ public: static simgrid::xbt::signal on_state_change; /** Retrieve a Storage by its name. It must exist in the platform file */ - static Storage* by_name(std::string name); - static Storage* by_name_or_null(std::string name); + static Storage* by_name(const std::string& name); + static Storage* by_name_or_null(const std::string& name); /** @brief Retrieves the name of that storage as a C++ string */ std::string const& get_name() const { return name_; } @@ -60,8 +57,8 @@ public: void set_host(Host* host) { attached_to_ = host; } std::unordered_map* get_properties(); - const char* get_property(std::string key); - void set_property(std::string, std::string value); + const char* get_property(const std::string& key); + void set_property(const std::string&, std::string value); void set_data(void* data) { userdata_ = data; } void* get_data() { return userdata_; } @@ -76,6 +73,7 @@ public: surf::StorageImpl* get_impl() { return pimpl_; } // Deprecated functions +#ifndef DOXYGEN /** @deprecated Storage::by_name() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::by_name()") Storage* byName(std::string name) { @@ -112,6 +110,7 @@ public: XBT_ATTRIB_DEPRECATED_v323("Please use Storage::set_data()") void setUserdata(void* data) { set_data(data); } /** @deprecated Storage::get_data() */ XBT_ATTRIB_DEPRECATED_v323("Please use Storage::get_data()") void* getUserdata() { return get_data(); } +#endif private: Host* attached_to_ = nullptr;