A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
hierarchical-mobility-model.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 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 HIERARCHICAL_MOBILITY_MODEL_H
20
#define HIERARCHICAL_MOBILITY_MODEL_H
21
22
#include "
mobility-model.h
"
23
24
namespace
ns3
25
{
26
27
/**
28
* \ingroup mobility
29
* \brief Hierarchical mobility model.
30
*
31
* This model allows you to specify the position of a child object
32
* relative to a parent object.
33
*
34
* Basically this is a mobility model that combines two other mobility
35
* models: a "parent" model and a "child" model. The position of the
36
* hierarchical model is always the vector sum of the parent + child
37
* positions, so that if the parent model "moves", then this model
38
* will report an equal relative movement. Useful, for instance, if
39
* you want to simulate a node inside another node that moves, such as
40
* a vehicle.
41
*
42
* Setting the position on this model is always done using world
43
* absolute coordinates, and it changes only the child mobility model
44
* position, never the parent. The child mobility model always uses a
45
* coordinate system relative to the parent model position.
46
*
47
* \note: as a special case, the parent model may be NULL, which is
48
* semantically equivalent to having a ConstantPositionMobilityModel
49
* as parent positioned at origin (0,0,0). In other words, setting
50
* the parent model to NULL makes the child model and the hierarchical
51
* model start using world absolute coordinates.
52
*
53
* \warning: changing the parent/child mobility models in the middle
54
* of a simulation will probably not play very well with the
55
* ConfigStore APIs, so do this only if you know what you are doing.
56
*/
57
class
HierarchicalMobilityModel
:
public
MobilityModel
58
{
59
public
:
60
/**
61
* Register this type with the TypeId system.
62
* \return the object TypeId
63
*/
64
static
TypeId
GetTypeId
();
65
66
HierarchicalMobilityModel
();
67
68
/**
69
* \return the child mobility model.
70
*
71
* Calling GetPosition() on the model returned by this method allows
72
* one to access the position of the child relative to its parent.
73
*/
74
Ptr<MobilityModel>
GetChild
()
const
;
75
/**
76
* \return the parent mobility model.
77
*
78
* Calling GetPosition() on the model returned by this method allows
79
* one to access the position of the parent alone, which is used
80
* as the reference position to which the child position is added.
81
*/
82
Ptr<MobilityModel>
GetParent
()
const
;
83
/**
84
* Sets the child mobility model to a new one, possibly replacing
85
* an existing one. If the child model is being replaced,
86
* then the new child mobility model's current position is also set to
87
* the previous position to ensure that the composite
88
* position is preserved by this operation.
89
* \param model new mobility model child
90
*/
91
void
SetChild
(
Ptr<MobilityModel>
model);
92
/**
93
* Sets the parent mobility model to a new one, possibly replacing
94
* an existing one. If the parent model is being replaced,
95
* then the new position is set to the position that was set before
96
* replacement, to ensure that the composite position is preserved
97
* across changes to the parent model.
98
* \param model new mobility model parent
99
*/
100
void
SetParent
(
Ptr<MobilityModel>
model);
101
102
private
:
103
Vector
DoGetPosition
()
const override
;
104
void
DoSetPosition
(
const
Vector& position)
override
;
105
Vector
DoGetVelocity
()
const override
;
106
void
DoInitialize
()
override
;
107
int64_t
DoAssignStreams
(int64_t)
override
;
108
109
/**
110
* Callback for when parent mobility model course change occurs
111
* \param model mobility mode (unused)
112
*/
113
void
ParentChanged
(
Ptr<const MobilityModel>
model);
114
/**
115
* Callback for when child mobility model course change occurs
116
* \param model mobility mode (unused)
117
*/
118
void
ChildChanged
(
Ptr<const MobilityModel>
model);
119
120
Ptr<MobilityModel>
m_child
;
//!< pointer to child mobility model
121
Ptr<MobilityModel>
m_parent
;
//!< pointer to parent mobility model
122
};
123
124
}
// namespace ns3
125
126
#endif
/* HIERARCHICAL_MOBILITY_MODEL_H */
ns3::HierarchicalMobilityModel
Hierarchical mobility model.
Definition:
hierarchical-mobility-model.h:58
ns3::HierarchicalMobilityModel::m_child
Ptr< MobilityModel > m_child
pointer to child mobility model
Definition:
hierarchical-mobility-model.h:120
ns3::HierarchicalMobilityModel::GetChild
Ptr< MobilityModel > GetChild() const
Definition:
hierarchical-mobility-model.cc:122
ns3::HierarchicalMobilityModel::DoGetVelocity
Vector DoGetVelocity() const override
Definition:
hierarchical-mobility-model.cc:172
ns3::HierarchicalMobilityModel::ChildChanged
void ChildChanged(Ptr< const MobilityModel > model)
Callback for when child mobility model course change occurs.
Definition:
hierarchical-mobility-model.cc:196
ns3::HierarchicalMobilityModel::m_parent
Ptr< MobilityModel > m_parent
pointer to parent mobility model
Definition:
hierarchical-mobility-model.h:121
ns3::HierarchicalMobilityModel::DoSetPosition
void DoSetPosition(const Vector &position) override
Definition:
hierarchical-mobility-model.cc:148
ns3::HierarchicalMobilityModel::SetParent
void SetParent(Ptr< MobilityModel > model)
Sets the parent mobility model to a new one, possibly replacing an existing one.
Definition:
hierarchical-mobility-model.cc:91
ns3::HierarchicalMobilityModel::HierarchicalMobilityModel
HierarchicalMobilityModel()
Definition:
hierarchical-mobility-model.cc:55
ns3::HierarchicalMobilityModel::DoGetPosition
Vector DoGetPosition() const override
Definition:
hierarchical-mobility-model.cc:134
ns3::HierarchicalMobilityModel::GetTypeId
static TypeId GetTypeId()
Register this type with the TypeId system.
Definition:
hierarchical-mobility-model.cc:33
ns3::HierarchicalMobilityModel::GetParent
Ptr< MobilityModel > GetParent() const
Definition:
hierarchical-mobility-model.cc:128
ns3::HierarchicalMobilityModel::DoInitialize
void DoInitialize() override
Initialize() implementation.
Definition:
hierarchical-mobility-model.cc:202
ns3::HierarchicalMobilityModel::SetChild
void SetChild(Ptr< MobilityModel > model)
Sets the child mobility model to a new one, possibly replacing an existing one.
Definition:
hierarchical-mobility-model.cc:63
ns3::HierarchicalMobilityModel::ParentChanged
void ParentChanged(Ptr< const MobilityModel > model)
Callback for when parent mobility model course change occurs.
Definition:
hierarchical-mobility-model.cc:190
ns3::HierarchicalMobilityModel::DoAssignStreams
int64_t DoAssignStreams(int64_t) override
The default implementation does nothing but return the passed-in parameter.
Definition:
hierarchical-mobility-model.cc:213
ns3::MobilityModel
Keep track of the current position and velocity of an object.
Definition:
mobility-model.h:40
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:77
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
mobility-model.h
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
mobility
model
hierarchical-mobility-model.h
Generated on Tue May 28 2024 23:38:17 for ns-3 by
1.9.6