A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::UanPhyCalcSinrFhFsk Class Reference

WHOI Micromodem like FH-FSK model. More...

#include "uan-phy-gen.h"

+ Inheritance diagram for ns3::UanPhyCalcSinrFhFsk:

Public Member Functions

 UanPhyCalcSinrFhFsk ()
 Constructor. More...
 
virtual ~UanPhyCalcSinrFhFsk ()
 Destructor. More...
 
virtual double CalcSinrDb (Ptr< Packet > pkt, Time arrTime, double rxPowerDb, double ambNoiseDb, UanTxMode mode, UanPdp pdp, const UanTransducer::ArrivalList &arrivalList) const
 Calculate the SINR value for a packet. More...
 
- Public Member Functions inherited from ns3::UanPhyCalcSinr
virtual void Clear (void)
 Clear all pointer references. More...
 
double DbToKp (double db) const
 Convert dB re 1 uPa to kilopascals. More...
 
double KpToDb (double kp) const
 Convert kilopascals to dB re 1 uPa. 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...
 
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::UanPhyCalcSinr
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 Attributes

uint32_t m_hops
 Number of hops. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::UanPhyCalcSinr
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

WHOI Micromodem like FH-FSK model.


Model of interference calculation for FH-FSK wherein all nodes use an identical hopping pattern. In this case, there is an (M-1)*SymbolTime clearing time between symbols transmitted on the same frequency. This clearing time combats ISI from channel delay spread and also has a byproduct of possibly reducing interference from other transmitted packets.

Thanks to Randall Plate for the latest model revision based on the following papers:

Config Paths

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

Attributes

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

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

Constructor & Destructor Documentation

◆ UanPhyCalcSinrFhFsk()

ns3::UanPhyCalcSinrFhFsk::UanPhyCalcSinrFhFsk ( )

Constructor.

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

◆ ~UanPhyCalcSinrFhFsk()

ns3::UanPhyCalcSinrFhFsk::~UanPhyCalcSinrFhFsk ( )
virtual

Destructor.

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

Member Function Documentation

◆ CalcSinrDb()

double ns3::UanPhyCalcSinrFhFsk::CalcSinrDb ( Ptr< Packet pkt,
Time  arrTime,
double  rxPowerDb,
double  ambNoiseDb,
UanTxMode  mode,
UanPdp  pdp,
const UanTransducer::ArrivalList arrivalList 
) const
virtual

Calculate the SINR value for a packet.

Parameters
pktPacket to calculate SINR for.
arrTimeArrival time of pkt.
rxPowerDbThe received signal strength of the packet in dB re 1 uPa.
ambNoiseDbAmbient channel noise in dB re 1 uPa.
modeTX Mode of pkt.
pdpPower delay profile of pkt.
arrivalListList of interfering arrivals given from Transducer.
Returns
The SINR in dB re 1 uPa.

Implements ns3::UanPhyCalcSinr.

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

References ns3::UanPhyCalcSinr::DbToKp(), ns3::UanTxMode::FSK, ns3::UanPdp::GetBegin(), ns3::UanTxMode::GetConstellationSize(), ns3::Tap::GetDelay(), ns3::UanPdp::GetEnd(), ns3::UanTxMode::GetModType(), ns3::UanTxMode::GetPhyRateSps(), ns3::Time::GetSeconds(), ns3::UanPdp::GetTap(), ns3::UanPhyCalcSinr::KpToDb(), m_hops, NS_FATAL_ERROR, NS_LOG_DEBUG, ns3::Seconds(), visualizer.core::start(), ns3::UanPdp::SumTapsFromMaxNc(), and ns3::UanPdp::SumTapsNc().

◆ GetTypeId()

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

Register this type.

Returns
The TypeId.

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

References m_hops, ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

Member Data Documentation

◆ m_hops

uint32_t ns3::UanPhyCalcSinrFhFsk::m_hops
private

Number of hops.

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

Referenced by CalcSinrDb(), and GetTypeId().


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