A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 (WifiMode txMode, double ber) const
 
virtual double GetChunkSuccessRate (WifiMode mode, double snr, uint32_t nbits) const =0
 A pure virtual method that must be implemented in the subclass. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

the interface for Wifi's error models

Doxygen introspection did not find any typical Config paths.


No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Member Function Documentation

double ns3::ErrorRateModel::CalculateSnr ( WifiMode  txMode,
double  ber 
) const
Parameters
txModea specific transmission mode
bera target ber
Returns
the snr which corresponds to the requested ber.

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

References GetChunkSuccessRate(), and NS_ASSERT.

+ Here is the call graph for this function:

virtual double ns3::ErrorRateModel::GetChunkSuccessRate ( WifiMode  mode,
double  snr,
uint32_t  nbits 
) const
pure virtual

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

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

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

Parameters
modethe Wi-Fi mode the chunk is sent
snrthe SNR of the chunk
nbitsthe number of bits in this chunk
Returns
probability of successfully receiving the chunk

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

Referenced by CalculateSnr().

+ Here is the caller graph for this function:

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

Definition at line 27 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: