X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4871b54f42ce85370d6acdbcb7e42bf75a63b389..6c12a132ca10eefd1d566e489e837e459db4d979:/src/surf/surf_routing.hpp

diff --git a/src/surf/surf_routing.hpp b/src/surf/surf_routing.hpp
index 8c2c90f9a5..ac65feedf3 100644
--- a/src/surf/surf_routing.hpp
+++ b/src/surf/surf_routing.hpp
@@ -1,3 +1,9 @@
+/* Copyright (c) 2013-2014. 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. */
+
 #include "surf_interface.hpp"
 #include <float.h>
 
@@ -14,6 +20,9 @@ xbt_edge_t new_xbt_graph_edge (xbt_graph_t graph, xbt_node_t s, xbt_node_t d, xb
 /***********
  * Classes *
  ***********/
+
+/* Note: As and RoutingEdge are declard as struct instead of class, to keep
+   compatibility with C files where they are mentioned. */
 struct As;
 typedef As *AsPtr;
 
@@ -29,6 +38,10 @@ typedef Onelink *OnelinkPtr;
 class RoutingPlatf;
 typedef RoutingPlatf *RoutingPlatfPtr;
 
+/** @ingroup SURF_routing_interface
+ * @brief The Autonomous System (AS) routing interface
+ * @details [TODO]
+ */
 struct As {
 public:
   xbt_dynar_t p_indexNetworkElm;
@@ -41,11 +54,27 @@ public:
   RoutingEdgePtr p_netElem;
   xbt_dynar_t p_linkUpDownList;
 
+  /**
+   * @brief The As constructor
+   */
   As(){};
+
+  /**
+   * @brief The As destructor
+   */
   virtual ~As(){
 	xbt_free(p_name);
   };
 
+  /**
+   * @brief Get the route and latency between two RoutingEdgs
+   * @details [long description]
+   * 
+   * @param src [description]
+   * @param dst [description]
+   * @param into [description]
+   * @param latency [description]
+   */
   virtual void getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst, sg_platf_route_cbarg_t into, double *latency)=0;
   virtual xbt_dynar_t getOneLinkRoutes()=0;
   virtual void getGraph(xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges)=0;
@@ -62,17 +91,56 @@ public:
   virtual void parseBypassroute(sg_platf_route_cbarg_t e_route)=0;
 };
 
+/** @ingroup SURF_routing_interface
+ * @brief A routing edge
+ * @details [long description]
+ */
 struct RoutingEdge {
 public:
-  ~RoutingEdge() { xbt_free(p_name);};
+  virtual ~RoutingEdge(){};
+  virtual int getId()=0;
+  virtual int *getIdPtr()=0;
+  virtual void setId(int id)=0;
+  virtual char *getName()=0;
+  virtual AsPtr getRcComponent()=0;
+  virtual e_surf_network_element_type_t getRcType()=0;
+};
+
+struct RoutingEdgeImpl : public RoutingEdge {
+public:
+  RoutingEdgeImpl(char *name, int id, e_surf_network_element_type_t rcType, AsPtr rcComponent)
+  : p_rcComponent(rcComponent), p_rcType(rcType), m_id(id), p_name(name) {}
+  ~RoutingEdgeImpl() { xbt_free(p_name);};
+
+  int getId() {return m_id;}
+  int *getIdPtr() {return &m_id;}
+  void setId(int id) {m_id = id;}
+  char *getName() {return p_name;}
+  AsPtr getRcComponent() {return p_rcComponent;}
+  e_surf_network_element_type_t getRcType() {return p_rcType;}
+private:
   AsPtr p_rcComponent;
   e_surf_network_element_type_t p_rcType;
   int m_id;
   char *p_name;
 };
 
-/*
- * Link of lenght 1, alongside with its source and destination. This is mainly usefull in the bindings to gtnets and ns3
+struct RoutingEdgeWrapper : public RoutingEdge {
+public:
+  RoutingEdgeWrapper(RoutingEdge *re) : p_re(re){}
+  ~RoutingEdgeWrapper(){}
+  int getId() {return p_re->getId();}
+  int *getIdPtr() {return p_re->getIdPtr();}
+  void setId(int id) {p_re->setId(id);}
+  char *getName() {return p_re->getName();}
+  AsPtr getRcComponent() {return p_re->getRcComponent();}
+  e_surf_network_element_type_t getRcType() {return p_re->getRcType();}
+private:
+  RoutingEdge *p_re;
+};
+
+/** @ingroup SURF_routing_interface
+ * @brief Link of lenght 1, alongside with its source and destination. This is mainly usefull in the bindings to gtnets and ns3
  */
 class Onelink {
 public:
@@ -83,7 +151,10 @@ public:
   void *p_link;
 };
 
-class RoutingPlatf {
+/** @ingroup SURF_routing_interface
+ * @brief The class representing a whole routing platform
+ */
+XBT_PUBLIC_CLASS RoutingPlatf {
 public:
   ~RoutingPlatf();
   AsPtr p_root;