Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Cosmetics: make #endif's comment match #ifndef.
[simgrid.git] / include / simgrid / s4u / Link.hpp
index 8a9c723..832bd3e 100644 (file)
@@ -1,11 +1,12 @@
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2020. 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. */
 
-#ifndef S4U_LINK_HPP_
-#define S4U_LINK_HPP_
+#ifndef S4U_LINK_HPP
+#define S4U_LINK_HPP
 
+#include <simgrid/forward.h>
 #include <simgrid/kernel/resource/Action.hpp>
 #include <simgrid/link.h>
 #include <string>
@@ -19,6 +20,9 @@
  ***********/
 
 namespace simgrid {
+
+extern template class XBT_PUBLIC xbt::Extendable<s4u::Link>;
+
 namespace s4u {
 /** @brief A Link represents the network facilities between [hosts](@ref simgrid::s4u::Host) */
 class XBT_PUBLIC Link : public xbt::Extendable<Link> {
@@ -31,9 +35,9 @@ class XBT_PUBLIC Link : public xbt::Extendable<Link> {
   kernel::resource::LinkImpl* const pimpl_;
 
 public:
-  enum class SharingPolicy { SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
+  enum class SharingPolicy { WIFI = 3, SPLITDUPLEX = 2, SHARED = 1, FATPIPE = 0 };
 
-  kernel::resource::LinkImpl* get_impl() { return pimpl_; }
+  kernel::resource::LinkImpl* get_impl() const { return pimpl_; }
 
   /** @brief Retrieve a link from its name */
   static Link* by_name(const std::string& name);
@@ -51,39 +55,18 @@ public:
   double get_latency() const;
 
   /** @brief Describes how the link is shared between flows */
-  SharingPolicy get_sharing_policy();
+  SharingPolicy get_sharing_policy() const;
 
   /** @brief Returns the current load (in flops per second) */
-  double get_usage();
+  double get_usage() const;
 
   /** @brief Check if the Link is used (at least one flow uses the link) */
-  bool is_used();
+  bool is_used() const;
 
   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);
-
-#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).
@@ -93,7 +76,7 @@ public:
    * The profile must contain absolute values */
   void set_latency_profile(kernel::profile::Profile* profile);
 
-  const char* get_property(const std::string& key);
+  const char* get_property(const std::string& key) const;
   void set_property(const std::string& key, const std::string& value);
 
   /* The signals */
@@ -115,66 +98,8 @@ public:
   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
   static xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>
       on_communication_state_change;
-
-#ifndef DOXYGEN
-  // Deprecated methods
-  /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::by_name()") static Link* byName(const char* name) { return by_name(name); }
-  /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_name()") const std::string& getName() const { return get_name(); }
-  /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_cname()") const char* getCname() const { return get_cname(); }
-  /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_sharing_policy()") SharingPolicy sharingPolicy() {return get_sharing_policy();}
-  /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_usage()") double getUsage() {return get_usage();}
-  /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::is_used()") bool isUsed() {return is_used();}
-  /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_bandwidth()") double bandwidth() {return get_bandwidth();}
-  /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::get_latency()") double latency() {return get_latency();}
-
-  /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_on()") void turnOn() {turn_on();}
-  /** @deprecated */
-  XBT_ATTRIB_DEPRECATED_v323("Please use Link::turn_off()") void turnOff() {turn_off();}
-
-  /** @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(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();}
-  /** @deprecated */
-  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_profile()") void setStateTrace(
-      kernel::profile::Profile* profile)
-  {
-    set_state_profile(profile);
-  }
-  /** @deprecated */
-  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_profile()") void setLatencyTrace(
-      kernel::profile::Profile* profile)
-  {
-    set_latency_profile(profile);
-  }
-#endif
 };
 } // namespace s4u
 } // namespace simgrid
 
-#endif /* SURF_NETWORK_INTERFACE_HPP_ */
+#endif /* S4U_LINK_HPP */