A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::UanPhyCalcSinr Class Referenceabstract

#include <introspected-doxygen.h>

+ Inheritance 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
 
virtual void Clear (void)
 
double DbToKp (double db) const
 Converts dB re 1 uPa to kilopascals. More...
 
virtual void DoDispose (void)
 
double KpToDb (double kp) const
 Converts kilopascals to dB re 1 uPa. More...
 
- Public Member Functions inherited from ns3::Object
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
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)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
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)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

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.

Class used for calculating SINR of packet in UanPhy. Can be set to any derived class using attributes of UanPhy to implement different models.

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

Member Function Documentation

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

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

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

Clears all pointer references

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

Referenced by DoDispose().

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

Converts dB re 1 uPa to kilopascals.

Parameters
dbdB value
Returns
kilopascals

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

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

void ns3::UanPhyCalcSinr::DoDispose ( void  )
virtual

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

Subclasses are expected to implement their real destruction code in an overriden 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 40 of file uan-phy.cc.

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

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

Converts kilopascals to dB re 1 uPa.

Parameters
kpvalue in kilopascals
Returns
dB re 1 uPa

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

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


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