A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 ()
 
- Public Member Functions inherited from ns3::PropagationLossModel
 PropagationLossModel ()
 
virtual ~PropagationLossModel ()
 
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'. More...
 
double CalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
 
Ptr< PropagationLossModelGetNext ()
 Gets the next PropagationLossModel in the chain of loss models that act on the signal. More...
 
void SetNext (Ptr< PropagationLossModel > next)
 Enables a chain of loss models to act on the signal. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
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)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) 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
 
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::PropagationLossModel
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

 NakagamiPropagationLossModel (const NakagamiPropagationLossModel &o)
 
virtual int64_t DoAssignStreams (int64_t stream)
 Subclasses must implement this; those not using random variables can return zero. More...
 
virtual double DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
 
NakagamiPropagationLossModeloperator= (const NakagamiPropagationLossModel &o)
 

Private Attributes

double m_distance1
 
double m_distance2
 
Ptr< ErlangRandomVariablem_erlangRandomVariable
 
Ptr< GammaRandomVariablem_gammaRandomVariable
 
double m_m0
 
double m_m1
 
double m_m2
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Nakagami-m fast fading propagation loss model.

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} = 2 x \cdot p_{\text{Gamma}}(x^2, m, \frac{m}{\omega}) \]

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.

Like in ns3::ThreeLogDistancePropagationLossModel, the m parameter is varied over three distance fields:

\[ \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:

  • /ChannelList/[i]/$ns3::WifiChannel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel
  • /ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$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: construct write read
  • 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: construct write read
  • 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: construct write read
  • 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: construct write read
  • 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: construct write read
  • ErlangRv: Access to the underlying ErlangRandomVariable
  • GammaRv: Access to the underlying GammaRandomVariable

No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::NakagamiPropagationLossModel::NakagamiPropagationLossModel ( )

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

ns3::NakagamiPropagationLossModel::NakagamiPropagationLossModel ( const NakagamiPropagationLossModel o)
private

Member Function Documentation

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

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

Implements ns3::PropagationLossModel.

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

References m_erlangRandomVariable, and m_gammaRandomVariable.

double ns3::NakagamiPropagationLossModel::DoCalcRxPower ( double  txPowerDbm,
Ptr< MobilityModel a,
Ptr< MobilityModel b 
) const
privatevirtual
TypeId ns3::NakagamiPropagationLossModel::GetTypeId ( void  )
static

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

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

+ Here is the call graph for this function:

NakagamiPropagationLossModel& ns3::NakagamiPropagationLossModel::operator= ( const NakagamiPropagationLossModel o)
private

Member Data Documentation

double ns3::NakagamiPropagationLossModel::m_distance1
private

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

Referenced by DoCalcRxPower(), and GetTypeId().

double ns3::NakagamiPropagationLossModel::m_distance2
private

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

Referenced by DoCalcRxPower(), and GetTypeId().

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

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

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

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

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

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

double ns3::NakagamiPropagationLossModel::m_m0
private

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

Referenced by DoCalcRxPower(), and GetTypeId().

double ns3::NakagamiPropagationLossModel::m_m1
private

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

Referenced by DoCalcRxPower(), and GetTypeId().

double ns3::NakagamiPropagationLossModel::m_m2
private

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

Referenced by DoCalcRxPower(), and GetTypeId().


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