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.

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 override
	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::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Protected Member Functions
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.

Additional Inherited Members
Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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.

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

pkt	Packet to calculate SINR for.
arrTime	Arrival time of pkt.
rxPowerDb	The received signal strength of the packet in dB re 1 uPa.
ambNoiseDb	Ambient channel noise in dB re 1 uPa.
mode	TX Mode of pkt.
pdp	Power delay profile of pkt.
arrivalList	List of interfering arrivals given from Transducer.

Returns: The SINR in dB re 1 uPa.

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

◆ Clear()

void ns3::UanPhyCalcSinr::Clear ( )

virtual

Clear all pointer references.

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

db dB value.

Returns: Value in kilopascals.

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

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

Here is the caller graph for this function:

◆ DoDispose()

void ns3::UanPhyCalcSinr::DoDispose ( )

overrideprotectedvirtual

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

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

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::UanPhyCalcSinr::GetTypeId ( )

static

Register this type.

Returns: The object TypeId.

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

kp	Value in kilopascals.

Returns: Value in dB re 1 uPa

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

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

Here is the caller graph for this function:

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

src/uan/model/uan-phy.h
src/uan/model/uan-phy.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CalcSinrDb()

◆ Clear()

◆ DbToKp()

◆ DoDispose()

◆ GetTypeId()

◆ KpToDb()