src/node/ns2-mobility-file-topology.h
changeset 1632 b1a532cc4e9f
parent 1586 a77fe06e9b6d
--- a/src/node/ns2-mobility-file-topology.h	Thu Jul 19 11:30:47 2007 +0200
+++ b/src/node/ns2-mobility-file-topology.h	Thu Jul 19 11:31:07 2007 +0200
@@ -18,8 +18,8 @@
  *
  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
  */
-#ifndef NS2_MOBILE_FILE_TOPOLOGY_H
-#define NS2_MOBILE_FILE_TOPOLOGY_H
+#ifndef NS2_MOBILITY_FILE_TOPOLOGY_H
+#define NS2_MOBILITY_FILE_TOPOLOGY_H
 
 #include <string>
 #include <stdint.h>
@@ -29,12 +29,38 @@
 
 namespace ns3 {
 
-class Ns2MobileFileTopology
+/**
+ * \brief a topology object which can read ns2's movement files
+ *        generated by the CMU setdest tool.
+ */
+class Ns2MobilityFileTopology
 {
 public:
-  Ns2MobileFileTopology (std::string filename);
+  /**
+   * \param filename filename of file which contains the
+   *        ns2 movement trace.
+   */
+  Ns2MobilityFileTopology (std::string filename);
 
+  /**
+   * Read the ns2 trace file and configure the movement
+   * patterns of all nodes contained in the global ns3::NodeList
+   * whose nodeId is matches the nodeId of the nodes in the trace
+   * file.
+   */
   void Layout (void) const;
+
+  /**
+   * \param begin an iterator which points to the start of the input
+   *        object array.
+   * \param end an iterator which points to the end of the input
+   *        object array.
+   *
+   * Read the ns2 trace file and configure the movement
+   * patterns of all input objects. Each input object
+   * is identified by a unique node id which reflects
+   * the index of the object in the input array.
+   */
   template <typename T>
   void Layout (T begin, T end) const;
 private:
@@ -56,7 +82,7 @@
 
 template <typename T>
 void 
-Ns2MobileFileTopology::Layout (T begin, T end) const
+Ns2MobilityFileTopology::Layout (T begin, T end) const
 {
   class MyObjectStore : public ObjectStore
   {
@@ -84,4 +110,4 @@
 
 } // namespace ns3
 
-#endif /* NS2_MOBILE_FILE_TOPOLOGY_H */
+#endif /* NS2_MOBILITY_FILE_TOPOLOGY_H */