the interface for Wifi's error models More...
#include "error-rate-model.h"
Public Member Functions | |
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 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 | |
virtual double | DoGetChunkSuccessRate (WifiMode mode, const WifiTxVector &txVector, double snr, uint64_t nbits, uint8_t numRxAntennas, WifiPpduField field, uint16_t staId) const =0 |
A pure virtual method that must be implemented in the subclass. | |
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 | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
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.
Group: Wifi
Size of this type is 56 bytes (on a 64-bit architecture).
Definition at line 24 of file error-rate-model.h.
|
virtual |
Assign a fixed random variable stream number to the random variables used by this model.
Return the number of streams (possibly zero) that have been assigned.
stream | first stream index to use |
Definition at line 93 of file error-rate-model.cc.
double ns3::ErrorRateModel::CalculateSnr | ( | const WifiTxVector & | txVector, |
double | ber ) const |
txVector | a specific transmission vector including WifiMode |
ber | a target BER |
Definition at line 28 of file error-rate-model.cc.
References GetChunkSuccessRate(), ns3::WifiTxVector::GetMode(), and NS_ASSERT.
|
privatepure virtual |
A pure virtual method that must be implemented in the subclass.
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 |
Implemented in ns3::NistErrorRateModel, ns3::TableBasedErrorRateModel, and ns3::YansErrorRateModel.
Referenced by GetChunkSuccessRate().
double ns3::ErrorRateModel::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.
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.
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 (1 if not provided) |
field | the PPDU field to which the chunk belongs to (assumes this is for the payload part if not provided) |
staId | the station ID for MU |
Definition at line 54 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().
|
static |
Get the type ID.
Definition at line 21 of file error-rate-model.cc.
References ns3::TypeId::SetParent().
|
virtual |
Definition at line 87 of file error-rate-model.cc.