Keep track of the current position and velocity of an object. More...
#include <mobility-model.h>
Public Member Functions | |
int64_t | AssignStreams (int64_t stream) |
double | GetDistanceFrom (Ptr< const MobilityModel > position) const |
Vector | GetPosition (void) const |
double | GetRelativeSpeed (Ptr< const MobilityModel > other) const |
Vector | GetVelocity (void) const |
void | SetPosition (const Vector &position) |
Public Member Functions inherited from ns3::Object | |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
AggregateIterator | GetAggregateIterator (void) const |
virtual TypeId | GetInstanceTypeId (void) const |
template<typename T > | |
Ptr< T > | GetObject (void) const |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
void | Initialize (void) |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount (const SimpleRefCount &o) | |
uint32_t | GetReferenceCount (void) const |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
void | Ref (void) const |
void | Unref (void) const |
Public Member Functions inherited from ns3::ObjectBase | |
void | GetAttribute (std::string name, AttributeValue &value) const |
bool | GetAttributeFailSafe (std::string name, AttributeValue &attribute) const |
void | SetAttribute (std::string name, const AttributeValue &value) |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
static void | Cleanup (void) |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Protected Member Functions | |
void | NotifyCourseChange (void) const |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
virtual void | DoDispose (void) |
virtual void | DoInitialize (void) |
virtual void | NotifyNewAggregate (void) |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
Private Member Functions | |
virtual int64_t | DoAssignStreams (int64_t start) |
virtual Vector | DoGetPosition (void) const =0 |
virtual Vector | DoGetVelocity (void) const =0 |
virtual void | DoSetPosition (const Vector &position)=0 |
Private Attributes | |
TracedCallback< Ptr< const MobilityModel > > | m_courseChangeTrace |
Keep track of the current position and velocity of an object.
All space coordinates in this class and its subclasses are understood to be meters or meters/s. i.e., they are all metric international units.
This is a base class for all specific mobility models.
ns3::MobilityModel is accessible through the following paths with Config::Set and Config::Connect:
Definition at line 39 of file mobility-model.h.
int64_t ns3::MobilityModel::AssignStreams | ( | int64_t | stream | ) |
Assign a fixed random variable stream number to the random variables used by this model. Return the number of streams (possibly zero) that have been assigned.
stream | first stream index to use |
Definition at line 102 of file mobility-model.cc.
References DoAssignStreams().
Referenced by ns3::MobilityHelper::AssignStreams().
|
privatevirtual |
The default implementation does nothing but return the passed-in parameter. Subclasses using random variables are expected to override this.
Reimplemented in ns3::GaussMarkovMobilityModel, ns3::SteadyStateRandomWaypointMobilityModel, ns3::RandomWalk2dMobilityModel, ns3::RandomWaypointMobilityModel, and ns3::RandomDirection2dMobilityModel.
Definition at line 109 of file mobility-model.cc.
Referenced by AssignStreams().
|
privatepure virtual |
Concrete subclasses of this base class must implement this method.
Implemented in ns3::WaypointMobilityModel, ns3::BuildingsMobilityModel, ns3::HierarchicalMobilityModel, ns3::GaussMarkovMobilityModel, ns3::SteadyStateRandomWaypointMobilityModel, ns3::RandomWalk2dMobilityModel, ns3::RandomWaypointMobilityModel, ns3::RandomDirection2dMobilityModel, ns3::ConstantVelocityMobilityModel, ns3::ConstantAccelerationMobilityModel, and ns3::ConstantPositionMobilityModel.
Referenced by GetDistanceFrom(), and GetPosition().
|
privatepure virtual |
Concrete subclasses of this base class must implement this method.
Implemented in ns3::WaypointMobilityModel, ns3::BuildingsMobilityModel, ns3::HierarchicalMobilityModel, ns3::GaussMarkovMobilityModel, ns3::SteadyStateRandomWaypointMobilityModel, ns3::RandomWalk2dMobilityModel, ns3::RandomWaypointMobilityModel, ns3::RandomDirection2dMobilityModel, ns3::ConstantVelocityMobilityModel, ns3::ConstantAccelerationMobilityModel, and ns3::ConstantPositionMobilityModel.
Referenced by GetVelocity().
|
privatepure virtual |
position | the position to set. |
Concrete subclasses of this base class must implement this method.
Implemented in ns3::WaypointMobilityModel, ns3::BuildingsMobilityModel, ns3::HierarchicalMobilityModel, ns3::GaussMarkovMobilityModel, ns3::SteadyStateRandomWaypointMobilityModel, ns3::RandomWalk2dMobilityModel, ns3::RandomWaypointMobilityModel, ns3::RandomDirection2dMobilityModel, ns3::ConstantVelocityMobilityModel, ns3::ConstantAccelerationMobilityModel, and ns3::ConstantPositionMobilityModel.
Referenced by SetPosition().
double ns3::MobilityModel::GetDistanceFrom | ( | Ptr< const MobilityModel > | position | ) | const |
position | a reference to another mobility model |
Definition at line 79 of file mobility-model.cc.
References ns3::CalculateDistance(), and DoGetPosition().
Referenced by ns3::LogDistancePropagationLossModel::DoCalcRxPower(), ns3::UanPropModelThorp::GetDelay(), ns3::UanPropModelIdeal::GetDelay(), ns3::ConstantSpeedPropagationDelayModel::GetDelay(), ns3::Kun2600MhzPropagationLossModel::GetLoss(), ns3::OkumuraHataPropagationLossModel::GetLoss(), ns3::Cost231PropagationLossModel::GetLoss(), ns3::ItuR1411NlosOverRooftopPropagationLossModel::GetLoss(), ns3::ItuR1411LosPropagationLossModel::GetLoss(), ns3::HybridBuildingsPropagationLossModel::GetLoss(), ns3::UanPropModelThorp::GetPathLossDb(), ns3::SimpleOfdmWimaxChannel::Send(), ns3::YansWifiChannel::Send(), and ns3::UanChannel::TxPacket().
Vector ns3::MobilityModel::GetPosition | ( | void | ) | const |
Definition at line 62 of file mobility-model.cc.
References DoGetPosition().
Referenced by ns3::Ns2MobilityHelperTest::CheckInitialPositions(), ns3::HierarchicalMobilityModel::DoGetPosition(), ns3::HierarchicalMobilityModel::DoSetPosition(), ns3::OkumuraHataPropagationLossModel::GetLoss(), ns3::ItuR1411NlosOverRooftopPropagationLossModel::GetLoss(), ns3::ItuR1411LosPropagationLossModel::GetLoss(), ns3::HybridBuildingsPropagationLossModel::GetLoss(), ns3::HierarchicalMobilityModel::SetChild(), ns3::HierarchicalMobilityModel::SetParent(), ns3::SingleModelSpectrumChannel::StartTx(), and ns3::MultiModelSpectrumChannel::StartTx().
double ns3::MobilityModel::GetRelativeSpeed | ( | Ptr< const MobilityModel > | other | ) | const |
other | reference to another object's mobility model |
Definition at line 87 of file mobility-model.cc.
References GetVelocity(), ns3::Vector3D::x, ns3::Vector3D::y, and ns3::Vector3D::z.
Vector ns3::MobilityModel::GetVelocity | ( | void | ) | const |
Definition at line 67 of file mobility-model.cc.
References DoGetVelocity().
Referenced by ns3::Ns2MobilityHelperTest::CheckInitialPositions(), ns3::HierarchicalMobilityModel::DoGetVelocity(), and GetRelativeSpeed().
|
protected |
Must be invoked by subclasses when the course of the position changes to notify course change listeners.
Definition at line 96 of file mobility-model.cc.
References m_courseChangeTrace.
Referenced by ns3::ConstantPositionMobilityModel::DoSetPosition(), ns3::ConstantAccelerationMobilityModel::DoSetPosition(), ns3::ConstantVelocityMobilityModel::DoSetPosition(), ns3::WaypointMobilityModel::DoSetPosition(), and ns3::ConstantVelocityMobilityModel::SetVelocity().
void ns3::MobilityModel::SetPosition | ( | const Vector & | position | ) |
position | the position to set. |
Definition at line 73 of file mobility-model.cc.
References DoSetPosition().
Referenced by ns3::aodv::LoopbackTestCase::DoRun(), ns3::ItuR1411LosPropagationLossModelTestCase::DoRun(), ns3::ItuR1411NlosOverRooftopPropagationLossModelTestCase::DoRun(), ns3::Kun2600MhzPropagationLossModelTestCase::DoRun(), ns3::OkumuraHataPropagationLossModelTestCase::DoRun(), FriisPropagationLossModelTestCase::DoRun(), LenaFdMtFfMacSchedulerTestCase::DoRun(), LenaTdMtFfMacSchedulerTestCase::DoRun(), LenaTtaFfMacSchedulerTestCase::DoRun(), TwoRayGroundPropagationLossModelTestCase::DoRun(), WaypointInitialPositionIsWaypoint::DoRun(), ns3::aodv::ChainRegressionTest::DoRun(), LogDistancePropagationLossModelTestCase::DoRun(), RangePropagationLossModelTestCase::DoRun(), ns3::HierarchicalMobilityModel::DoSetPosition(), ns3::MobilityHelper::Install(), ns3::HierarchicalMobilityModel::SetChild(), ns3::HierarchicalMobilityModel::SetParent(), and ns3::LteHexGridEnbTopologyHelper::SetPositionAndInstallEnbDevice().
|
private |
Used to alert subscribers that a change in direction, velocity, or position has occurred.
Definition at line 117 of file mobility-model.h.
Referenced by NotifyCourseChange().