X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/8bc9c439c4a1c367ba66c4d6490c9be7349bd430..6c2c52a21d74a8c75d09d7e31e8f360ab9b1873d:/include/simgrid/s4u/Link.hpp

diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp
index b8eced3ed7..8a9c7235d6 100644
--- a/include/simgrid/s4u/Link.hpp
+++ b/include/simgrid/s4u/Link.hpp
@@ -1,4 +1,4 @@
-/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-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. */
@@ -21,8 +21,8 @@
 namespace simgrid {
 namespace s4u {
 /** @brief A Link represents the network facilities between [hosts](@ref simgrid::s4u::Host) */
-class XBT_PUBLIC Link : public simgrid::xbt::Extendable<Link> {
-  friend simgrid::kernel::resource::LinkImpl;
+class XBT_PUBLIC Link : public xbt::Extendable<Link> {
+  friend kernel::resource::LinkImpl;
 
   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
   explicit Link(kernel::resource::LinkImpl* pimpl) : pimpl_(pimpl) {}
@@ -36,8 +36,8 @@ public:
   kernel::resource::LinkImpl* get_impl() { return pimpl_; }
 
   /** @brief Retrieve a link from its name */
-  static Link* by_name(std::string name);
-  static Link* by_name_or_null(std::string name);
+  static Link* by_name(const std::string& name);
+  static Link* by_name_or_null(const std::string& name);
 
   /** @brief Retrieves the name of that link as a C++ string */
   const std::string& get_name() const;
@@ -45,10 +45,10 @@ public:
   const char* get_cname() const;
 
   /** @brief Get the bandwidth in bytes per second of current Link */
-  double get_bandwidth();
+  double get_bandwidth() const;
 
   /** @brief Get the latency in seconds of current Link */
-  double get_latency();
+  double get_latency() const;
 
   /** @brief Describes how the link is shared between flows */
   SharingPolicy get_sharing_policy();
@@ -60,39 +60,60 @@ public:
   bool is_used();
 
   void turn_on();
+  bool is_on() const;
   void turn_off();
 
   void* get_data(); /** Should be used only from the C interface. Prefer extensions in C++ */
   void set_data(void* d);
 
-  void set_state_trace(tmgr_trace_t trace);     /*< setup the trace file with states events (ON or OFF). Trace must contain
-                                                  boolean values. */
-  void set_bandwidth_trace(tmgr_trace_t trace); /*< setup the trace file with bandwidth events (peak speed changes due to
-                                                  external load). Trace must contain percentages (value between 0 and 1). */
-  void set_latency_trace(tmgr_trace_t trace);   /*< setup the trace file with latency events (peak latency changes due to
-                                                  external load). Trace must contain absolute values */
+#ifndef DOXYGEN
+  XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_state_profile()") void set_state_trace(
+      kernel::profile::Profile* profile)
+  {
+    set_state_profile(profile);
+  }
+  XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_bandwidth_profile()") void set_bandwidth_trace(
+      kernel::profile::Profile* profile)
+  {
+    set_bandwidth_profile(profile);
+  }
+  XBT_ATTRIB_DEPRECATED_v325("Please use Link::set_latency_profile()") void set_latency_trace(
+      kernel::profile::Profile* profile)
+  {
+    set_latency_profile(profile);
+  }
+#endif
+
+  /** Setup the profile with states events (ON or OFF). The profile must contain boolean values. */
+  void set_state_profile(kernel::profile::Profile* profile);
+  /** Setup the profile with bandwidth events (peak speed changes due to external load).
+   * The profile must contain percentages (value between 0 and 1). */
+  void set_bandwidth_profile(kernel::profile::Profile* profile);
+  /** Setup the profile file with latency events (peak latency changes due to external load).
+   * The profile must contain absolute values */
+  void set_latency_profile(kernel::profile::Profile* profile);
 
-  const char* get_property(std::string key);
-  void set_property(std::string key, std::string value);
+  const char* get_property(const std::string& key);
+  void set_property(const std::string& key, const std::string& value);
 
   /* The signals */
   /** @brief Callback signal fired when a new Link is created */
-  static simgrid::xbt::signal<void(s4u::Link&)> on_creation;
+  static xbt::signal<void(Link&)> on_creation;
 
   /** @brief Callback signal fired when a Link is destroyed */
-  static simgrid::xbt::signal<void(s4u::Link&)> on_destruction;
+  static xbt::signal<void(Link const&)> on_destruction;
 
   /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
-  static simgrid::xbt::signal<void(s4u::Link&)> on_state_change;
+  static xbt::signal<void(Link const&)> on_state_change;
 
   /** @brief Callback signal fired when the bandwidth of a Link changes */
-  static simgrid::xbt::signal<void(s4u::Link&)> on_bandwidth_change;
+  static xbt::signal<void(Link const&)> on_bandwidth_change;
 
   /** @brief Callback signal fired when a communication starts */
-  static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, s4u::Host* src, s4u::Host* dst)> on_communicate;
+  static xbt::signal<void(kernel::resource::NetworkAction&, Host* src, Host* dst)> on_communicate;
 
   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
-  static simgrid::xbt::signal<void(kernel::resource::NetworkAction*, kernel::resource::Action::State)>
+  static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
       on_communication_state_change;
 
 #ifndef DOXYGEN
@@ -122,7 +143,11 @@ public:
   /** @deprecated */
   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_property()") const char* getProperty(const char* key) {return get_property(key);}
   /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_property()") void setProperty(std::string key, std::string value) {set_property(key, value);}
+  XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_property()") void setProperty(const std::string& key,
+                                                                                 const std::string& value)
+  {
+    set_property(key, value);
+  }
 
   /** @deprecated */
   XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_data()") void* getData() {return get_data();}
@@ -130,14 +155,26 @@ public:
   XBT_ATTRIB_DEPRECATED_v323("Please use Link::set_data()") void setData(void* d) {set_data(d);}
 
   /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_trace()") void setStateTrace(tmgr_trace_t trace) {set_state_trace(trace);}
+  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_state_profile()") void setStateTrace(
+      kernel::profile::Profile* profile)
+  {
+    set_state_profile(profile);
+  }
   /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_trace()") void setBandwidthTrace(tmgr_trace_t trace) {set_bandwidth_trace(trace);}
+  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth_profile()") void setBandwidthTrace(
+      kernel::profile::Profile* profile)
+  {
+    set_bandwidth_profile(profile);
+  }
   /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_trace()") void setLatencyTrace(tmgr_trace_t trace) {set_latency_trace(trace);}
+  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency_profile()") void setLatencyTrace(
+      kernel::profile::Profile* profile)
+  {
+    set_latency_profile(profile);
+  }
 #endif
 };
-}
-}
+} // namespace s4u
+} // namespace simgrid
 
 #endif /* SURF_NETWORK_INTERFACE_HPP_ */