Model the error rate for different modulations. More...

#include <yans-error-rate-model.h>

Inheritance diagram for ns3::YansErrorRateModel:

Collaboration diagram for ns3::YansErrorRateModel:

Public Member Functions
	YansErrorRateModel ()

virtual double	GetChunkSuccessRate (WifiMode mode, double snr, uint32_t nbits) const
	A pure virtual method that must be implemented in the subclass. More...

Public Member Functions inherited from ns3::ErrorRateModel
double	CalculateSnr (WifiMode txMode, double ber) const

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...

SimpleRefCount &	operator= (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::ErrorRateModel
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
double	Binomial (uint32_t k, double p, uint32_t n) const
	Return Binomial distribution for a given k, p, and n. More...

double	CalculatePd (double ber, unsigned int d) const

double	CalculatePdEven (double ber, unsigned int d) const

double	CalculatePdOdd (double ber, unsigned int d) const

uint32_t	Factorial (uint32_t k) const
	Return k! More...

double	GetBpskBer (double snr, uint32_t signalSpread, uint32_t phyRate) const
	Return BER of BPSK with the given parameters. More...

double	GetFecBpskBer (double snr, double nbits, uint32_t signalSpread, uint32_t phyRate, uint32_t dFree, uint32_t adFree) const

double	GetFecQamBer (double snr, uint32_t nbits, uint32_t signalSpread, uint32_t phyRate, uint32_t m, uint32_t dfree, uint32_t adFree, uint32_t adFreePlusOne) const

double	GetQamBer (double snr, unsigned int m, uint32_t signalSpread, uint32_t phyRate) const
	Return BER of QAM-m with the given parameters. More...

double	Log2 (double val) const
	Return the logarithm of the given value to base 2. More...

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

Model the error rate for different modulations.

Doxygen introspection did not find any typical Config paths.

A packet of interest (e.g., a packet can potentially be received by the MAC) is divided into chunks. Each chunk is related to an start/end receiving event. For each chunk, it calculates the ratio (SINR) between received power of packet of interest and summation of noise and interfering power of all the other incoming packets. Then, it will calculate the success rate of the chunk based on BER of the modulation. The success reception rate of the packet is derived from the success rate of all chunks.

The 802.11b modulations:

1 Mbps mode is based on DBPSK. BER is from equation 5.2-69 from John G. Proakis Digitial Communications, 2001 edition
2 Mbps model is based on DQPSK. Equation 8 from "Tight bounds and accurate approximations for dqpsk transmission bit error rate", G. Ferrari and G.E. Corazza ELECTRONICS LETTERS, 40(20):1284-1285, September 2004
5.5 Mbps and 11 Mbps are based on equations (18) and (17) from "Properties and performance of the ieee 802.11b complementarycode-key signal sets", Michael B. Pursley and Thomas C. Royster. IEEE TRANSACTIONS ON COMMUNICATIONS, 57(2):440-449, February 2009.
More detailed description and validation can be found in http://www.nsnam.org/~pei/80211b.pdf

No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 55 of file yans-error-rate-model.h.

Constructor & Destructor Documentation

ns3::YansErrorRateModel::YansErrorRateModel ( )

Definition at line 43 of file yans-error-rate-model.cc.

Member Function Documentation

double ns3::YansErrorRateModel::Binomial	(	uint32_t	k,
		double	p,
		uint32_t	n
	)		const

private

Return Binomial distribution for a given k, p, and n.

Parameters

k
p
n

Returns: a Binomial distribution

Definition at line 84 of file yans-error-rate-model.cc.

References Factorial().

Referenced by CalculatePdEven(), and CalculatePdOdd().

Here is the call graph for this function:

Here is the caller graph for this function:

double ns3::YansErrorRateModel::CalculatePd	(	double	ber,
		unsigned int	d
	)		const

private

Parameters

ber
d

Returns: double

Definition at line 121 of file yans-error-rate-model.cc.

References CalculatePdEven(), and CalculatePdOdd().

Referenced by GetFecBpskBer(), and GetFecQamBer().

Here is the call graph for this function:

Here is the caller graph for this function:

double ns3::YansErrorRateModel::CalculatePdEven	(	double	ber,
		unsigned int	d
	)		const

private

Parameters

ber
d

Returns: double

Definition at line 104 of file yans-error-rate-model.cc.

References Binomial(), and NS_ASSERT.

Referenced by CalculatePd().

Here is the call graph for this function:

Here is the caller graph for this function:

double ns3::YansErrorRateModel::CalculatePdOdd	(	double	ber,
		unsigned int	d
	)		const

private

Parameters

ber
d

Returns: double

Definition at line 90 of file yans-error-rate-model.cc.

References Binomial(), and NS_ASSERT.

Referenced by CalculatePd().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::YansErrorRateModel::Factorial ( uint32_t k ) const

private

Return k!

Parameters

k

Returns: k!

Definition at line 73 of file yans-error-rate-model.cc.

Referenced by Binomial().

Here is the caller graph for this function:

double ns3::YansErrorRateModel::GetBpskBer	(	double	snr,
		uint32_t	signalSpread,
		uint32_t	phyRate
	)		const

private

Return BER of BPSK with the given parameters.

Parameters

snr	snr value
signalSpread
phyRate

Returns: BER of BPSK at the given SNR

Definition at line 53 of file yans-error-rate-model.cc.

References NS_LOG_INFO.

Referenced by GetFecBpskBer().

Here is the caller graph for this function:

double ns3::YansErrorRateModel::GetChunkSuccessRate	(	WifiMode	mode,
		double	snr,
		uint32_t	nbits
	)		const

virtual

A pure virtual method that must be implemented in the subclass.

This method returns the probability that the given 'chuck' of the packet will be successfully received by the PHY.

A chuck can be viewed as a part of a packet with equal SNR. The probability of successfully receiving the chunk depends on the mode, the SNR, and the size of the chunk.

Parameters

mode	the Wi-Fi mode the chunk is sent
snr	the SNR of the chunk
nbits	the number of bits in this chunk

Returns: probability of successfully receiving the chunk

Implements ns3::ErrorRateModel.

Definition at line 176 of file yans-error-rate-model.cc.

References ns3::WifiMode::GetBandwidth(), ns3::WifiMode::GetCodeRate(), ns3::WifiMode::GetConstellationSize(), ns3::WifiMode::GetDataRate(), ns3::DsssErrorRateModel::GetDsssDbpskSuccessRate(), ns3::DsssErrorRateModel::GetDsssDqpskCck11SuccessRate(), ns3::DsssErrorRateModel::GetDsssDqpskCck5_5SuccessRate(), ns3::DsssErrorRateModel::GetDsssDqpskSuccessRate(), GetFecBpskBer(), GetFecQamBer(), ns3::WifiMode::GetModulationClass(), ns3::WifiMode::GetPhyRate(), ns3::WIFI_CODE_RATE_1_2, ns3::WIFI_CODE_RATE_2_3, ns3::WIFI_MOD_CLASS_DSSS, ns3::WIFI_MOD_CLASS_ERP_OFDM, and ns3::WIFI_MOD_CLASS_OFDM.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

double ns3::YansErrorRateModel::GetFecBpskBer	(	double	snr,
		double	nbits,
		uint32_t	signalSpread,
		uint32_t	phyRate,
		uint32_t	dFree,
		uint32_t	adFree
	)		const

private

Parameters

snr
nbits
signalSpread
phyRate
dFree
adFree

Returns: double

Definition at line 136 of file yans-error-rate-model.cc.

References CalculatePd(), and GetBpskBer().

Referenced by GetChunkSuccessRate().

Here is the call graph for this function:

Here is the caller graph for this function:

double ns3::YansErrorRateModel::GetFecQamBer	(	double	snr,
		uint32_t	nbits,
		uint32_t	signalSpread,
		uint32_t	phyRate,
		uint32_t	m,
		uint32_t	dfree,
		uint32_t	adFree,
		uint32_t	adFreePlusOne
	)		const