Random direction mobility model. More...
#include "random-direction-2d-mobility-model.h"
Public Member Functions | |
RandomDirection2dMobilityModel () | |
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. | |
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) 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. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
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 | BeginPause () |
Pause, cancel currently scheduled event, schedule end of pause event. | |
int64_t | DoAssignStreams (int64_t) override |
The default implementation does nothing but return the passed-in parameter. | |
void | DoDispose () override |
Destructor implementation. | |
Vector | DoGetPosition () const override |
Vector | DoGetVelocity () const override |
void | DoInitialize () override |
Initialize() implementation. | |
void | DoInitializePrivate () |
Sets a new random direction and calls SetDirectionAndSpeed. | |
void | DoSetPosition (const Vector &position) override |
void | ResetDirectionAndSpeed () |
Set a new direction and speed. | |
void | SetDirectionAndSpeed (double direction) |
Set new velocity and direction, and schedule next pause event. | |
Private Attributes | |
Rectangle | m_bounds |
the 2D bounding area | |
Ptr< UniformRandomVariable > | m_direction |
rv to control direction | |
EventId | m_event |
event ID of next scheduled event | |
ConstantVelocityHelper | m_helper |
helper for velocity computations | |
Ptr< RandomVariableStream > | m_pause |
a random variable to control pause | |
Ptr< RandomVariableStream > | m_speed |
a random variable to control speed | |
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 | DoInitialize () |
Initialize() 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 Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Random direction mobility model.
The movement of objects is based on random directions: each object pauses for a specific delay, chooses a random direction and speed and then travels in the specific direction until it reaches one of the boundaries of the model. When it reaches the boundary, it pauses, selects a new direction and speed, aso.
ns3::RandomDirection2dMobilityModel is accessible through the following paths with Config::Set and Config::Connect:
Rectangle
Vector3D
Vector3D
No TraceSources are defined for this type.
Size of this type is 192 bytes (on a 64-bit architecture).
Definition at line 45 of file random-direction-2d-mobility-model.h.
ns3::RandomDirection2dMobilityModel::RandomDirection2dMobilityModel | ( | ) |
Definition at line 62 of file random-direction-2d-mobility-model.cc.
References m_direction.
|
private |
Pause, cancel currently scheduled event, schedule end of pause event.
Definition at line 89 of file random-direction-2d-mobility-model.cc.
References ns3::EventId::Cancel(), ns3::RandomVariableStream::GetValue(), m_event, m_helper, m_pause, ns3::MobilityModel::NotifyCourseChange(), ns3::ConstantVelocityHelper::Pause(), ResetDirectionAndSpeed(), ns3::Simulator::Schedule(), ns3::Seconds(), and ns3::ConstantVelocityHelper::Update().
Referenced by SetDirectionAndSpeed().
|
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 164 of file random-direction-2d-mobility-model.cc.
References m_direction, m_pause, m_speed, and ns3::RandomVariableStream::SetStream().
|
overrideprivatevirtual |
Destructor implementation.
This method is called by Dispose() or by the Object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.
It is safe to call GetObject() from within this method.
Reimplemented from ns3::Object.
Definition at line 68 of file random-direction-2d-mobility-model.cc.
References ns3::Object::DoDispose().
|
overrideprivatevirtual |
Concrete subclasses of this base class must implement this method.
Implements ns3::MobilityModel.
Definition at line 143 of file random-direction-2d-mobility-model.cc.
References ns3::ConstantVelocityHelper::GetCurrentPosition(), m_bounds, m_helper, and ns3::ConstantVelocityHelper::UpdateWithBounds().
|
overrideprivatevirtual |
Concrete subclasses of this base class must implement this method.
Implements ns3::MobilityModel.
Definition at line 158 of file random-direction-2d-mobility-model.cc.
References ns3::ConstantVelocityHelper::GetVelocity(), and m_helper.
|
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 75 of file random-direction-2d-mobility-model.cc.
References ns3::Object::DoInitialize(), and DoInitializePrivate().
|
private |
Sets a new random direction and calls SetDirectionAndSpeed.
Definition at line 82 of file random-direction-2d-mobility-model.cc.
References ns3::UniformRandomVariable::GetValue(), m_direction, and SetDirectionAndSpeed().
Referenced by DoInitialize(), and DoSetPosition().
|
overrideprivatevirtual |
position | the position to set. |
Concrete subclasses of this base class must implement this method.
Implements ns3::MobilityModel.
Definition at line 150 of file random-direction-2d-mobility-model.cc.
References ns3::EventId::Cancel(), DoInitializePrivate(), m_event, m_helper, ns3::Simulator::ScheduleNow(), and ns3::ConstantVelocityHelper::SetPosition().
|
static |
Register this type with the TypeId system.
Definition at line 37 of file random-direction-2d-mobility-model.cc.
References m_bounds, m_pause, m_speed, ns3::MakePointerAccessor(), and ns3::TypeId::SetParent().
|
private |
Set a new direction and speed.
Definition at line 118 of file random-direction-2d-mobility-model.cc.
References ns3::Rectangle::BOTTOM, ns3::Rectangle::GetClosestSide(), ns3::ConstantVelocityHelper::GetCurrentPosition(), ns3::UniformRandomVariable::GetValue(), ns3::Rectangle::LEFT, m_bounds, m_direction, m_helper, ns3::Rectangle::RIGHT, SetDirectionAndSpeed(), ns3::Rectangle::TOP, and ns3::ConstantVelocityHelper::UpdateWithBounds().
Referenced by BeginPause().
|
private |
Set new velocity and direction, and schedule next pause event.
direction | (radians) |
Definition at line 101 of file random-direction-2d-mobility-model.cc.
References BeginPause(), ns3::CalculateDistance(), ns3::Rectangle::CalculateIntersection(), ns3::EventId::Cancel(), ns3::ConstantVelocityHelper::GetCurrentPosition(), ns3::RandomVariableStream::GetValue(), m_bounds, m_event, m_helper, m_speed, ns3::MobilityModel::NotifyCourseChange(), NS_LOG_FUNCTION_NOARGS, ns3::Simulator::Schedule(), ns3::Seconds(), ns3::ConstantVelocityHelper::SetVelocity(), ns3::ConstantVelocityHelper::Unpause(), and ns3::ConstantVelocityHelper::UpdateWithBounds().
Referenced by DoInitializePrivate(), and ResetDirectionAndSpeed().
|
private |
the 2D bounding area
Definition at line 81 of file random-direction-2d-mobility-model.h.
Referenced by DoGetPosition(), GetTypeId(), ResetDirectionAndSpeed(), and SetDirectionAndSpeed().
|
private |
rv to control direction
Definition at line 80 of file random-direction-2d-mobility-model.h.
Referenced by RandomDirection2dMobilityModel(), DoAssignStreams(), DoInitializePrivate(), and ResetDirectionAndSpeed().
|
private |
event ID of next scheduled event
Definition at line 84 of file random-direction-2d-mobility-model.h.
Referenced by BeginPause(), DoSetPosition(), and SetDirectionAndSpeed().
|
private |
helper for velocity computations
Definition at line 85 of file random-direction-2d-mobility-model.h.
Referenced by BeginPause(), DoGetPosition(), DoGetVelocity(), DoSetPosition(), ResetDirectionAndSpeed(), and SetDirectionAndSpeed().
|
private |
a random variable to control pause
Definition at line 83 of file random-direction-2d-mobility-model.h.
Referenced by BeginPause(), DoAssignStreams(), and GetTypeId().
|
private |
a random variable to control speed
Definition at line 82 of file random-direction-2d-mobility-model.h.
Referenced by DoAssignStreams(), GetTypeId(), and SetDirectionAndSpeed().