Calculate packet error probability, based on received SINR and modulation (mode). More...

#include "uan-phy.h"

Inheritance diagram for ns3::UanPhyPer:

Collaboration diagram for ns3::UanPhyPer:

Public Member Functions
virtual double	CalcPer (Ptr< Packet > pkt, double sinrDb, UanTxMode mode)=0
	Calculate the packet error probability based on SINR at the receiver and a tx mode.

virtual void	Clear ()
	Clear all pointer references.

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

Calculate packet error probability, based on received SINR and modulation (mode).

Can be set in UanPhy via attributes.

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

Member Function Documentation

◆ CalcPer()

virtual double ns3::UanPhyPer::CalcPer	(	Ptr< Packet >	pkt,
		double	sinrDb,
		UanTxMode	mode )

pure virtual

Calculate the packet error probability based on SINR at the receiver and a tx mode.

Parameters

pkt	Packet which is under consideration.
sinrDb	SINR at receiver.
mode	TX mode used to transmit packet.

Returns: Probability of packet error.

Implemented in ns3::UanPhyPerCommonModes, ns3::UanPhyPerGenDefault, and ns3::UanPhyPerUmodem.

◆ Clear()

void ns3::UanPhyPer::Clear ( )

virtual

Clear all pointer references.

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

Referenced by DoDispose().

Here is the caller graph for this function:

◆ DoDispose()

void ns3::UanPhyPer::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 50 of file uan-phy.cc.

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

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::UanPhyPer::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

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

References ns3::TypeId::SetParent().

Here is the call 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