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

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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.

double	RoundSnr (double snr, double precision) const
	Round SNR (in dB) 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 Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::ErrorRateModel>
- Initial value: 0x21dd680
- Flags: constructwriteread
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: constructwriteread

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

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

Constructor & Destructor Documentation

◆ TableBasedErrorRateModel()

ns3::TableBasedErrorRateModel::TableBasedErrorRateModel ( )

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

References NS_LOG_FUNCTION.

◆ ~TableBasedErrorRateModel()

ns3::TableBasedErrorRateModel::~TableBasedErrorRateModel ( )

override

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

mode	the Wi-Fi mode applicable to this chunk
txVector	TXVECTOR of the overall transmission
snr	the SNR of the chunk
nbits	the number of bits in this chunk
numRxAntennas	the number of active RX antennas
field	the PPDU field to which the chunk belongs to
staId	the station ID for MU