A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::TableBasedErrorRateModel Class Reference

#include "table-based-error-rate-model.h"

+ Inheritance diagram for ns3::TableBasedErrorRateModel:
+ Collaboration diagram for ns3::TableBasedErrorRateModel:

Public Member Functions

 TableBasedErrorRateModel ()
 
 ~TableBasedErrorRateModel () override
 
- Public Member Functions inherited from ns3::ErrorRateModel
virtual int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model.
 
double CalculateSnr (const WifiTxVector &txVector, double ber) const
 
double GetChunkSuccessRate (WifiMode mode, const WifiTxVector &txVector, double snr, uint64_t nbits, uint8_t numRxAntennas=1, WifiPpduField field=WIFI_PPDU_FIELD_DATA, 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.
 
virtual bool IsAwgn () const
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< Object > GetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< Object > GetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static std::optional< uint8_t > GetMcsForMode (WifiMode mode)
 Utility function to convert WifiMode to an MCS value.
 
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::ErrorRateModel
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Member Functions

double DoGetChunkSuccessRate (WifiMode mode, const WifiTxVector &txVector, double snr, uint64_t nbits, uint8_t numRxAntennas, WifiPpduField field, uint16_t staId) const override
 A pure virtual method that must be implemented in the subclass.
 
double FetchFsr (WifiMode mode, const WifiTxVector &txVector, double snr, uint64_t nbits) const
 Fetch the frame success rate for a given Wi-Fi mode, TXVECTOR, SNR and frame size.
 
dB_u RoundSnr (dB_u snr, double precision) const
 Round SNR to the specified precision.
 

Private Attributes

Ptr< ErrorRateModel > m_fallbackErrorModel
 Error rate model to fallback to if no value is found in the table.
 
uint64_t m_threshold
 Threshold in bytes over which the table for large size frames is used.
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 
- Related Symbols inherited from ns3::ObjectBase
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.
 

Detailed Description

Definition at line 30 of file table-based-error-rate-model.h.

Constructor & Destructor Documentation

◆ TableBasedErrorRateModel()

ns3::TableBasedErrorRateModel::TableBasedErrorRateModel ( )

Definition at line 57 of file table-based-error-rate-model.cc.

References NS_LOG_FUNCTION.

◆ ~TableBasedErrorRateModel()

ns3::TableBasedErrorRateModel::~TableBasedErrorRateModel ( )
override

Definition at line 62 of file table-based-error-rate-model.cc.

References m_fallbackErrorModel, and NS_LOG_FUNCTION.

Member Function Documentation

◆ DoGetChunkSuccessRate()

double ns3::TableBasedErrorRateModel::DoGetChunkSuccessRate ( WifiMode mode,
const WifiTxVector & txVector,
double snr,
uint64_t nbits,
uint8_t numRxAntennas,
WifiPpduField field,
uint16_t staId ) const
overrideprivatevirtual

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
numRxAntennasthe number of active RX antennas
fieldthe PPDU field to which the chunk belongs to
staIdthe station ID for MU
Returns
probability of successfully receiving the chunk

Implements ns3::ErrorRateModel.

Definition at line 139 of file table-based-error-rate-model.cc.

References ns3::AwgnErrorTableBcc1458, ns3::AwgnErrorTableBcc32, ns3::AwgnErrorTableLdpc1458, ns3::ERROR_TABLE_BCC_LARGE_FRAME_SIZE, ns3::ERROR_TABLE_BCC_MAX_NUM_MCS, ns3::ERROR_TABLE_BCC_SMALL_FRAME_SIZE, ns3::ERROR_TABLE_LDPC_FRAME_SIZE, ns3::ERROR_TABLE_LDPC_MAX_NUM_MCS, GetMcsForMode(), ns3::WifiMode::GetModulationClass(), ns3::WifiTxVector::IsLdpc(), m_fallbackErrorModel, m_threshold, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_WARN, ns3::RatioToDb(), RoundSnr(), ns3::SNR_PRECISION, ns3::TABLED_BASED_ERROR_MODEL_PRECISION, and ns3::WIFI_MOD_CLASS_HT.

+ Here is the call graph for this function:

◆ FetchFsr()

double ns3::TableBasedErrorRateModel::FetchFsr ( WifiMode mode,
const WifiTxVector & txVector,
double snr,
uint64_t nbits ) const
private

Fetch the frame success rate for a given Wi-Fi mode, TXVECTOR, SNR and frame size.

Parameters
modethe Wi-Fi mode
txVectorthe TXVECTOR
snrthe SNR (linear scale)
nbitsthe number of bits
Returns
the frame success rate for a given Wi-Fi mode, TXVECTOR, SNR and frame size

◆ GetMcsForMode()

std::optional< uint8_t > ns3::TableBasedErrorRateModel::GetMcsForMode ( WifiMode mode)
static

Utility function to convert WifiMode to an MCS value.

Parameters
modethe WifiMode
Returns
the equivalent MCS value, if found

Definition at line 77 of file table-based-error-rate-model.cc.

References ns3::WifiMode::GetCodeRate(), ns3::WifiMode::GetConstellationSize(), ns3::WifiMode::GetMcsValue(), ns3::WifiMode::GetModulationClass(), ns3::WIFI_CODE_RATE_1_2, ns3::WIFI_CODE_RATE_2_3, ns3::WIFI_CODE_RATE_3_4, ns3::WIFI_MOD_CLASS_ERP_OFDM, ns3::WIFI_MOD_CLASS_HT, and ns3::WIFI_MOD_CLASS_OFDM.

Referenced by DoGetChunkSuccessRate().

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

◆ GetTypeId()

TypeId ns3::TableBasedErrorRateModel::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 36 of file table-based-error-rate-model.cc.

References ns3::CreateObject(), m_fallbackErrorModel, m_threshold, ns3::MakePointerAccessor(), ns3::MakePointerChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ RoundSnr()

dB_u ns3::TableBasedErrorRateModel::RoundSnr ( dB_u snr,
double precision ) const
private

Round SNR to the specified precision.

Parameters
snrthe SNR to round
precisionthe precision to use
Returns
the rounded SNR to the specified precision

Definition at line 69 of file table-based-error-rate-model.cc.

References NS_LOG_FUNCTION.

Referenced by DoGetChunkSuccessRate().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_fallbackErrorModel

Ptr<ErrorRateModel> ns3::TableBasedErrorRateModel::m_fallbackErrorModel
private

Error rate model to fallback to if no value is found in the table.

Definition at line 78 of file table-based-error-rate-model.h.

Referenced by ~TableBasedErrorRateModel(), DoGetChunkSuccessRate(), and GetTypeId().

◆ m_threshold

uint64_t ns3::TableBasedErrorRateModel::m_threshold
private

Threshold in bytes over which the table for large size frames is used.

Definition at line 80 of file table-based-error-rate-model.h.

Referenced by DoGetChunkSuccessRate(), and GetTypeId().

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