A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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  */
20 
21 #include <cmath>
22 
23 #include "mobility-model.h"
24 #include "ns3/trace-source-accessor.h"
25 
26 namespace ns3 {
27 
28 NS_OBJECT_ENSURE_REGISTERED (MobilityModel)
29  ;
30 
31 TypeId
33 {
34  static TypeId tid = TypeId ("ns3::MobilityModel")
35  .SetParent<Object> ()
36  .AddAttribute ("Position", "The current position of the mobility model.",
38  VectorValue (Vector (0.0, 0.0, 0.0)),
39  MakeVectorAccessor (&MobilityModel::SetPosition,
42  .AddAttribute ("Velocity", "The current velocity of the mobility model.",
44  VectorValue (Vector (0.0, 0.0, 0.0)), // ignored initial value.
45  MakeVectorAccessor (&MobilityModel::GetVelocity),
47  .AddTraceSource ("CourseChange",
48  "The value of the position and/or velocity vector changed",
50  ;
51  return tid;
52 }
53 
55 {
56 }
57 
59 {
60 }
61 
62 Vector
64 {
65  return DoGetPosition ();
66 }
67 Vector
69 {
70  return DoGetVelocity ();
71 }
72 
73 void
75 {
76  DoSetPosition (position);
77 }
78 
79 double
81 {
82  Vector oPosition = other->DoGetPosition ();
83  Vector position = DoGetPosition ();
84  return CalculateDistance (position, oPosition);
85 }
86 
87 double
89 {
90  double x = GetVelocity().x - other->GetVelocity().x;
91  double y = GetVelocity().y - other->GetVelocity().y;
92  double z = GetVelocity().z - other->GetVelocity().z;
93  return sqrt( (x*x) + (y*y) + (z*z) );
94 }
95 
96 void
98 {
99  m_courseChangeTrace (this);
100 }
101 
102 int64_t
104 {
105  return DoAssignStreams (start);
106 }
107 
108 // Default implementation does nothing
109 int64_t
111 {
112  return 0;
113 }
114 
115 
116 } // namespace ns3
Ptr< const AttributeChecker > MakeVectorChecker(void)
Definition: vector.cc:33
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
double x
x coordinate of vector
Definition: vector.h:49
TracedCallback< Ptr< const MobilityModel > > m_courseChangeTrace
Used to alert subscribers that a change in direction, velocity, or position has occurred.
smart pointer class similar to boost::intrusive_ptr
Definition: ptr.h:59
double GetDistanceFrom(Ptr< const MobilityModel > position) const
virtual Vector DoGetPosition(void) const =0
NS_OBJECT_ENSURE_REGISTERED(NullMessageSimulatorImpl)
Vector GetPosition(void) const
virtual ~MobilityModel()=0
a 3d vector
Definition: vector.h:31
Vector GetVelocity(void) const
The attribute can be read.
Definition: type-id.h:56
double CalculateDistance(const Vector3D &a, const Vector3D &b)
Definition: vector.cc:71
void NotifyCourseChange(void) const
Must be invoked by subclasses when the course of the position changes to notify course change listene...
static TypeId GetTypeId(void)
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
The attribute can be written.
Definition: type-id.h:57
double y
y coordinate of vector
Definition: vector.h:53
void SetPosition(const Vector &position)
virtual void DoSetPosition(const Vector &position)=0
hold objects of type ns3::Vector3D
a base class which provides memory management and object aggregation
Definition: object.h:63
virtual Vector DoGetVelocity(void) const =0
virtual int64_t DoAssignStreams(int64_t start)
The default implementation does nothing but return the passed-in parameter.
a unique identifier for an interface.
Definition: type-id.h:49
double GetRelativeSpeed(Ptr< const MobilityModel > other) const
TypeId SetParent(TypeId tid)
Definition: type-id.cc:611
double z
z coordinate of vector
Definition: vector.h:57