/usr/include/ns3.17/ns3/hierarchical-mobility-model.h is in libns3-dev 3.17+dfsg-1build1.
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 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2007 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 HIERARCHICAL_MOBILITY_MODEL_H
#define HIERARCHICAL_MOBILITY_MODEL_H
#include "mobility-model.h"
namespace ns3 {
/**
* \ingroup mobility
* \brief Hierarchical mobility model.
*
* This model allows you to specify the position of a child object
* relative to a parent object.
*
* Basically this is a mobility model that combines two other mobility
* models: a "parent" model and a "child" model. The position of the
* hierarchical model is always the vector sum of the parent + child
* positions, so that if the parent model "moves", then this model
* will report an equal relative movement. Useful, for instance, if
* you want to simulate a node inside another node that moves, such as
* a vehicle.
*
* Setting the position on this model is always done using world
* absolute coordinates, and it changes only the child mobility model
* position, never the parent. The child mobility model always uses a
* coordinate system relative to the parent model position.
*
* \note: as a special case, the parent model may be NULL, which is
* semantically equivalent to having a ConstantPositionMobilityModel
* as parent positioned at origin (0,0,0). In other words, setting
* the parent model to NULL makes the child model and the hierarchical
* model start using world absolute coordinates.
*
* \warning: changing the parent/child mobility models in the middle
* of a simulation will probably not play very well with the
* ConfigStore APIs, so do this only if you know what you are doing.
*/
class HierarchicalMobilityModel : public MobilityModel
{
public:
static TypeId GetTypeId (void);
HierarchicalMobilityModel ();
/**
* \return the child mobility model.
*
* This allows you to get access to the position of the child
* relative to its parent.
*/
Ptr<MobilityModel> GetChild (void) const;
/**
* \return the parent mobility model.
*
* This allows you to get access to the position of the
* parent mobility model which is used as the reference
* position by the child mobility model.
*/
Ptr<MobilityModel> GetParent (void) const;
/**
* Sets the child mobility model to a new one. If before there
* already existed a child model, then the child mobility model
* current position is also modified to ensure that the composite
* position is preserved.
* \param model new mobility model child
*/
void SetChild (Ptr<MobilityModel> model);
/**
* Sets the parent mobility model to a new one. If before there
* already existed a child model, then the child mobility model
* current position is also modified to ensure that the composite
* position is preserved.
* \param model new mobility model parent
*/
void SetParent (Ptr<MobilityModel> model);
private:
virtual Vector DoGetPosition (void) const;
virtual void DoSetPosition (const Vector &position);
virtual Vector DoGetVelocity (void) const;
void ParentChanged (Ptr<const MobilityModel> model);
void ChildChanged (Ptr<const MobilityModel> model);
Ptr<MobilityModel> m_child;
Ptr<MobilityModel> m_parent;
};
} // namespace ns3
#endif /* HIERARCHICAL_MOBILITY_MODEL_H */
|