2D random walk mobility model. More...
#include "random-walk-2d-mobility-model.h"
Public Types | |
enum | Mode { MODE_DISTANCE , MODE_TIME } |
An enum representing the different working modes of this module. More... | |
Public Types inherited from ns3::MobilityModel | |
typedef void(* | TracedCallback) (Ptr< const MobilityModel > model) |
TracedCallback signature. More... | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Register this type with the TypeId system. More... | |
Static Public Member Functions inherited from ns3::MobilityModel | |
static TypeId | GetTypeId () |
Register this type with the TypeId system. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Private Member Functions | |
int64_t | DoAssignStreams (int64_t) override |
The default implementation does nothing but return the passed-in parameter. More... | |
void | DoDispose () override |
Destructor implementation. More... | |
Vector | DoGetPosition () const override |
Vector | DoGetVelocity () const override |
void | DoInitialize () override |
Initialize() implementation. More... | |
void | DoInitializePrivate () |
Perform initialization of the object before MobilityModel::DoInitialize () More... | |
void | DoSetPosition (const Vector &position) override |
void | DoWalk (Time timeLeft) |
Walk according to position and velocity, until distance is reached, time is reached, or intersection with the bounding box. More... | |
void | Rebound (Time timeLeft) |
Performs the rebound of the node if it reaches a boundary. More... | |
Private Attributes | |
Rectangle | m_bounds |
Bounds of the area to cruise. More... | |
Ptr< RandomVariableStream > | m_direction |
rv for picking direction More... | |
EventId | m_event |
stored event ID More... | |
ConstantVelocityHelper | m_helper |
helper for this object More... | |
Mode | m_mode |
whether in time or distance mode More... | |
double | m_modeDistance |
Change direction and speed after this distance. More... | |
Time | m_modeTime |
Change current direction and speed after this delay. More... | |
Ptr< RandomVariableStream > | m_speed |
rv for picking speed More... | |
Additional Inherited Members | |
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. More... | |
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. More... | |
double | GetRelativeSpeed (Ptr< const MobilityModel > other) const |
Vector | GetVelocity () const |
void | SetPosition (const Vector &position) |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. More... | |
~Object () override | |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose () |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. More... | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. More... | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. More... | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. More... | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized () const |
Check if the object has been initialized. More... | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. More... | |
SimpleRefCount (const SimpleRefCount &o[[maybe_unused]]) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o[[maybe_unused]]) |
Assignment operator. More... | |
void | Ref () const |
Increment the reference count. More... | |
void | Unref () const |
Decrement the reference count. More... | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. More... | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. More... | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. More... | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. More... | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. More... | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. More... | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. More... | |
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. More... | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. More... | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. More... | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. More... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
2D random walk mobility model.
Each instance moves with a speed and direction chosen at random with the user-provided random variables until either a fixed distance has been walked or until a fixed amount of time. If we hit one of the boundaries (specified by a rectangle), of the model, we rebound on the boundary with a reflexive angle and speed. This model is often identified as a brownian motion model.
The Direction random variable is used for any point strictly inside the boundaries. The points on the boundary have their direction chosen randomly, without considering the Direction Attribute.
Definition at line 51 of file random-walk-2d-mobility-model.h.
An enum representing the different working modes of this module.
Enumerator | |
---|---|
MODE_DISTANCE | |
MODE_TIME |
Definition at line 61 of file random-walk-2d-mobility-model.h.
|
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 252 of file random-walk-2d-mobility-model.cc.
References m_direction, 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 223 of file random-walk-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 230 of file random-walk-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 246 of file random-walk-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 84 of file random-walk-2d-mobility-model.cc.
References ns3::Object::DoInitialize(), and DoInitializePrivate().
|
private |
Perform initialization of the object before MobilityModel::DoInitialize ()
Definition at line 91 of file random-walk-2d-mobility-model.cc.
References ns3::Rectangle::BOTTOMLEFTCORNER, ns3::Rectangle::BOTTOMRIGHTCORNER, ns3::Rectangle::BOTTOMSIDE, DoWalk(), ns3::Rectangle::GetClosestSideOrCorner(), ns3::ConstantVelocityHelper::GetCurrentPosition(), ns3::RandomVariableStream::GetValue(), ns3::UniformRandomVariable::GetValue(), ns3::Rectangle::IsOnTheBorder(), ns3::Rectangle::LEFTSIDE, m_bounds, m_direction, m_helper, m_mode, m_modeDistance, m_modeTime, m_speed, MODE_TIME, ns3::Rectangle::RIGHTSIDE, ns3::Seconds(), ns3::ConstantVelocityHelper::SetVelocity(), ns3::Rectangle::TOPLEFTCORNER, ns3::Rectangle::TOPRIGHTCORNER, ns3::Rectangle::TOPSIDE, ns3::ConstantVelocityHelper::Unpause(), and ns3::ConstantVelocityHelper::Update().
Referenced by DoInitialize(), DoSetPosition(), and DoWalk().
|
overrideprivatevirtual |
position | the position to set. |
Concrete subclasses of this base class must implement this method.
Implements ns3::MobilityModel.
Definition at line 237 of file random-walk-2d-mobility-model.cc.
References ns3::EventId::Cancel(), DoInitializePrivate(), ns3::Rectangle::IsInside(), m_bounds, m_event, m_helper, NS_ASSERT, ns3::Simulator::ScheduleNow(), and ns3::ConstantVelocityHelper::SetPosition().
|
private |
Walk according to position and velocity, until distance is reached, time is reached, or intersection with the bounding box.
timeLeft | The remaining time of the walk |
Definition at line 151 of file random-walk-2d-mobility-model.cc.
References ns3::Rectangle::CalculateIntersection(), ns3::EventId::Cancel(), DoInitializePrivate(), ns3::ConstantVelocityHelper::GetCurrentPosition(), ns3::Time::GetSeconds(), ns3::ConstantVelocityHelper::GetVelocity(), ns3::Rectangle::IsInside(), m_bounds, m_event, m_helper, max, min, ns3::MobilityModel::NotifyCourseChange(), NS_ABORT_MSG, Rebound(), ns3::Simulator::Schedule(), and ns3::Seconds().
Referenced by DoInitializePrivate(), and Rebound().
|
static |
Register this type with the TypeId system.
Definition at line 38 of file random-walk-2d-mobility-model.cc.
References m_bounds, m_direction, m_mode, m_modeDistance, m_modeTime, m_speed, ns3::MakeDoubleAccessor(), ns3::MakeEnumChecker(), ns3::MakePointerAccessor(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), MODE_DISTANCE, MODE_TIME, ns3::Seconds(), and ns3::TypeId::SetParent().
|
private |
Performs the rebound of the node if it reaches a boundary.
timeLeft | The remaining time of the walk |
Definition at line 193 of file random-walk-2d-mobility-model.cc.
References ns3::Rectangle::BOTTOMLEFTCORNER, ns3::Rectangle::BOTTOMRIGHTCORNER, ns3::Rectangle::BOTTOMSIDE, DoWalk(), ns3::Rectangle::GetClosestSideOrCorner(), ns3::ConstantVelocityHelper::GetCurrentPosition(), ns3::ConstantVelocityHelper::GetVelocity(), ns3::Rectangle::LEFTSIDE, m_bounds, m_helper, ns3::Rectangle::RIGHTSIDE, ns3::ConstantVelocityHelper::SetVelocity(), ns3::Rectangle::TOPLEFTCORNER, ns3::Rectangle::TOPRIGHTCORNER, ns3::Rectangle::TOPSIDE, ns3::ConstantVelocityHelper::Unpause(), and ns3::ConstantVelocityHelper::UpdateWithBounds().
Referenced by DoWalk().
|
private |
Bounds of the area to cruise.
Definition at line 97 of file random-walk-2d-mobility-model.h.
Referenced by DoGetPosition(), DoInitializePrivate(), DoSetPosition(), DoWalk(), GetTypeId(), and Rebound().
|
private |
rv for picking direction
Definition at line 96 of file random-walk-2d-mobility-model.h.
Referenced by DoAssignStreams(), DoInitializePrivate(), and GetTypeId().
|
private |
stored event ID
Definition at line 91 of file random-walk-2d-mobility-model.h.
Referenced by DoSetPosition(), and DoWalk().
|
private |
helper for this object
Definition at line 90 of file random-walk-2d-mobility-model.h.
Referenced by DoGetPosition(), DoGetVelocity(), DoInitializePrivate(), DoSetPosition(), DoWalk(), and Rebound().
|
private |
whether in time or distance mode
Definition at line 92 of file random-walk-2d-mobility-model.h.
Referenced by DoInitializePrivate(), and GetTypeId().
|
private |
Change direction and speed after this distance.
Definition at line 93 of file random-walk-2d-mobility-model.h.
Referenced by DoInitializePrivate(), and GetTypeId().
|
private |
Change current direction and speed after this delay.
Definition at line 94 of file random-walk-2d-mobility-model.h.
Referenced by DoInitializePrivate(), and GetTypeId().
|
private |
rv for picking speed
Definition at line 95 of file random-walk-2d-mobility-model.h.
Referenced by DoAssignStreams(), DoInitializePrivate(), and GetTypeId().