some documentation fixes

[simgrid.git] / src / surf / network_interface.hpp

diff --git a/src/surf/network_interface.hpp b/src/surf/network_interface.hpp
index 9858267..d1f327d 100644 (file)
--- a/src/surf/network_interface.hpp
+++ b/src/surf/network_interface.hpp
@@ -1,20 +1,23 @@
-/* Copyright (c) 2004-2014. The SimGrid Team.
+/* Copyright (c) 2004-2015. 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 SURF_NETWORK_INTERFACE_HPP_
+#define SURF_NETWORK_INTERFACE_HPP_
+
+#include <xbt/base.h>
+
 #include <boost/unordered_map.hpp>
 
 #include "xbt/fifo.h"
+#include "xbt/dict.h"
 #include "surf_interface.hpp"
 #include "surf_routing.hpp"
 
 #include "simgrid/link.h"
 
-#ifndef SURF_NETWORK_INTERFACE_HPP_
-#define SURF_NETWORK_INTERFACE_HPP_
-
 /***********
  * Classes *
  ***********/
@@ -72,12 +75,9 @@ XBT_PUBLIC(void) net_add_traces();
 class NetworkModel : public Model {
 public:
   /** @brief Constructor */
-  NetworkModel() : Model("network") { }
-
-  /** @brief Constructor */
-  NetworkModel(const char *name) : Model(name) { }
+  NetworkModel() : Model() { }
 
-  /** @brief The destructor of the NetworkModel */
+  /** @brief Destructor */
   ~NetworkModel() {
        if (p_maxminSystem)
          lmm_system_free(p_maxminSystem);
@@ -111,8 +111,6 @@ public:
                                    e_surf_link_sharing_policy_t policy,
                                    xbt_dict_t properties)=0;
 
-  virtual void gapAppend(double /*size*/, const Link* /*link*/, NetworkAction */*action*/) {};
-
   /**
    * @brief Create a communication between two hosts.
    * @details It makes calls to the routing part, and execute the communication
@@ -169,7 +167,6 @@ public:
    */
   virtual double bandwidthConstraint(double rate, double bound, double size);
   double shareResourcesFull(double now);
-  bool m_haveGap = false;
 };
 
 /************
@@ -220,12 +217,8 @@ public:
   /** @brief Update the latency in seconds of current Link */
   virtual void updateLatency(double value, double date=surf_get_clock())=0;
 
-  /**
-   * @brief Check if the Link is shared
-   *
-   * @return true if the current NetwokrLink is shared, false otherwise
-   */
-  virtual bool isShared();
+  /** @brief The sharing policy is a @{link #e_surf_link_sharing_policy_t} (0: FATPIPE, 1: SHARED, 2: FULLDUPLEX) */
+  virtual int sharingPolicy();
 
   /** @brief Check if the Link is used */
   bool isUsed();
@@ -234,12 +227,12 @@ public:
 
   /* Using this object with the public part of
     model does not make sense */
-  double m_latCurrent;
-  tmgr_trace_event_t p_latEvent;
+  double m_latCurrent = 0;
+  tmgr_trace_event_t p_latEvent = NULL;
 
   /* LMM */
   tmgr_trace_event_t p_stateEvent = NULL;
-  s_surf_metric_t p_power;
+  s_surf_metric_t p_speed;
 
   /* User data */
 public:
@@ -267,8 +260,7 @@ public:
  */
 class NetworkAction : public Action {
 public:
-  /**
-   * @brief NetworkAction constructor
+  /** @brief Constructor
    *
    * @param model The NetworkModel associated to this NetworkAction
    * @param cost The cost of this  NetworkAction in [TODO]
@@ -305,7 +297,6 @@ public:
   double m_weight;
   double m_rate;
   const char* p_senderLinkName;
-  double m_senderGap;
   double m_senderSize;
   xbt_fifo_item_t p_senderFifoItem;
 #ifdef HAVE_LATENCY_BOUND_TRACKING