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)
double	CalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
Ptr< PropagationLossModel >	GetNext ()
	Gets the next PropagationLossModel in the chain of loss models that act on the signal.
void	SetNext (Ptr< PropagationLossModel > next)
	Enables a chain of loss models to act on the signal.
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	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
virtual	~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)
	This method returns the TypeId associated to ns3::NakagamiPropagationLossModel.

Private Member Functions
	NakagamiPropagationLossModel (const NakagamiPropagationLossModel &o)
virtual int64_t	DoAssignStreams (int64_t stream)
virtual double	DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
NakagamiPropagationLossModel &	operator= (const NakagamiPropagationLossModel &o)

Private Attributes
double	m_distance1
double	m_distance2
Ptr< ErlangRandomVariable >	m_erlangRandomVariable
Ptr< GammaRandomVariable >	m_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)
virtual void	DoStart (void)
virtual void	NotifyNewAggregate (void)

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.

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

Constructor & Destructor Documentation

ns3::NakagamiPropagationLossModel::NakagamiPropagationLossModel ( )

Definition at line 689 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

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

References m_erlangRandomVariable, m_gammaRandomVariable, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

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

privatevirtual

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

References ns3::MobilityModel::GetDistanceFrom(), ns3::GammaRandomVariable::GetValue(), ns3::ErlangRandomVariable::GetValue(), 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:

TypeId ns3::NakagamiPropagationLossModel::GetTypeId ( void )

static

This method returns the TypeId associated to ns3::NakagamiPropagationLossModel.

This object is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::NakagamiPropagationLossModel

Attributes defined for this type:

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