Mercurial Mercurial > ns-3.24 / changeset
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | raw | zip | gz | bz2 | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doxygen
authorMathieu Lacage <mathieu.lacage@sophia.inria.fr>
Mon, 24 Mar 2008 11:14:05 -0700
changeset 2701 11e0e961ac86
parent 2700 c54fbae72e8f
child 2702 6800982bef15
doxygen
src/helper/mobility-helper.h file | annotate | diff | comparison | revisions 
--- a/src/helper/mobility-helper.h	Mon Mar 24 10:42:18 2008 -0700
+++ b/src/helper/mobility-helper.h	Mon Mar 24 11:14:05 2008 -0700
@@ -14,17 +14,57 @@
 
 /**
  * \brief assign positions and mobility models to nodes.
+ *
+ * MobilityHelper::Layout is the most important method here.
  */
 class MobilityHelper
 {
 public:
   MobilityHelper ();
 
+  /**
+   * After this method is called, every call to MobilityHelper::Layout
+   * will also attach to the new ns3::MobilityModel an ns3::MobilityModelNotifier
+   * which can be used to listen to CourseChange events.
+   */
   void EnableNotifier (void);
+  /**
+   * After this method is called, no ns3::MobilityModelNotifier object will
+   * be associated to any new ns3::MobilityModel created by MobilityHelper::Layout.
+   * This will make it impossible to listen to "CourseChange" events from these
+   * new ns3::MobilityModel instances.
+   */
   void DisableNotifier (void);
 
+  /**
+   * \param allocator allocate initial node positions
+   *
+   * Set the position allocator which will be used to allocate
+   * the initial position of every node in MobilityModel::Layout.
+   */
   void SetPositionAllocator (Ptr<PositionAllocator> allocator);
 
+  /**
+   * \param type the type of mobility model to use.
+   * \param n1 the name of the attribute to set in the mobility model.
+   * \param v1 the value of the attribute to set in the mobility model.
+   * \param n2 the name of the attribute to set in the mobility model.
+   * \param v2 the value of the attribute to set in the mobility model.
+   * \param n3 the name of the attribute to set in the mobility model.
+   * \param v3 the value of the attribute to set in the mobility model.
+   * \param n4 the name of the attribute to set in the mobility model.
+   * \param v4 the value of the attribute to set in the mobility model.
+   * \param n5 the name of the attribute to set in the mobility model.
+   * \param v5 the value of the attribute to set in the mobility model.
+   * \param n6 the name of the attribute to set in the mobility model.
+   * \param v6 the value of the attribute to set in the mobility model.
+   * \param n7 the name of the attribute to set in the mobility model.
+   * \param v7 the value of the attribute to set in the mobility model.
+   * \param n8 the name of the attribute to set in the mobility model.
+   * \param v8 the value of the attribute to set in the mobility model.
+   * \param n9 the name of the attribute to set in the mobility model.
+   * \param v9 the value of the attribute to set in the mobility model.
+   */
   void SetPositionAllocator (std::string type,
 			     std::string n1 = "", Attribute v1 = Attribute (),
 			     std::string n2 = "", Attribute v2 = Attribute (),
@@ -36,6 +76,30 @@
 			     std::string n8 = "", Attribute v8 = Attribute (),
 			     std::string n9 = "", Attribute v9 = Attribute ());
 
+  /**
+   * \param type the type of mobility model to use.
+   * \param n1 the name of the attribute to set in the mobility model.
+   * \param v1 the value of the attribute to set in the mobility model.
+   * \param n2 the name of the attribute to set in the mobility model.
+   * \param v2 the value of the attribute to set in the mobility model.
+   * \param n3 the name of the attribute to set in the mobility model.
+   * \param v3 the value of the attribute to set in the mobility model.
+   * \param n4 the name of the attribute to set in the mobility model.
+   * \param v4 the value of the attribute to set in the mobility model.
+   * \param n5 the name of the attribute to set in the mobility model.
+   * \param v5 the value of the attribute to set in the mobility model.
+   * \param n6 the name of the attribute to set in the mobility model.
+   * \param v6 the value of the attribute to set in the mobility model.
+   * \param n7 the name of the attribute to set in the mobility model.
+   * \param v7 the value of the attribute to set in the mobility model.
+   * \param n8 the name of the attribute to set in the mobility model.
+   * \param v8 the value of the attribute to set in the mobility model.
+   * \param n9 the name of the attribute to set in the mobility model.
+   * \param v9 the value of the attribute to set in the mobility model.
+   *
+   * Calls to MobilityHelper::Layout will create an instance of a matching 
+   * mobility model for each node.
+   */
   void SetMobilityModel (std::string type,
 			 std::string n1 = "", Attribute v1 = Attribute (),
 			 std::string n2 = "", Attribute v2 = Attribute (),
@@ -47,12 +111,54 @@
 			 std::string n8 = "", Attribute v8 = Attribute (),
 			 std::string n9 = "", Attribute v9 = Attribute ());
 
+  /**
+   * \param reference item to push.
+   *
+   * Push an item on the top of the stack of "reference mobility models".
+   * The input item should be a node instance to which a mobility model
+   * has already been aggregated (usually by a call to Layout).
+   *
+   * If this this stack is not empty when MobilityHelper::Layout
+   * is called, the model from the top of the stack is used
+   * to create a ns3::HierarchicalMobilityModel to make the
+   * newly-created models define their positions relative to that
+   * of the parent mobility model.
+   *
+   * This method is typically used to create hierarchical mobility
+   * patterns and positions by starting with the large-scale mobility
+   * features, and, then, defining the smaller-scale movements relative
+   * to a few reference points in the large-scale model.
+   */
   void PushReferenceMobilityModel (Ptr<Object> reference);
+  /**
+   * Remove the top item from the top of the stack of
+   * "reference mobility models".
+   */
   void PopReferenceMobilityModel (void);
 
+  /**
+   * \returns a string which contains the TypeId of the currently-selected
+   *          mobility model.
+   */
   std::string GetMobilityModelType (void) const;
 
+  /**
+   * \param container the set of nodes to layout.
+   *
+   * For each input node, this method creates an instance of a ns3::MobilityModel
+   * subclass (the type of which was set with MobilityHelper::SetMobilityModel), 
+   * aggregates it to the mode, and sets an initial position based on the current 
+   * position allocator (set through MobilityHelper::SetPositionAllocator). 
+   * Optionally, this method will also create and aggregate a
+   * ns3::MobilityModelNotifier to generate 'CourseChange' events based on the 
+   * boolean flag set by MobilityHelper::EnableNotifier and MobilityHelper::DisableNotifier.
+   */
   void Layout (NodeContainer container);
+
+  /**
+   * Perform the work of MobilityHelper::Layout on _all_ nodes which
+   * exist in the simulation.
+   */
   void LayoutAll (void);
 private:
ns-3.24