A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 ()
 
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::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...
 

Protected Member Functions

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

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.

Definition at line 44 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

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.

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

Clear all pointer references.

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

Referenced by DoDispose().

+ Here is the caller graph for this function:

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:

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

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

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

+ Here is the call graph for this function:

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

Register this type.

Returns
The object TypeId.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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: