A Discrete-Event Network Simulator
API
ns3::ErrorRateModel Class Referenceabstract

the interface for Wifi's error models More...

#include "error-rate-model.h"

+ Inheritance diagram for ns3::ErrorRateModel:
+ Collaboration diagram for ns3::ErrorRateModel:

Public Member Functions

double CalculateSnr (const WifiTxVector &txVector, double ber) const
 
double GetChunkSuccessRate (WifiMode mode, const WifiTxVector &txVector, double snr, uint64_t nbits, uint16_t staId=SU_STA_ID) const
 This method returns the probability that the given 'chunk' of the packet will be successfully received by the PHY. 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...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
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...
 
SimpleRefCountoperator= (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::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

virtual double DoGetChunkSuccessRate (WifiMode mode, const WifiTxVector &txVector, double snr, uint64_t nbits, uint16_t staId) const =0
 A pure virtual method that must be implemented in the subclass. 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...
 

Detailed Description

the interface for Wifi's error models


Introspection did not find any typical Config paths.


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

Definition at line 34 of file error-rate-model.h.

Member Function Documentation

◆ CalculateSnr()

double ns3::ErrorRateModel::CalculateSnr ( const WifiTxVector txVector,
double  ber 
) const
Parameters
txVectora specific transmission vector including WifiMode
bera target BER
Returns
the SNR which corresponds to the requested BER

Definition at line 39 of file error-rate-model.cc.

References GetChunkSuccessRate(), ns3::WifiTxVector::GetMode(), and NS_ASSERT.

+ Here is the call graph for this function:

◆ DoGetChunkSuccessRate()

virtual double ns3::ErrorRateModel::DoGetChunkSuccessRate ( WifiMode  mode,
const WifiTxVector txVector,
double  snr,
uint64_t  nbits,
uint16_t  staId 
) const
privatepure virtual

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

Parameters
modethe Wi-Fi mode applicable to this chunk
txVectorTXVECTOR of the overall transmission
snrthe SNR of the chunk
nbitsthe number of bits in this chunk
staIdthe station ID for MU
Returns
probability of successfully receiving the chunk

Implemented in ns3::YansErrorRateModel, ns3::NistErrorRateModel, and ns3::TableBasedErrorRateModel.

Referenced by GetChunkSuccessRate().

+ Here is the caller graph for this function:

◆ GetChunkSuccessRate()

double ns3::ErrorRateModel::GetChunkSuccessRate ( WifiMode  mode,
const WifiTxVector txVector,
double  snr,
uint64_t  nbits,
uint16_t  staId = SU_STA_ID 
) const

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

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

Note that both a WifiMode and a WifiTxVector (which contains a WifiMode) are passed into this method. The WifiTxVector may be from a signal that contains multiple modes (e.g. PHY header sent differently from PHY payload). Consequently, the mode parameter is what the method uses to calculate the chunk error rate, and the txVector is used for other information as needed.

This method handles 802.11b rates by using the DSSS error rate model. For all other rates, the method implemented by the subclass is called.

Parameters
modethe Wi-Fi mode applicable to this chunk
txVectorTXVECTOR of the overall transmission
snrthe SNR of the chunk
nbitsthe number of bits in this chunk
staIdthe station ID for MU
Returns
probability of successfully receiving the chunk

Definition at line 63 of file error-rate-model.cc.

References DoGetChunkSuccessRate(), ns3::WifiMode::GetDataRate(), ns3::DsssErrorRateModel::GetDsssDbpskSuccessRate(), ns3::DsssErrorRateModel::GetDsssDqpskCck11SuccessRate(), ns3::DsssErrorRateModel::GetDsssDqpskCck5_5SuccessRate(), ns3::DsssErrorRateModel::GetDsssDqpskSuccessRate(), ns3::WifiMode::GetModulationClass(), NS_ASSERT, ns3::WIFI_MOD_CLASS_DSSS, and ns3::WIFI_MOD_CLASS_HR_DSSS.

Referenced by CalculateSnr(), WifiErrorRateModelsTestCaseNist::DoRun(), and TableBasedErrorRateTestCase::DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::ErrorRateModel::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 29 of file error-rate-model.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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