A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::UanPhyCalcSinrFhFsk Class Reference
UAN Models

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.
 
 ~UanPhyCalcSinrFhFsk () override
 Destructor.
 
double CalcSinrDb (Ptr< Packet > pkt, Time arrTime, double rxPowerDb, double ambNoiseDb, UanTxMode mode, UanPdp pdp, const UanTransducer::ArrivalList &arrivalList) const override
 Calculate the SINR value for a packet.
 
- Public Member Functions inherited from ns3::UanPhyCalcSinr
virtual void Clear ()
 Clear all pointer references.
 
double DbToKp (double db) const
 Convert dB re 1 uPa to kilopascals.
 
double KpToDb (double kp) const
 Convert kilopascals to dB re 1 uPa.
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const final
 Get the most derived TypeId for this Object.
 
template<typename T>
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< Object > GetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T>
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< Object > GetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::UanPhyCalcSinr
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Attributes

uint32_t m_hops
 Number of hops.
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::UanPhyCalcSinr
void DoDispose () override
 Destructor implementation.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 
- Related Symbols inherited from ns3::ObjectBase
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.
 

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:

  • Parrish, "System Design Considerations for Undersea Networks: Link and Multiple Access Protocols"
  • Siderius, "Effects of Ocean Thermocline Variability on Noncoherent Underwater Acoustic Communications"
  • Rao, "Channel Coding Techniques for Wireless Communications", ch 2

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::UanPhyDual/SinrModelPhy1/$ns3::UanPhyCalcSinrFhFsk"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::UanPhyDual/SinrModelPhy2/$ns3::UanPhyCalcSinrFhFsk"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::UanPhyGen/SinrModel/$ns3::UanPhyCalcSinrFhFsk"

Attributes

  • NumberOfHops: Number of frequencies in hopping pattern.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 13
    • Flags: constructwriteread
    • Support level: SUPPORTED

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

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

Constructor & Destructor Documentation

◆ UanPhyCalcSinrFhFsk()

ns3::UanPhyCalcSinrFhFsk::UanPhyCalcSinrFhFsk ( )

Constructor.

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

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ ~UanPhyCalcSinrFhFsk()

ns3::UanPhyCalcSinrFhFsk::~UanPhyCalcSinrFhFsk ( )
override

Destructor.

Definition at line 95 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
overridevirtual

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

References ns3::Abs(), 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::UanPdp::GetTap(), ns3::UanPhyCalcSinr::KpToDb(), m_hops, NS_FATAL_ERROR, NS_LOG_DEBUG, ns3::Rem(), ns3::Seconds(), ns3::UanPdp::SumTapsFromMaxNc(), and ns3::UanPdp::SumTapsNc().

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::UanPhyCalcSinrFhFsk::GetTypeId ( )
static

Register this type.

Returns
The TypeId.

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

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

+ Here is the call graph for this function:

Member Data Documentation

◆ m_hops

uint32_t ns3::UanPhyCalcSinrFhFsk::m_hops
private

Number of hops.

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

Referenced by CalcSinrDb(), and GetTypeId().

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