implement some more getters in surf::Link and s4u::Link

[simgrid.git] / include / simgrid / s4u / Link.hpp

diff --git a/include/simgrid/s4u/Link.hpp b/include/simgrid/s4u/Link.hpp
index af44cb4..f554dfe 100644 (file)
--- a/include/simgrid/s4u/Link.hpp
+++ b/include/simgrid/s4u/Link.hpp
@@ -6,13 +6,12 @@
 #ifndef S4U_LINK_HPP_
 #define S4U_LINK_HPP_
 
-#include <xbt/base.h>
-
+#include <simgrid/link.h>
+#include <string>
 #include <unordered_map>
-
-#include "xbt/signal.hpp"
-
-#include "simgrid/link.h"
+#include <xbt/Extendable.hpp>
+#include <xbt/base.h>
+#include <xbt/signal.hpp>
 
 /***********
  * Classes *
@@ -21,14 +20,13 @@
 namespace simgrid {
 namespace surf {
 class NetworkAction;
-class Action;
 };
 namespace s4u {
 /** @brief A Link represents the network facilities between [hosts](\ref simgrid::s4u::Host) */
-class Link {
+XBT_PUBLIC_CLASS Link : public simgrid::xbt::Extendable<Link>
+{
   friend simgrid::surf::LinkImpl;
 
-private:
   // Links are created from the NetZone, and destroyed by their private implementation when the simulation ends
   explicit Link(surf::LinkImpl* pimpl) : pimpl_(pimpl) {}
   virtual ~Link() = default;
@@ -39,8 +37,10 @@ public:
   /** @brief Retrieve a link from its name */
   static Link* byName(const char* name);
 
-  /** @brief Get da name */
-  const char* name();
+  /** @brief Retrieves the name of that link as a C++ string */
+  const std::string& getName() const;
+  /** @brief Retrieves the name of that link as a C string */
+  const char* getCname() const;
 
   /** @brief Get the bandwidth in bytes per second of current Link */
   double bandwidth();
@@ -52,6 +52,9 @@ public:
    */
   int sharingPolicy();
 
+  /** @brief Returns the current load (in flops per second) */
+  double getUsage();
+
   /** @brief Check if the Link is used */
   bool isUsed();
 
@@ -68,21 +71,26 @@ public:
   void setLatencyTrace(tmgr_trace_t trace); /*< setup the trace file with latency events (peak latency changes due to
                                                external load). Trace must contain absolute values */
 
+  const char* getProperty(const char* key);
+  void setProperty(std::string key, std::string value);
+
   /* The signals */
   /** @brief Callback signal fired when a new Link is created */
-  static simgrid::xbt::signal<void(surf::LinkImpl*)> onCreation;
+  static simgrid::xbt::signal<void(s4u::Link&)> onCreation;
 
   /** @brief Callback signal fired when a Link is destroyed */
-  static simgrid::xbt::signal<void(surf::LinkImpl*)> onDestruction;
+  static simgrid::xbt::signal<void(s4u::Link&)> onDestruction;
 
   /** @brief Callback signal fired when the state of a Link changes (when it is turned on or off) */
-  static simgrid::xbt::signal<void(surf::LinkImpl*)> onStateChange;
+  static simgrid::xbt::signal<void(s4u::Link&)> onStateChange;
 
   /** @brief Callback signal fired when a communication starts */
   static simgrid::xbt::signal<void(surf::NetworkAction*, s4u::Host* src, s4u::Host* dst)> onCommunicate;
 
   /** @brief Callback signal fired when a communication changes it state (ready/done/cancel) */
   static simgrid::xbt::signal<void(surf::NetworkAction*)> onCommunicationStateChange;
+
+  XBT_ATTRIB_DEPRECATED_v321("Use getCname(): v3.21 will turn this warning into an error.") const char* name();
 };
 }
 }