A Discrete-Event Network Simulator
API
mobility-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #ifndef MOBILITY_HELPER_H
22 #define MOBILITY_HELPER_H
23 
24 #include <vector>
25 #include "ns3/object-factory.h"
26 #include "ns3/attribute.h"
27 #include "ns3/output-stream-wrapper.h"
28 #include "ns3/position-allocator.h"
29 #include "node-container.h"
30 
31 namespace ns3 {
32 
33 class PositionAllocator;
34 class MobilityModel;
35 
43 {
44 public:
49  MobilityHelper ();
50 
54  ~MobilityHelper ();
55 
63 
85  void SetPositionAllocator (std::string type,
86  std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
87  std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
88  std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
89  std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
90  std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
91  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
92  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue (),
93  std::string n8 = "", const AttributeValue &v8 = EmptyAttributeValue (),
94  std::string n9 = "", const AttributeValue &v9 = EmptyAttributeValue ());
95 
120  void SetMobilityModel (std::string type,
121  std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
122  std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
123  std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
124  std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
125  std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
126  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
127  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue (),
128  std::string n8 = "", const AttributeValue &v8 = EmptyAttributeValue (),
129  std::string n9 = "", const AttributeValue &v9 = EmptyAttributeValue ());
130 
168  void PushReferenceMobilityModel (std::string referenceName);
173  void PopReferenceMobilityModel (void);
174 
179  std::string GetMobilityModelType (void) const;
180 
191  void Install (Ptr<Node> node) const;
202  void Install (std::string nodeName) const;
203 
215  void Install (NodeContainer container) const;
216 
221  void InstallAll (void);
222 
231  static void EnableAscii (Ptr<OutputStreamWrapper> stream, uint32_t nodeid);
240  static void EnableAscii (Ptr<OutputStreamWrapper> stream, NodeContainer n);
248  static void EnableAsciiAll (Ptr<OutputStreamWrapper> stream);
261  int64_t AssignStreams (NodeContainer c, int64_t stream);
262 
268  static double GetDistanceSquaredBetween (Ptr<Node> n1, Ptr<Node> n2);
269 
270 private:
271 
278  std::vector<Ptr<MobilityModel> > m_mobilityStack;
281 };
282 
283 } // namespace ns3
284 
285 #endif /* MOBILITY_HELPER_H */
void InstallAll(void)
Perform the work of MobilityHelper::Install on all nodes which exist in the simulation.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
static double GetDistanceSquaredBetween(Ptr< Node > n1, Ptr< Node > n2)
Hold a value for an Attribute.
Definition: attribute.h:68
~MobilityHelper()
Destroy a Mobility Helper.
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by the mobility models (inc...
void PushReferenceMobilityModel(Ptr< Object > reference)
mobility
Definition: third.py:101
Ptr< PositionAllocator > m_position
Position allocator for use in hierarchical mobility model.
A class for an empty attribute value.
Definition: attribute.h:232
static void CourseChanged(Ptr< OutputStreamWrapper > stream, Ptr< const MobilityModel > mobility)
Output course change events from mobility model to output stream.
static void EnableAscii(Ptr< OutputStreamWrapper > stream, uint32_t nodeid)
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ObjectFactory m_mobility
Object factory to create mobility objects.
keep track of a set of node pointers.
void SetMobilityModel(std::string type, std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue(), std::string n8="", const AttributeValue &v8=EmptyAttributeValue(), std::string n9="", const AttributeValue &v9=EmptyAttributeValue())
std::string GetMobilityModelType(void) const
void Install(Ptr< Node > node) const
"Layout" a single node according to the current position allocator type.
std::vector< Ptr< MobilityModel > > m_mobilityStack
Internal stack of mobility models.
Helper class used to assign positions and mobility models to nodes.
Instantiate subclasses of ns3::Object.
MobilityHelper()
Construct a Mobility Helper which is used to make life easier when working with mobility models...
static void EnableAsciiAll(Ptr< OutputStreamWrapper > stream)
void PopReferenceMobilityModel(void)
Remove the top item from the top of the stack of "reference mobility models".
void SetPositionAllocator(Ptr< PositionAllocator > allocator)
Set the position allocator which will be used to allocate the initial position of every node initiali...