A Discrete-Event Network Simulator
API
random-walk-2d-mobility-model.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2006,2007 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  */
21 #include "ns3/enum.h"
22 #include "ns3/double.h"
23 #include "ns3/string.h"
24 #include "ns3/pointer.h"
25 #include "ns3/simulator.h"
26 #include "ns3/log.h"
27 #include <cmath>
28 
29 namespace ns3 {
30 
31 NS_LOG_COMPONENT_DEFINE ("RandomWalk2d");
32 
33 NS_OBJECT_ENSURE_REGISTERED (RandomWalk2dMobilityModel);
34 
35 TypeId
37 {
38  static TypeId tid = TypeId ("ns3::RandomWalk2dMobilityModel")
40  .SetGroupName ("Mobility")
41  .AddConstructor<RandomWalk2dMobilityModel> ()
42  .AddAttribute ("Bounds",
43  "Bounds of the area to cruise.",
44  RectangleValue (Rectangle (0.0, 100.0, 0.0, 100.0)),
47  .AddAttribute ("Time",
48  "Change current direction and speed after moving for this delay.",
49  TimeValue (Seconds (1.0)),
51  MakeTimeChecker ())
52  .AddAttribute ("Distance",
53  "Change current direction and speed after moving for this distance.",
54  DoubleValue (1.0),
56  MakeDoubleChecker<double> ())
57  .AddAttribute ("Mode",
58  "The mode indicates the condition used to "
59  "change the current speed and direction",
64  .AddAttribute ("Direction",
65  "A random variable used to pick the direction (radians).",
66  StringValue ("ns3::UniformRandomVariable[Min=0.0|Max=6.283184]"),
68  MakePointerChecker<RandomVariableStream> ())
69  .AddAttribute ("Speed",
70  "A random variable used to pick the speed (m/s).",
71  StringValue ("ns3::UniformRandomVariable[Min=2.0|Max=4.0]"),
73  MakePointerChecker<RandomVariableStream> ());
74  return tid;
75 }
76 
77 void
79 {
82 }
83 
84 void
86 {
87  m_helper.Update ();
88  double speed = m_speed->GetValue ();
89  double direction = m_direction->GetValue ();
90  Vector vector (std::cos (direction) * speed,
91  std::sin (direction) * speed,
92  0.0);
93  m_helper.SetVelocity (vector);
94  m_helper.Unpause ();
95 
96  Time delayLeft;
98  {
99  delayLeft = m_modeTime;
100  }
101  else
102  {
103  delayLeft = Seconds (m_modeDistance / speed);
104  }
105  DoWalk (delayLeft);
106 }
107 
108 void
110 {
111  Vector position = m_helper.GetCurrentPosition ();
112  Vector speed = m_helper.GetVelocity ();
113  Vector nextPosition = position;
114  nextPosition.x += speed.x * delayLeft.GetSeconds ();
115  nextPosition.y += speed.y * delayLeft.GetSeconds ();
116  m_event.Cancel ();
117  if (m_bounds.IsInside (nextPosition))
118  {
120  }
121  else
122  {
123  nextPosition = m_bounds.CalculateIntersection (position, speed);
124  Time delay = Seconds ((nextPosition.x - position.x) / speed.x);
126  delayLeft - delay);
127  }
129 }
130 
131 void
133 {
135  Vector position = m_helper.GetCurrentPosition ();
136  Vector speed = m_helper.GetVelocity ();
137  switch (m_bounds.GetClosestSide (position))
138  {
139  case Rectangle::RIGHT:
140  case Rectangle::LEFT:
141  speed.x = -speed.x;
142  break;
143  case Rectangle::TOP:
144  case Rectangle::BOTTOM:
145  speed.y = -speed.y;
146  break;
147  }
148  m_helper.SetVelocity (speed);
149  m_helper.Unpause ();
150  DoWalk (delayLeft);
151 }
152 
153 void
155 {
156  // chain up
158 }
159 Vector
161 {
163  return m_helper.GetCurrentPosition ();
164 }
165 void
167 {
168  NS_ASSERT (m_bounds.IsInside (position));
169  m_helper.SetPosition (position);
172 }
173 Vector
175 {
176  return m_helper.GetVelocity ();
177 }
178 int64_t
180 {
181  m_speed->SetStream (stream);
182  m_direction->SetStream (stream + 1);
183  return 2;
184 }
185 
186 
187 } // namespace ns3
virtual void DoInitialize(void)
Initialize() implementation.
Definition: object.cc:353
double m_modeDistance
Change direction and speed after this distance.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
void SetStream(int64_t stream)
Specifies the stream number for the RngStream.
bool IsInside(const Vector &position) const
Definition: rectangle.cc:48
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
Hold variables of type string.
Definition: string.h:41
Vector GetCurrentPosition(void) const
Get current position vector.
Ptr< const AttributeAccessor > MakeEnumAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: enum.h:225
double GetSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
Definition: nstime.h:361
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:67
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
virtual void DoDispose(void)
Destructor implementation.
Definition: object.cc:346
virtual double GetValue(void)=0
Get the next random value as a double drawn from the distribution.
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:449
AttributeValue implementation for Rectangle.
Definition: rectangle.h:97
Keep track of the current position and velocity of an object.
2D random walk mobility model.
ConstantVelocityHelper m_helper
helper for this object
Ptr< const AttributeAccessor > MakePointerAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: pointer.h:227
Hold variables of type enum.
Definition: enum.h:54
virtual void DoSetPosition(const Vector &position)
static EventId Schedule(Time const &delay, MEM mem_ptr, OBJ obj)
Schedule an event to expire after delay.
Definition: simulator.h:1390
void Update(void) const
Update position, if not paused, from last position and time of last update.
Vector CalculateIntersection(const Vector &current, const Vector &speed) const
Definition: rectangle.cc:177
AttributeValue implementation for Time.
Definition: nstime.h:1132
void Rebound(Time timeLeft)
Performs the rebound of the node if it reaches a boundary.
Time m_modeTime
Change current direction and speed after this delay.
static TypeId GetTypeId(void)
Register this type with the TypeId system.
static void Remove(const EventId &id)
Remove an event from the event list.
Definition: simulator.cc:280
virtual void DoDispose(void)
Destructor implementation.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< RandomVariableStream > m_speed
rv for picking speed
void UpdateWithBounds(const Rectangle &rectangle) const
Update position, if not paused, from last position and time of last update.
Side GetClosestSide(const Vector &position) const
Definition: rectangle.cc:56
void SetVelocity(const Vector &vel)
Set new velocity vector.
enum Mode m_mode
whether in time or distance mode
static EventId ScheduleNow(MEM mem_ptr, OBJ obj)
Schedule an event to expire Now.
Definition: simulator.h:1579
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: nstime.h:1133
void DoWalk(Time timeLeft)
Walk according to position and velocity, until distance is reached, time is reached, or intersection with the bounding box.
void NotifyCourseChange(void) const
Must be invoked by subclasses when the course of the position changes to notify course change listene...
Ptr< const AttributeAccessor > MakeDoubleAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: double.h:42
virtual void DoInitialize(void)
Initialize() implementation.
Ptr< const AttributeChecker > MakeEnumChecker(int v1, std::string n1, int v2, std::string n2, int v3, std::string n3, int v4, std::string n4, int v5, std::string n5, int v6, std::string n6, int v7, std::string n7, int v8, std::string n8, int v9, std::string n9, int v10, std::string n10, int v11, std::string n11, int v12, std::string n12, int v13, std::string n13, int v14, std::string n14, int v15, std::string n15, int v16, std::string n16, int v17, std::string n17, int v18, std::string n18, int v19, std::string n19, int v20, std::string n20, int v21, std::string n21, int v22, std::string n22)
Make an EnumChecker pre-configured with a set of allowed values by name.
Definition: enum.cc:180
Ptr< RandomVariableStream > m_direction
rv for picking direction
void DoInitializePrivate(void)
Perform initialization of the object before MobilityModel::DoInitialize ()
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1070
Vector GetVelocity(void) const
Get velocity; if paused, will return a zero vector.
void Cancel(void)
This method is syntactic sugar for the ns3::Simulator::Cancel method.
Definition: event-id.cc:53
void Unpause(void)
Resume mobility from current position at current velocity.
Ptr< const AttributeChecker > MakeRectangleChecker(void)
Definition: rectangle.cc:213
Rectangle m_bounds
Bounds of the area to cruise.
void SetPosition(const Vector &position)
Set position vector.
This class can be used to hold variables of floating point type such as &#39;double&#39; or &#39;float&#39;...
Definition: double.h:41
Ptr< const AttributeAccessor > MakeRectangleAccessor(T1 a1)
Create an AttributeAccessor for a class data member, or a lone class get functor or set method...
Definition: rectangle.h:97
a unique identifier for an interface.
Definition: type-id.h:58
a 2d rectangle
Definition: rectangle.h:34
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:923
virtual int64_t DoAssignStreams(int64_t)
The default implementation does nothing but return the passed-in parameter.