A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::NakagamiPropagationLossModel Class Reference

Nakagami-m fast fading propagation loss model. More...

#include "propagation-loss-model.h"

+ Inheritance diagram for ns3::NakagamiPropagationLossModel:
+ Collaboration diagram for ns3::NakagamiPropagationLossModel:

Public Member Functions

 NakagamiPropagationLossModel ()
 
 NakagamiPropagationLossModel (const NakagamiPropagationLossModel &)=delete
 
NakagamiPropagationLossModeloperator= (const NakagamiPropagationLossModel &)=delete
 
- Public Member Functions inherited from ns3::PropagationLossModel
 PropagationLossModel ()
 
 PropagationLossModel (const PropagationLossModel &)=delete
 
 ~PropagationLossModel () override
 
int64_t AssignStreams (int64_t stream)
 If this loss model uses objects of type RandomVariableStream, set the stream numbers to the integers starting with the offset 'stream'.
 
double CalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
 Returns the Rx Power taking into account all the PropagationLossModel(s) chained to the current one.
 
Ptr< PropagationLossModelGetNext ()
 Gets the next PropagationLossModel in the chain of loss models that act on the signal.
 
PropagationLossModeloperator= (const PropagationLossModel &)=delete
 
void SetNext (Ptr< PropagationLossModel > next)
 Enables a chain of loss models to act on the signal.
 
- 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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 ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::PropagationLossModel
static TypeId GetTypeId ()
 Get the type ID.
 
- 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

int64_t DoAssignStreams (int64_t stream) override
 Assign a fixed random variable stream number to the random variables used by this model.
 
double DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
 PropagationLossModel.
 

Private Attributes

double m_distance1
 Distance1.
 
double m_distance2
 Distance2.
 
Ptr< ErlangRandomVariablem_erlangRandomVariable
 Erlang random variable.
 
Ptr< GammaRandomVariablem_gammaRandomVariable
 Gamma random variable.
 
double m_m0
 m for distances smaller than Distance1
 
double m_m1
 m for distances smaller than Distance2
 
double m_m2
 m for distances greater than Distance2
 

Additional Inherited Members

virtual int64_t DoAssignStreams (int64_t stream)=0
 Assign a fixed random variable stream number to the random variables used by this model.
 
- 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.
 

Detailed Description

Nakagami-m fast fading propagation loss model.

This propagation loss model implements the Nakagami-m fast fading model, which accounts for the variations in signal strength due to multipath fading. The model does not account for the path loss due to the distance traveled by the signal, hence for typical simulation usage it is recommended to consider using it in combination with other models that take into account this aspect.

The Nakagami-m distribution is applied to the power level. The probability density function is defined as

\[ p(x; m, \omega) = \frac{2 m^m}{\Gamma(m) \omega^m} x^{2m - 1} e^{-\frac{m}{\omega} x^2}  \]

with $ m $ the fading depth parameter and $ \omega $ the average received power.

It is implemented by either a ns3::GammaRandomVariable or a ns3::ErlangRandomVariable random variable.

The implementation of the model allows to specify different values of the m parameter (and hence different fading profiles) for three different distance ranges:

\[ \underbrace{0
\cdots\cdots}_{m_0} \underbrace{d_1 \cdots\cdots}_{m_1} \underbrace{d_2 \cdots\cdots}_{m_2}
\infty \]

For m = 1 the Nakagami-m distribution equals the Rayleigh distribution. Thus this model also implements Rayleigh distribution based fast fading.

Config Paths

ns3::NakagamiPropagationLossModel is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::NakagamiPropagationLossModel"
  • "/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel"

Attributes

  • Distance1: Beginning of the second distance field. Default is 80m.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 80
    • Flags: constructwriteread
  • Distance2: Beginning of the third distance field. Default is 200m.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 200
    • Flags: constructwriteread
  • ErlangRv: Access to the underlying ErlangRandomVariable
  • GammaRv: Access to the underlying GammaRandomVariable
  • m0: m0 for distances smaller than Distance1. Default is 1.5.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1.5
    • Flags: constructwriteread
  • m1: m1 for distances smaller than Distance2. Default is 0.75.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.75
    • Flags: constructwriteread
  • m2: m2 for distances greater than Distance2. Default is 0.75.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.75
    • Flags: constructwriteread

No TraceSources are defined for this type.
Size of this type is 120 bytes (on a 64-bit architecture).

Definition at line 612 of file propagation-loss-model.h.

Constructor & Destructor Documentation

◆ NakagamiPropagationLossModel() [1/2]

ns3::NakagamiPropagationLossModel::NakagamiPropagationLossModel ( )

Definition at line 716 of file propagation-loss-model.cc.

◆ NakagamiPropagationLossModel() [2/2]

ns3::NakagamiPropagationLossModel::NakagamiPropagationLossModel ( const NakagamiPropagationLossModel )
delete

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::NakagamiPropagationLossModel::DoAssignStreams ( int64_t  stream)
overrideprivatevirtual

Assign a fixed random variable stream number to the random variables used by this model.

Subclasses must implement this; those not using random variables can return zero.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implements ns3::PropagationLossModel.

Definition at line 774 of file propagation-loss-model.cc.

References m_erlangRandomVariable, and m_gammaRandomVariable.

◆ DoCalcRxPower()

double ns3::NakagamiPropagationLossModel::DoCalcRxPower ( double  txPowerDbm,
Ptr< MobilityModel a,
Ptr< MobilityModel b 
) const
overrideprivatevirtual

PropagationLossModel.

Parameters
txPowerDbmcurrent transmission power (in dBm)
athe mobility model of the source
bthe mobility model of the destination
Returns
the reception power after adding/multiplying propagation loss (in dBm)

Implements ns3::PropagationLossModel.

Definition at line 721 of file propagation-loss-model.cc.

References m_distance1, m_distance2, m_erlangRandomVariable, m_gammaRandomVariable, m_m0, m_m1, m_m2, NS_ASSERT, and NS_LOG_DEBUG.

◆ GetTypeId()

TypeId ns3::NakagamiPropagationLossModel::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 669 of file propagation-loss-model.cc.

References m_distance1, m_distance2, m_erlangRandomVariable, m_gammaRandomVariable, m_m0, m_m1, m_m2, ns3::MakeDoubleAccessor(), ns3::MakePointerAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ operator=()

NakagamiPropagationLossModel & ns3::NakagamiPropagationLossModel::operator= ( const NakagamiPropagationLossModel )
delete

Member Data Documentation

◆ m_distance1

double ns3::NakagamiPropagationLossModel::m_distance1
private

Distance1.

Definition at line 636 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), and GetTypeId().

◆ m_distance2

double ns3::NakagamiPropagationLossModel::m_distance2
private

Distance2.

Definition at line 637 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), and GetTypeId().

◆ m_erlangRandomVariable

Ptr<ErlangRandomVariable> ns3::NakagamiPropagationLossModel::m_erlangRandomVariable
private

Erlang random variable.

Definition at line 643 of file propagation-loss-model.h.

Referenced by DoAssignStreams(), DoCalcRxPower(), and GetTypeId().

◆ m_gammaRandomVariable

Ptr<GammaRandomVariable> ns3::NakagamiPropagationLossModel::m_gammaRandomVariable
private

Gamma random variable.

Definition at line 644 of file propagation-loss-model.h.

Referenced by DoAssignStreams(), DoCalcRxPower(), and GetTypeId().

◆ m_m0

double ns3::NakagamiPropagationLossModel::m_m0
private

m for distances smaller than Distance1

Definition at line 639 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), and GetTypeId().

◆ m_m1

double ns3::NakagamiPropagationLossModel::m_m1
private

m for distances smaller than Distance2

Definition at line 640 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), and GetTypeId().

◆ m_m2

double ns3::NakagamiPropagationLossModel::m_m2
private

m for distances greater than Distance2

Definition at line 641 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), and GetTypeId().


The documentation for this class was generated from the following files: