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
	Returns the Rx Power taking into account all the PropagationLossModel(s) chained to the current one. More...

Ptr< PropagationLossModel >	GetNext ()
	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 ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) 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)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator. 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
	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 erros. 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...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::PropagationLossModel
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Member Functions
	NakagamiPropagationLossModel (const NakagamiPropagationLossModel &)
	Copy constructor. More...

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
	Returns the Rx Power taking into account only the particular PropagationLossModel. More...

NakagamiPropagationLossModel &	operator= (const NakagamiPropagationLossModel &)
	Copy constructor. More...

Private Attributes
double	m_distance1
	Distance1. More...

double	m_distance2
	Distance2. More...

Ptr< ErlangRandomVariable >	m_erlangRandomVariable
	Erlang random variable. More...

Ptr< GammaRandomVariable >	m_gammaRandomVariable
	Gamma random variable. More...

double	m_m0
	m for distances smaller than Distance1 More...

double	m_m1
	m for distances smaller than Distance2 More...

double	m_m2
	m for distances greater than Distance2 More...

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoDispose (void)
	Destructor implementation. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	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 (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

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::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::NakagamiPropagationLossModel"
"/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::WaveNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/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: 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
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::ErlangRandomVariable>
- Initial value: ns3::ErlangRandomVariable
- Flags: construct write read
GammaRv: Access to the underlying GammaRandomVariable
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::GammaRandomVariable>
- Initial value: ns3::GammaRandomVariable
- Flags: construct write read

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

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

Constructor & Destructor Documentation

◆ NakagamiPropagationLossModel() [1/2]

ns3::NakagamiPropagationLossModel::NakagamiPropagationLossModel ( )

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

◆ NakagamiPropagationLossModel() [2/2]

ns3::NakagamiPropagationLossModel::NakagamiPropagationLossModel ( const NakagamiPropagationLossModel & )

private

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

◆ DoAssignStreams()

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.

◆ DoCalcRxPower()

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

privatevirtual

Returns the Rx Power taking into account only the particular PropagationLossModel.

Parameters

txPowerDbm	current transmission power (in dBm)
a	the mobility model of the source
b	the mobility model of the destination

Returns: the reception power after adding/multiplying propagation loss (in dBm)

Implements ns3::PropagationLossModel.

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

References ns3::MobilityModel::GetDistanceFrom(), m_distance1, m_distance2, m_erlangRandomVariable, m_gammaRandomVariable, m_m0, m_m1, m_m2, NS_ASSERT, and NS_LOG_DEBUG.

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::NakagamiPropagationLossModel::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 650 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 & )

private

Copy constructor.

Defined and unimplemented to avoid misuse

Returns

Member Data Documentation

◆ m_distance1

double ns3::NakagamiPropagationLossModel::m_distance1

private

Distance1.

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

Referenced by DoCalcRxPower(), and GetTypeId().

◆ m_distance2

double ns3::NakagamiPropagationLossModel::m_distance2

private

Distance2.

Definition at line 689 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 695 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 696 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 691 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 692 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 693 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), and GetTypeId().

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

src/propagation/model/propagation-loss-model.h
src/propagation/model/propagation-loss-model.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Constructor & Destructor Documentation

◆ NakagamiPropagationLossModel() [1/2]

◆ NakagamiPropagationLossModel() [2/2]

Member Function Documentation

◆ DoAssignStreams()

◆ DoCalcRxPower()

◆ GetTypeId()

◆ operator=()

Member Data Documentation

◆ m_distance1

◆ m_distance2

◆ m_erlangRandomVariable

◆ m_gammaRandomVariable

◆ m_m0

◆ m_m1

◆ m_m2