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
29namespace ns3 {
30
31NS_LOG_COMPONENT_DEFINE ("RandomWalk2d");
32
33NS_OBJECT_ENSURE_REGISTERED (RandomWalk2dMobilityModel);
34
35TypeId
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)),
45 MakeRectangleAccessor (&RandomWalk2dMobilityModel::m_bounds),
46 MakeRectangleChecker ())
47 .AddAttribute ("Time",
48 "Change current direction and speed after moving for this delay.",
49 TimeValue (Seconds (1.0)),
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
77void
79{
82}
83
84void
86{
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);
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
108void
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
131void
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:
145 speed.y = -speed.y;
146 break;
147 }
148 m_helper.SetVelocity (speed);
149 m_helper.Unpause ();
150 DoWalk (delayLeft);
151}
152
153void
155{
156 // chain up
158}
159Vector
161{
164}
165void
167{
168 NS_ASSERT (m_bounds.IsInside (position));
169 m_helper.SetPosition (position);
170 m_event.Cancel ();
172}
173Vector
175{
176 return m_helper.GetVelocity ();
177}
178int64_t
180{
181 m_speed->SetStream (stream);
182 m_direction->SetStream (stream + 1);
183 return 2;
184}
185
186
187} // namespace ns3
void Unpause(void)
Resume mobility from current position at current velocity.
Vector GetVelocity(void) const
Get velocity; if paused, will return a zero vector.
void UpdateWithBounds(const Rectangle &rectangle) const
Update position, if not paused, from last position and time of last update.
void SetPosition(const Vector &position)
Set position vector.
void SetVelocity(const Vector &vel)
Set new velocity vector.
void Update(void) const
Update position, if not paused, from last position and time of last update.
Vector GetCurrentPosition(void) const
Get current position vector.
This class can be used to hold variables of floating point type such as 'double' or 'float'.
Definition: double.h:41
Hold variables of type enum.
Definition: enum.h:55
void Cancel(void)
This method is syntactic sugar for the ns3::Simulator::Cancel method.
Definition: event-id.cc:53
Keep track of the current position and velocity of an object.
void NotifyCourseChange(void) const
Must be invoked by subclasses when the course of the position changes to notify course change listene...
virtual void DoDispose(void)
Destructor implementation.
Definition: object.cc:346
virtual void DoInitialize(void)
Initialize() implementation.
Definition: object.cc:353
virtual double GetValue(void)=0
Get the next random value as a double drawn from the distribution.
void SetStream(int64_t stream)
Specifies the stream number for the RngStream.
static TypeId GetTypeId(void)
Register this type with the TypeId system.
void DoInitializePrivate(void)
Perform initialization of the object before MobilityModel::DoInitialize ()
Ptr< RandomVariableStream > m_speed
rv for picking speed
virtual void DoSetPosition(const Vector &position)
virtual void DoInitialize(void)
Initialize() implementation.
virtual int64_t DoAssignStreams(int64_t)
The default implementation does nothing but return the passed-in parameter.
double m_modeDistance
Change direction and speed after this distance.
void DoWalk(Time timeLeft)
Walk according to position and velocity, until distance is reached, time is reached,...
enum Mode m_mode
whether in time or distance mode
void Rebound(Time timeLeft)
Performs the rebound of the node if it reaches a boundary.
ConstantVelocityHelper m_helper
helper for this object
virtual void DoDispose(void)
Destructor implementation.
Time m_modeTime
Change current direction and speed after this delay.
Rectangle m_bounds
Bounds of the area to cruise.
Ptr< RandomVariableStream > m_direction
rv for picking direction
a 2d rectangle
Definition: rectangle.h:35
Side GetClosestSide(const Vector &position) const
Definition: rectangle.cc:56
bool IsInside(const Vector &position) const
Definition: rectangle.cc:48
Vector CalculateIntersection(const Vector &current, const Vector &speed) const
Definition: rectangle.cc:177
AttributeValue implementation for Rectangle.
static EventId Schedule(Time const &delay, FUNC f, Ts &&... args)
Schedule an event to expire after delay.
Definition: simulator.h:555
static EventId ScheduleNow(FUNC f, Ts &&... args)
Schedule an event to expire Now.
Definition: simulator.h:586
Hold variables of type string.
Definition: string.h:41
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
double GetSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
Definition: nstime.h:380
AttributeValue implementation for Time.
Definition: nstime.h:1309
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:922
#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
Ptr< const AttributeAccessor > MakeDoubleAccessor(T1 a1)
Definition: double.h:42
Ptr< const AttributeAccessor > MakeEnumAccessor(T1 a1)
Definition: enum.h:205
Ptr< const AttributeAccessor > MakePointerAccessor(T1 a1)
Definition: pointer.h:227
Ptr< const AttributeAccessor > MakeTimeAccessor(T1 a1)
Definition: nstime.h:1310
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:206
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
Time Seconds(double value)
Construct a Time in the indicated unit.
Definition: nstime.h:1245
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Ptr< const AttributeChecker > MakeTimeChecker(const Time min, const Time max)
Helper to make a Time checker with bounded range.
Definition: time.cc:522
Ptr< const AttributeChecker > MakeEnumChecker(int v, std::string n, Ts... args)
Make an EnumChecker pre-configured with a set of allowed values by name.
Definition: enum.h:162