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

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

#include <uan-phy-gen.h>

+ Inheritance diagram for ns3::UanPhyCalcSinrFhFsk:
+ Collaboration 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 ()
 
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::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::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

uint32_t m_hops
 Number of hops. More...
 

Additional Inherited Members

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

WHOI Micromodem like FH-FSK model.

Doxygen introspection did not find any typical Config paths.

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.


Attributes

  • NumberOfHops: Number of frequencies in hopping pattern.

No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::UanPhyCalcSinrFhFsk::UanPhyCalcSinrFhFsk ( )

Constructor.

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

ns3::UanPhyCalcSinrFhFsk::~UanPhyCalcSinrFhFsk ( )
virtual

Destructor.

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

Member Function Documentation

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

References ns3::UanPhyCalcSinr::DbToKp(), ns3::UanTxMode::FSK, ns3::UanPdp::GetBegin(), ns3::UanPdp::GetEnd(), ns3::UanTxMode::GetModType(), ns3::UanTxMode::GetPhyRateSps(), ns3::Time::GetSeconds(), ns3::UanPhyCalcSinr::KpToDb(), m_hops, NS_LOG_DEBUG, NS_LOG_WARN, visualizer.core::start(), ns3::UanPdp::SumTapsFromMaxNc(), and ns3::UanPdp::SumTapsNc().

+ Here is the call graph for this function:

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

Register this type.

Returns
The TypeId.

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

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

+ Here is the call graph for this function:

Member Data Documentation

uint32_t ns3::UanPhyCalcSinrFhFsk::m_hops
private

Number of hops.

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

Referenced by CalcSinrDb(), and GetTypeId().


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