Hierarchical mobility model. More...
#include "hierarchical-mobility-model.h"
Public Member Functions | |
HierarchicalMobilityModel () | |
Ptr< MobilityModel > | GetChild () const |
Ptr< MobilityModel > | GetParent () const |
void | SetChild (Ptr< MobilityModel > model) |
Sets the child mobility model to a new one, possibly replacing an existing one. | |
void | SetParent (Ptr< MobilityModel > model) |
Sets the parent mobility model to a new one, possibly replacing an existing one. | |
Public Member Functions inherited from ns3::MobilityModel | |
MobilityModel () | |
~MobilityModel () override=0 | |
int64_t | AssignStreams (int64_t stream) |
Assign a fixed random variable stream number to the random variables used by this model. | |
double | GetDistanceFrom (Ptr< const MobilityModel > position) const |
Vector | GetPosition () const |
Vector | GetPositionWithReference (const Vector &referencePosition) const |
This method may be used if the position returned may depend on some reference position provided. | |
double | GetRelativeSpeed (Ptr< const MobilityModel > other) const |
Vector | GetVelocity () const |
void | SetPosition (const Vector &position) |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Register this type with the TypeId system. | |
Static Public Member Functions inherited from ns3::MobilityModel | |
static TypeId | GetTypeId () |
Register this type with the TypeId system. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Member Functions | |
void | ChildChanged (Ptr< const MobilityModel > model) |
Callback for when child mobility model course change occurs. | |
int64_t | DoAssignStreams (int64_t) override |
The default implementation does nothing but return the passed-in parameter. | |
Vector | DoGetPosition () const override |
Vector | DoGetVelocity () const override |
void | DoInitialize () override |
Initialize() implementation. | |
void | DoSetPosition (const Vector &position) override |
void | ParentChanged (Ptr< const MobilityModel > model) |
Callback for when parent mobility model course change occurs. | |
Private Attributes | |
Ptr< MobilityModel > | m_child |
pointer to child mobility model | |
Ptr< MobilityModel > | m_parent |
pointer to parent mobility model | |
Additional Inherited Members | |
Public Types inherited from ns3::MobilityModel | |
typedef void(* | TracedCallback) (Ptr< const MobilityModel > model) |
TracedCallback signature. | |
Protected Member Functions inherited from ns3::MobilityModel | |
void | NotifyCourseChange () const |
Must be invoked by subclasses when the course of the position changes to notify course change listeners. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
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.
ns3::HierarchicalMobilityModel is accessible through the following paths with Config::Set and Config::Connect:
Vector3D
Vector3D
No TraceSources are defined for this type.
Group: Mobility
Size of this type is 96 bytes (on a 64-bit architecture).
Definition at line 46 of file hierarchical-mobility-model.h.
ns3::HierarchicalMobilityModel::HierarchicalMobilityModel | ( | ) |
Definition at line 44 of file hierarchical-mobility-model.cc.
References NS_LOG_FUNCTION.
|
private |
Callback for when child mobility model course change occurs.
model | mobility mode (unused) |
Definition at line 185 of file hierarchical-mobility-model.cc.
References ns3::MobilityModel::NotifyCourseChange().
Referenced by SetChild().
|
overrideprivatevirtual |
The default implementation does nothing but return the passed-in parameter.
Subclasses using random variables are expected to override this.
start | starting stream index |
Reimplemented from ns3::MobilityModel.
Definition at line 202 of file hierarchical-mobility-model.cc.
References m_child, m_parent, and NS_LOG_FUNCTION.
|
overrideprivatevirtual |
Concrete subclasses of this base class must implement this method.
Implements ns3::MobilityModel.
Definition at line 123 of file hierarchical-mobility-model.cc.
|
overrideprivatevirtual |
Concrete subclasses of this base class must implement this method.
Implements ns3::MobilityModel.
Definition at line 161 of file hierarchical-mobility-model.cc.
|
overrideprivatevirtual |
Initialize() implementation.
This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.
Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.
Reimplemented from ns3::Object.
Definition at line 191 of file hierarchical-mobility-model.cc.
References m_child, m_parent, and NS_LOG_FUNCTION.
|
overrideprivatevirtual |
position | the position to set. |
Concrete subclasses of this base class must implement this method.
Implements ns3::MobilityModel.
Definition at line 137 of file hierarchical-mobility-model.cc.
References m_child, m_parent, and NS_LOG_FUNCTION.
Ptr< MobilityModel > ns3::HierarchicalMobilityModel::GetChild | ( | ) | const |
Calling GetPosition() on the model returned by this method allows one to access the position of the child relative to its parent.
Definition at line 111 of file hierarchical-mobility-model.cc.
References m_child.
Referenced by GetTypeId().
Ptr< MobilityModel > ns3::HierarchicalMobilityModel::GetParent | ( | ) | const |
Calling GetPosition() on the model returned by this method allows one to access the position of the parent alone, which is used as the reference position to which the child position is added.
Definition at line 117 of file hierarchical-mobility-model.cc.
References m_parent.
Referenced by GetTypeId().
|
static |
Register this type with the TypeId system.
Definition at line 22 of file hierarchical-mobility-model.cc.
References GetChild(), GetParent(), ns3::MakePointerAccessor(), ns3::MakePointerChecker(), SetChild(), SetParent(), and ns3::TypeId::SetParent().
|
private |
Callback for when parent mobility model course change occurs.
model | mobility mode (unused) |
Definition at line 179 of file hierarchical-mobility-model.cc.
References ns3::MobilityModel::NotifyCourseChange().
Referenced by SetParent().
void ns3::HierarchicalMobilityModel::SetChild | ( | Ptr< MobilityModel > | model | ) |
Sets the child mobility model to a new one, possibly replacing an existing one.
If the child model is being replaced, then the new child mobility model's current position is also set to the previous position to ensure that the composite position is preserved by this operation.
model | new mobility model child |
Definition at line 52 of file hierarchical-mobility-model.cc.
References ChildChanged(), ns3::MobilityModel::GetPosition(), m_child, ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::MobilityModel::SetPosition().
Referenced by GetTypeId().
void ns3::HierarchicalMobilityModel::SetParent | ( | Ptr< MobilityModel > | model | ) |
Sets the parent mobility model to a new one, possibly replacing an existing one.
If the parent model is being replaced, then the new position is set to the position that was set before replacement, to ensure that the composite position is preserved across changes to the parent model.
model | new mobility model parent |
Definition at line 80 of file hierarchical-mobility-model.cc.
References ns3::MobilityModel::GetPosition(), m_child, m_parent, ns3::MakeCallback(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ParentChanged(), and ns3::MobilityModel::SetPosition().
Referenced by GetTypeId().
|
private |
pointer to child mobility model
Definition at line 109 of file hierarchical-mobility-model.h.
Referenced by DoAssignStreams(), DoGetPosition(), DoGetVelocity(), DoInitialize(), DoSetPosition(), GetChild(), SetChild(), and SetParent().
|
private |
pointer to parent mobility model
Definition at line 110 of file hierarchical-mobility-model.h.
Referenced by DoAssignStreams(), DoGetPosition(), DoGetVelocity(), DoInitialize(), DoSetPosition(), GetParent(), and SetParent().