A Discrete-Event Network Simulator
API
ns3::UanPhyPerUmodem Class Reference

Packet error rate calculation assuming WHOI Micromodem-like PHY (FH-FSK) 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 ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default 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 operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

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::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)
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Packet error rate calculation assuming WHOI Micromodem-like PHY (FH-FSK)


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.

Config Paths

ns3::UanPhyPerUmodem is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::UanPhyGen/PerModel/$ns3::UanPhyPerUmodem"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::UanPhyDual/PerModelPhy1/$ns3::UanPhyPerUmodem"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::UanPhyDual/PerModelPhy2/$ns3::UanPhyPerUmodem"

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

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

Constructor & Destructor Documentation

◆ UanPhyPerUmodem()

ns3::UanPhyPerUmodem::UanPhyPerUmodem ( )

Constructor.

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

◆ ~UanPhyPerUmodem()

ns3::UanPhyPerUmodem::~UanPhyPerUmodem ( )
virtual

Destructor.

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

Member Function Documentation

◆ CalcPer()

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

References ns3::UanTxMode::FSK, ns3::UanTxMode::GetConstellationSize(), ns3::UanTxMode::GetModType(), ns3::Packet::GetSize(), NChooseK(), and NS_FATAL_ERROR.

Referenced by UanTest::DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeId()

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

Register this type.

Returns
The TypeId.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ NChooseK()

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

References max, min, and sample-rng-plot::n.

Referenced by CalcPer().

+ Here is the caller graph for this function:

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