A Discrete-Event Network Simulator
API
ns3::UanPhyCalcSinr Class Referenceabstract

Class used for calculating SINR of packet in UanPhy. More...

#include "uan-phy.h"

+ Inheritance diagram for ns3::UanPhyCalcSinr:
+ Collaboration diagram for ns3::UanPhyCalcSinr:

Public Member Functions

virtual double CalcSinrDb (Ptr< Packet > pkt, Time arrTime, double rxPowerDb, double ambNoiseDb, UanTxMode mode, UanPdp pdp, const UanTransducer::ArrivalList &arrivalList) const =0
 Calculate the SINR value for a packet. More...
 
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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::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 (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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::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...
 

Protected Member Functions

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...
 

Additional Inherited Members

Detailed Description

Class used for calculating SINR of packet in UanPhy.

Can be set to any derived class using attributes of UanPhy to implement different models.

Config Paths

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

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

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 44 of file uan-phy.h.

Member Function Documentation

◆ CalcSinrDb()

virtual double ns3::UanPhyCalcSinr::CalcSinrDb ( Ptr< Packet pkt,
Time  arrTime,
double  rxPowerDb,
double  ambNoiseDb,
UanTxMode  mode,
UanPdp  pdp,
const UanTransducer::ArrivalList arrivalList 
) const
pure 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.

Implemented in ns3::UanPhyCalcSinrFhFsk, ns3::UanPhyCalcSinrDefault, and ns3::UanPhyCalcSinrDual.

◆ Clear()

void ns3::UanPhyCalcSinr::Clear ( void  )
virtual

Clear all pointer references.

Definition at line 37 of file uan-phy.cc.

Referenced by DoDispose().

+ Here is the caller graph for this function:

◆ DbToKp()

double ns3::UanPhyCalcSinr::DbToKp ( double  db) const
inline

Convert dB re 1 uPa to kilopascals.

Parameters
dbdB value.
Returns
Value in kilopascals.

Definition at line 82 of file uan-phy.h.

Referenced by ns3::UanPhyCalcSinrDual::CalcSinrDb(), ns3::UanPhyCalcSinrDefault::CalcSinrDb(), and ns3::UanPhyCalcSinrFhFsk::CalcSinrDb().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::UanPhyCalcSinr::DoDispose ( void  )
protectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 42 of file uan-phy.cc.

References Clear(), and ns3::Object::DoDispose().

+ Here is the call graph for this function:

◆ GetTypeId()

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

Register this type.

Returns
The object TypeId.

Definition at line 27 of file uan-phy.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ KpToDb()

double ns3::UanPhyCalcSinr::KpToDb ( double  kp) const
inline

Convert kilopascals to dB re 1 uPa.

Parameters
kpValue in kilopascals.
Returns
Valeu in dB re 1 uPa

Definition at line 92 of file uan-phy.h.

Referenced by ns3::UanPhyCalcSinrDual::CalcSinrDb(), ns3::UanPhyCalcSinrDefault::CalcSinrDb(), and ns3::UanPhyCalcSinrFhFsk::CalcSinrDb().

+ Here is the caller graph for this function:

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