/usr/include/ns3/mobility-helper.h is in libns3-dev 3.13+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2008 INRIA
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
*/
#ifndef MOBILITY_HELPER_H
#define MOBILITY_HELPER_H
#include <vector>
#include "ns3/object-factory.h"
#include "ns3/attribute.h"
#include "ns3/position-allocator.h"
#include "node-container.h"
namespace ns3 {
class PositionAllocator;
class MobilityModel;
/**
* \ingroup mobility
* \brief Helper class used to assign positions and mobility models to nodes.
*
* MobilityHelper::Install is the most important method here.
*/
class MobilityHelper
{
public:
/**
* Construct a Mobility Helper which is used to make life easier when working
* with mobility models.
*/
MobilityHelper ();
/**
* \internal
* Destroy a Mobility Helper
*/
~MobilityHelper ();
/**
* Set the position allocator which will be used to allocate the initial
* position of every node initialized during MobilityModel::Install.
*
* \param allocator allocate initial node positions
*/
void SetPositionAllocator (Ptr<PositionAllocator> allocator);
/**
* \param type the type of mobility model to use.
* \param n1 the name of the attribute to set in the mobility model.
* \param v1 the value of the attribute to set in the mobility model.
* \param n2 the name of the attribute to set in the mobility model.
* \param v2 the value of the attribute to set in the mobility model.
* \param n3 the name of the attribute to set in the mobility model.
* \param v3 the value of the attribute to set in the mobility model.
* \param n4 the name of the attribute to set in the mobility model.
* \param v4 the value of the attribute to set in the mobility model.
* \param n5 the name of the attribute to set in the mobility model.
* \param v5 the value of the attribute to set in the mobility model.
* \param n6 the name of the attribute to set in the mobility model.
* \param v6 the value of the attribute to set in the mobility model.
* \param n7 the name of the attribute to set in the mobility model.
* \param v7 the value of the attribute to set in the mobility model.
* \param n8 the name of the attribute to set in the mobility model.
* \param v8 the value of the attribute to set in the mobility model.
* \param n9 the name of the attribute to set in the mobility model.
* \param v9 the value of the attribute to set in the mobility model.
*/
void SetPositionAllocator (std::string type,
std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue (),
std::string n8 = "", const AttributeValue &v8 = EmptyAttributeValue (),
std::string n9 = "", const AttributeValue &v9 = EmptyAttributeValue ());
/**
* \param type the type of mobility model to use.
* \param n1 the name of the attribute to set in the mobility model.
* \param v1 the value of the attribute to set in the mobility model.
* \param n2 the name of the attribute to set in the mobility model.
* \param v2 the value of the attribute to set in the mobility model.
* \param n3 the name of the attribute to set in the mobility model.
* \param v3 the value of the attribute to set in the mobility model.
* \param n4 the name of the attribute to set in the mobility model.
* \param v4 the value of the attribute to set in the mobility model.
* \param n5 the name of the attribute to set in the mobility model.
* \param v5 the value of the attribute to set in the mobility model.
* \param n6 the name of the attribute to set in the mobility model.
* \param v6 the value of the attribute to set in the mobility model.
* \param n7 the name of the attribute to set in the mobility model.
* \param v7 the value of the attribute to set in the mobility model.
* \param n8 the name of the attribute to set in the mobility model.
* \param v8 the value of the attribute to set in the mobility model.
* \param n9 the name of the attribute to set in the mobility model.
* \param v9 the value of the attribute to set in the mobility model.
*
* Calls to MobilityHelper::Install will create an instance of a matching
* mobility model for each node.
*/
void SetMobilityModel (std::string type,
std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue (),
std::string n8 = "", const AttributeValue &v8 = EmptyAttributeValue (),
std::string n9 = "", const AttributeValue &v9 = EmptyAttributeValue ());
/**
* \param reference item to push.
*
* Push an item on the top of the stack of "reference mobility models".
* The input item should be a node instance to which a mobility model
* has already been aggregated (usually by a call to Install).
*
* If this stack is not empty when MobilityHelper::Install
* is called, the model from the top of the stack is used
* to create a ns3::HierarchicalMobilityModel to make the
* newly-created models define their positions relative to that
* of the parent mobility model.
*
* This method is typically used to create hierarchical mobility
* patterns and positions by starting with the large-scale mobility
* features, and, then, defining the smaller-scale movements relative
* to a few reference points in the large-scale model.
*/
void PushReferenceMobilityModel (Ptr<Object> reference);
/**
* \param referenceName named item to push.
*
* Push an item on the top of the stack of "reference mobility models".
* The input item should be a node instance to which a mobility model
* has already been aggregated (usually by a call to Install).
*
* If this stack is not empty when MobilityHelper::Install
* is called, the model from the top of the stack is used
* to create a ns3::HierarchicalMobilityModel to make the
* newly-created models define their positions relative to that
* of the parent mobility model.
*
* This method is typically used to create hierarchical mobility
* patterns and positions by starting with the large-scale mobility
* features, and, then, defining the smaller-scale movements relative
* to a few reference points in the large-scale model.
*/
void PushReferenceMobilityModel (std::string referenceName);
/**
* Remove the top item from the top of the stack of
* "reference mobility models".
*/
void PopReferenceMobilityModel (void);
/**
* \return a string which contains the TypeId of the currently-selected
* mobility model.
*/
std::string GetMobilityModelType (void) const;
/**
* \brief "Layout" a single node according to the current position allocator type.
*
* This method creates an instance of a ns3::MobilityModel subclass (the
* type of which was set with MobilityHelper::SetMobilityModel), aggregates
* it to the provided node, and sets an initial position based on the current
* position allocator (set through MobilityHelper::SetPositionAllocator).
*
* \param node The node to "layout."
*/
void Install (Ptr<Node> node) const;
/**
* \brief "Layout" a single node according to the current position allocator type.
*
* This method creates an instance of a ns3::MobilityModel subclass (the
* type of which was set with MobilityHelper::SetMobilityModel), aggregates
* it to the provided node, and sets an initial position based on the current
* position allocator (set through MobilityHelper::SetPositionAllocator).
*
* \param nodeName The name of the node to "layout."
*/
void Install (std::string nodeName) const;
/**
* \brief Layout a collection of nodes according to the current position allocator type.
*
* For each node in the provided NodeContainer, this method creates an instance
* of a ns3::MobilityModel subclass (the type of which was set with
* MobilityHelper::SetMobilityModel), aggregates it to the node, and sets an
* initial position based on the current position allocator (set through
* MobilityHelper::SetPositionAllocator).
*
* \param container The set of nodes to layout.
*/
void Install (NodeContainer container) const;
/**
* Perform the work of MobilityHelper::Install on _all_ nodes which
* exist in the simulation.
*/
void InstallAll (void);
/**
* \param os output stream
* \param nodeid the id of the node to generate ascii output for.
*
* Enable ascii output on the mobility model associated to the
* specified nodeid and dump that to the specified stdc++ output
* stream.
*/
static void EnableAscii (std::ostream &os, uint32_t nodeid);
/**
* \param os output stream
* \param n node container
*
* Enable ascii output on the mobility model associated each of
* the nodes in the input container and dump that to the
* specified stdc++ output stream.
*/
static void EnableAscii (std::ostream &os, NodeContainer n);
/**
* \param os output stream
*
* Enable ascii output on the mobility model associated
* every node in the system and dump that to the specified
* stdc++ output stream.
*/
static void EnableAsciiAll (std::ostream &os);
private:
/**
* \internal
*/
static void CourseChanged (std::ostream *os, Ptr<const MobilityModel> mobility);
std::vector<Ptr<MobilityModel> > m_mobilityStack;
ObjectFactory m_mobility;
Ptr<PositionAllocator> m_position;
};
} // namespace ns3
#endif /* MOBILITY_HELPER_H */
|