A Discrete-Event Network Simulator
API
ns3::TableBasedErrorRateModel Class Reference


Introspection did not find any typical Config paths. More...

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

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

Public Member Functions

 TableBasedErrorRateModel ()
 
 ~TableBasedErrorRateModel ()
 
double DoGetChunkSuccessRate (WifiMode mode, const WifiTxVector &txVector, double snr, uint64_t nbits, uint16_t staId) const
 A pure virtual method that must be implemented in the subclass. More...
 
- Public Member Functions inherited from ns3::ErrorRateModel
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 uint8_t GetMcsForMode (WifiMode mode)
 Utility function to convert WifiMode to an MCS value. More...
 
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ErrorRateModel
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

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. More...
 
double RoundSnr (double snr, double precision) const
 Round SNR (in dB) to the specified precision. More...
 

Private Attributes

Ptr< ErrorRateModelm_fallbackErrorModel
 Error rate model to fallback to if no value is found in the table. More...
 
uint64_t m_threshold
 Threshold in bytes over which the table for large size frames is used. 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


Introspection did not find any typical Config paths.


Attributes

  • FallbackErrorRateModel: Ptr to the fallback error rate model to be used when no matching value is found in a table
  • SizeThreshold: Threshold in bytes over which the table for large size frames is used
    • Set with class: ns3::UintegerValue
    • Underlying type: uint64_t 0:18446744073709551615
    • Initial value: 400
    • Flags: construct write read

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

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

Constructor & Destructor Documentation

◆ TableBasedErrorRateModel()

ns3::TableBasedErrorRateModel::TableBasedErrorRateModel ( )

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

References NS_LOG_FUNCTION.

◆ ~TableBasedErrorRateModel()

ns3::TableBasedErrorRateModel::~TableBasedErrorRateModel ( )

Definition at line 69 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,
uint16_t  staId 
) const
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

Implements ns3::ErrorRateModel.

Definition at line 144 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_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()

uint8_t ns3::TableBasedErrorRateModel::GetMcsForMode ( WifiMode  mode)
static

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

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

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

+ Here is the call graph for this function:

◆ RoundSnr()

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

Round SNR (in dB) to the specified precision.

Parameters
snrthe SNR to round (in dB)
precisionthe precision to use
Returns
the rounded SNR (in dB) to the specified precision

Definition at line 77 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 81 of file table-based-error-rate-model.h.

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

◆ 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 83 of file table-based-error-rate-model.h.

Referenced by DoGetChunkSuccessRate(), and GetTypeId().


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