Friis spectrum propagation loss model. More...

#include "friis-spectrum-propagation-loss.h"

Inheritance diagram for ns3::FriisSpectrumPropagationLossModel:

Collaboration diagram for ns3::FriisSpectrumPropagationLossModel:

Public Member Functions
	FriisSpectrumPropagationLossModel ()

	~FriisSpectrumPropagationLossModel () override

double	CalculateLoss (double f, double d) const
	Return the propagation loss L according to a simplified version of Friis' formula in which antenna gains are unitary.

Ptr< SpectrumValue >	DoCalcRxPowerSpectralDensity (Ptr< const SpectrumSignalParameters > params, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const override

Public Member Functions inherited from ns3::SpectrumPropagationLossModel
	SpectrumPropagationLossModel ()

	~SpectrumPropagationLossModel () override

int64_t	AssignStreams (int64_t stream)
	If this loss model uses objects of type RandomVariableStream, set the stream numbers to the integers starting with the offset 'stream'.

Ptr< SpectrumValue >	CalcRxPowerSpectralDensity (Ptr< const SpectrumSignalParameters > params, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const
	This method is to be called to calculate.

Ptr< SpectrumPropagationLossModel >	GetNext () const
	Return the pointer to the next SpectrumPropagationLossModel, if any.

void	SetNext (Ptr< SpectrumPropagationLossModel > next)
	Used to chain various instances of SpectrumPropagationLossModel.

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 ()
	Get the type ID.

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

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
int64_t	DoAssignStreams (int64_t stream) override
	Assign a fixed random variable stream number to the random variables used by this model.

Protected Member Functions inherited from ns3::SpectrumPropagationLossModel
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

Friis spectrum propagation loss model.

The propagation loss is calculated according to a simplified version of Friis' formula in which antenna gains are unitary:

$L = \frac{4 \pi * d * f}{C^2}$

where C = 3e8 m/s is the light speed in the vacuum. The intended use is to calculate Prx = Ptx * G

Definition at line 31 of file friis-spectrum-propagation-loss.h.

Constructor & Destructor Documentation

◆ FriisSpectrumPropagationLossModel()

ns3::FriisSpectrumPropagationLossModel::FriisSpectrumPropagationLossModel ( )

Definition at line 22 of file friis-spectrum-propagation-loss.cc.

◆ ~FriisSpectrumPropagationLossModel()

ns3::FriisSpectrumPropagationLossModel::~FriisSpectrumPropagationLossModel ( )

override

Definition at line 26 of file friis-spectrum-propagation-loss.cc.

Member Function Documentation

◆ CalculateLoss()

double ns3::FriisSpectrumPropagationLossModel::CalculateLoss	(	double	f,
		double	d ) const

Return the propagation loss L according to a simplified version of Friis' formula in which antenna gains are unitary.

Parameters

f	frequency in Hz
d	distance in m

Returns: if Prx < Ptx then return Prx; else return Ptx

Definition at line 66 of file friis-spectrum-propagation-loss.cc.

References NS_ASSERT.

Referenced by DoCalcRxPowerSpectralDensity().

Here is the caller graph for this function:

◆ DoAssignStreams()

int64_t ns3::FriisSpectrumPropagationLossModel::DoAssignStreams ( int64_t stream )

overrideprotectedvirtual

Assign a fixed random variable stream number to the random variables used by this model.

Subclasses must implement this; those not using random variables can return zero.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Implements ns3::SpectrumPropagationLossModel.

Definition at line 87 of file friis-spectrum-propagation-loss.cc.

◆ DoCalcRxPowerSpectralDensity()

Ptr< SpectrumValue > ns3::FriisSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity	(	Ptr< const SpectrumSignalParameters >	params,
		Ptr< const MobilityModel >	a,
		Ptr< const MobilityModel >	b ) const