routing cleanup: symbol renaming

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

diff --git a/src/surf/surf_routing_dijkstra.hpp b/src/surf/surf_routing_dijkstra.hpp
index 7299cb7..b745657 100644 (file)
--- a/src/surf/surf_routing_dijkstra.hpp
+++ b/src/surf/surf_routing_dijkstra.hpp
@@ -1,9 +1,11 @@
-/* Copyright (c) 2013-2014. The SimGrid Team.
+/* Copyright (c) 2013-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. */
 
+#include <xbt/base.h>
+
 #include "surf_routing_generic.hpp"
 
 #ifndef SURF_ROUTING_DIJKSTRA_HPP_
@@ -23,32 +25,48 @@ typedef struct route_cache_element {
   int size;
 } s_route_cache_element_t, *route_cache_element_t;
 
+namespace simgrid {
+namespace surf {
+
 /***********
  * Classes *
  ***********/
-class AsDijkstra;
-typedef AsDijkstra *AsDijkstraPtr;
 
+class XBT_PRIVATE AsDijkstra;
+
+/** Dijkstra routing data: fast initialization, slow lookup, small memory requirements, shortest path routing only */
 class AsDijkstra : public AsGeneric {
 public:
-  AsDijkstra();
-  AsDijkstra(int cached);
+  AsDijkstra(const char*name, bool cached);
+  void Seal() override;
+
   ~AsDijkstra();
-       xbt_node_t routeGraphNewNode(int id, int graph_id);
-       graph_node_map_element_t nodeMapSearch(int id);
-       void newRoute(int src_id, int dst_id, sg_platf_route_cbarg_t e_route);
-       void addLoopback();
-       void getRouteAndLatency(RoutingEdgePtr src, RoutingEdgePtr dst, sg_platf_route_cbarg_t route, double *lat);
-       xbt_dynar_t getOnelinkRoutes();
-       void getRouteAndLatency(sg_platf_route_cbarg_t route, double *lat);
-       void parseASroute(sg_platf_route_cbarg_t route);
-       void parseRoute(sg_platf_route_cbarg_t route);
-       void end();
-
-  xbt_graph_t p_routeGraph;      /* xbt_graph */
-  xbt_dict_t p_graphNodeMap;    /* map */
-  xbt_dict_t p_routeCache;       /* use in cache mode */
-  int m_cached;
+  xbt_node_t routeGraphNewNode(int id, int graph_id);
+  graph_node_map_element_t nodeMapSearch(int id);
+  void newRoute(int src_id, int dst_id, sg_platf_route_cbarg_t e_route);
+    /**
+     * For each vertex (node) already in the graph,
+     * make sure it also has a loopback link; this loopback
+     * can potentially already be in the graph, and in that
+     * case nothing will be done.
+     *
+     * If no loopback is specified for a node, we will use
+     * the loopback that is provided by the routing platform.
+     *
+     * After this function returns, any node in the graph
+     * will have a loopback attached to it.
+     */
+  void getRouteAndLatency(NetCard *src, NetCard *dst, sg_platf_route_cbarg_t route, double *lat) override;
+  void getRouteAndLatency(sg_platf_route_cbarg_t route, double *lat); // FIXME: this function is dangerously not overriding because of diverging prototype
+  xbt_dynar_t getOneLinkRoutes() override;
+  void addRoute(sg_platf_route_cbarg_t route) override;
+
+  xbt_graph_t routeGraph_ = nullptr;     /* xbt_graph */
+  xbt_dict_t graphNodeMap_ = nullptr;    /* map */
+  xbt_dict_t routeCache_ = nullptr;      /* use in cache mode */
 };
 
+}
+}
+
 #endif /* SURF_ROUTING_DIJKSTRA_HPP_ */