A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
constant-velocity-helper.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2006,2007 INRIA
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
18 */
19#ifndef CONSTANT_VELOCITY_HELPER_H
20#define CONSTANT_VELOCITY_HELPER_H
21
22#include "ns3/box.h"
23#include "ns3/nstime.h"
24#include "ns3/vector.h"
25
26namespace ns3
27{
28
29class Rectangle;
30
37{
38 public:
44 ConstantVelocityHelper(const Vector& position);
50 ConstantVelocityHelper(const Vector& position, const Vector& vel);
51
56 void SetPosition(const Vector& position);
61 Vector GetCurrentPosition() const;
66 Vector GetVelocity() const;
71 void SetVelocity(const Vector& vel);
75 void Pause();
79 void Unpause();
80
86 void UpdateWithBounds(const Rectangle& rectangle) const;
91 void UpdateWithBounds(const Box& bounds) const;
95 void Update() const;
96
97 private:
99 mutable Vector m_position;
100 Vector m_velocity;
101 bool m_paused;
102};
103
104} // namespace ns3
105
106#endif /* CONSTANT_VELOCITY_HELPER_H */
a 3d box
Definition: box.h:35
Utility class used to move node with constant velocity.
Time m_lastUpdate
time of last update
Vector GetCurrentPosition() const
Get current position vector.
Vector m_position
state variable for current position
Vector GetVelocity() const
Get velocity; if paused, will return a zero vector.
void Update() const
Update position, if not paused, from last position and time of last update.
void UpdateWithBounds(const Rectangle &rectangle) const
Update position, if not paused, from last position and time of last update.
void Unpause()
Resume mobility from current position at current velocity.
void SetPosition(const Vector &position)
Set position vector.
void SetVelocity(const Vector &vel)
Set new velocity vector.
void Pause()
Pause mobility at current position.
Vector m_velocity
state variable for velocity
bool m_paused
state variable for paused
a 2d rectangle
Definition: rectangle.h:35
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
Every class exported by the ns3 library is enclosed in the ns3 namespace.