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

Packet error rate calculation assuming WHOI Micromodem-like PHY. More...

#include <uan-phy-gen.h>

+ Inheritance diagram for ns3::UanPhyPerUmodem:
+ Collaboration diagram for ns3::UanPhyPerUmodem:

Public Member Functions

 UanPhyPerUmodem ()
 Constructor. More...
 
virtual ~UanPhyPerUmodem ()
 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 Member Functions

double NChooseK (uint32_t n, uint32_t k)
 Binomial coefficient. 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

Packet error rate calculation assuming WHOI Micromodem-like PHY.

Doxygen introspection did not find any typical Config paths.

Calculates PER assuming rate 1/2 convolutional code with constraint length 9 with soft decision viterbi decoding and a CRC capable of correcting 1 bit error.


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

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

Constructor & Destructor Documentation

ns3::UanPhyPerUmodem::UanPhyPerUmodem ( )

Constructor.

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

ns3::UanPhyPerUmodem::~UanPhyPerUmodem ( )
virtual

Destructor.

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

Member Function Documentation

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

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

This implementation uses calculations for binary FSK modulation coded by a rate 1/2 convolutional code with constraint length = 9 and a viterbi decoder and finally a CRC capable of correcting one bit error. These equations can be found in the book, Digital Communications, by Proakis (any version I think).

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 282 of file uan-phy-gen.cc.

References ns3::Packet::GetSize(), and NChooseK().

Referenced by UanTest::DoRun().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Register this type.

Returns
The TypeId.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

double ns3::UanPhyPerUmodem::NChooseK ( uint32_t  n,
uint32_t  k 
)
private

Binomial coefficient.

Parameters
nPool size.
kNumber of draws.
Returns
Binomial coefficient n choose k.

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

Referenced by CalcPer().

+ Here is the caller graph for this function:


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