A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::UanPhyPerGenDefault Class Reference

Default Packet Error Rate calculator for UanPhyGen. More...

#include <uan-phy-gen.h>

+ Inheritance diagram for ns3::UanPhyPerGenDefault:
+ Collaboration diagram for ns3::UanPhyPerGenDefault:

Public Member Functions

 UanPhyPerGenDefault ()
 Constructor. More...
 
virtual ~UanPhyPerGenDefault ()
 Destructor. More...
 
virtual double CalcPer (Ptr< Packet > pkt, double sinrDb, UanTxMode mode)
 Calculate the packet error probability based on SINR at the receiver and a tx mode. More...
 
- Public Member Functions inherited from ns3::UanPhyPer
virtual void Clear (void)
 Clear all pointer references. 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)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::UanPhyPer
static TypeId GetTypeId (void)
 Register this type. More...
 
- 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...
 

Private Attributes

double m_thresh
 SINR threshold. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::UanPhyPer
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
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

Default Packet Error Rate calculator for UanPhyGen.

Doxygen introspection did not find any typical Config paths.

Considers no error if SINR is > user defined threshold (configured by an attribute).


Attributes

  • Threshold: SINR cutoff for good packet reception.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 8
    • Flags: construct write read

No TraceSources are defined for this type.

Definition at line 43 of file uan-phy-gen.h.

Constructor & Destructor Documentation

ns3::UanPhyPerGenDefault::UanPhyPerGenDefault ( )

Constructor.

Definition at line 204 of file uan-phy-gen.cc.

ns3::UanPhyPerGenDefault::~UanPhyPerGenDefault ( )
virtual

Destructor.

Definition at line 209 of file uan-phy-gen.cc.

Member Function Documentation

double ns3::UanPhyPerGenDefault::CalcPer ( Ptr< Packet pkt,
double  sinrDb,
UanTxMode  mode 
)
virtual

Calculate the packet error probability based on SINR at the receiver and a tx mode.

Parameters
pktPacket which is under consideration.
sinrDbSINR at receiver.
modeTX mode used to transmit packet.
Returns
Probability of packet error.

Implements ns3::UanPhyPer.

Definition at line 230 of file uan-phy-gen.cc.

References m_thresh.

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

Register this type.

Returns
The TypeId.

Definition at line 214 of file uan-phy-gen.cc.

References m_thresh, and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

double ns3::UanPhyPerGenDefault::m_thresh
private

SINR threshold.

Definition at line 60 of file uan-phy-gen.h.

Referenced by CalcPer(), and GetTypeId().


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