Merge branch 'charm' of charmgit:charm into charm
[charm.git] / src / conv-com / graphrouter.h
index 2f483669406223ec2e69bf9c84b51b2c30315467..67af0a00b590e9d32ce9e811bcd48e7a8e4e6964 100644 (file)
@@ -4,13 +4,19 @@
  * $Date$
  * $Revision$
  *****************************************************************************/
+/**
+   @addtogroup ConvComlibRouter
+   @{
+   @file 
+   @brief Base class for graph based routers. Currently Unused????
+*/
+
 
 #ifndef _GRAPHROUTER_H
 #define _GRAPHROUTER_H
 
 #include <math.h>
-#include <converse.h>
-#include "comlib.h"
+//#include <converse.h>
 #include "petable.h"
 
 #include "persistent.h"
@@ -27,8 +33,10 @@ class TopologyDescriptor {
     virtual int getNumMessagesExpected(int stage) = 0;
 };
 
-//A generalized virtual topology based router. To make it a specific
-//router a new topology class needs to br created and passed to this.
+/// A generalized virtual topology based router. To make it a specific
+/// router a new topology class needs to br created and passed to this.
+
+/// At present this class is not used in the system!!!
 class GraphRouter : public Router
 {
     PeTable *PeGraph;
@@ -44,12 +52,12 @@ class GraphRouter : public Router
     void sendMessages(comID id, int stage);
     void init(int numPes, int myPe, TopologyDescriptor *tp);
     
-#if CMK_PERSISTENT_COMM
+#if CMK_PERSISTENT_COM
     PersistentHandle *handlerArrayOdd, *handlerArrayEven;
 #endif          
     
  public:
-    GraphRouter(int numPes, int myPe);
+    GraphRouter(int numPes, int myPe, Strategy*);
     //GraphRouter(int numPes, int myPe, int topid);
     ~GraphRouter();
   
@@ -66,3 +74,5 @@ class GraphRouter : public Router
 };
 
 #endif
+
+/*@}*/