a log distance propagation model. More...

#include "propagation-loss-model.h"

Inheritance diagram for ns3::LogDistancePropagationLossModel:

Collaboration diagram for ns3::LogDistancePropagationLossModel:

Public Member Functions
	LogDistancePropagationLossModel ()

	LogDistancePropagationLossModel (const LogDistancePropagationLossModel &)=delete

double	GetPathLossExponent () const

LogDistancePropagationLossModel &	operator= (const LogDistancePropagationLossModel &)=delete

void	SetPathLossExponent (double n)

void	SetReference (double referenceDistance, double referenceLoss)
	Set the reference path loss at a given distance.

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

	PropagationLossModel (const PropagationLossModel &)=delete

	~PropagationLossModel () 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'.

double	CalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const
	Returns the Rx Power taking into account all the PropagationLossModel(s) chained to the current one.

Ptr< PropagationLossModel >	GetNext ()
	Gets the next PropagationLossModel in the chain of loss models that act on the signal.

PropagationLossModel &	operator= (const PropagationLossModel &)=delete

void	SetNext (Ptr< PropagationLossModel > next)
	Enables a chain of loss models to act on the signal.

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 final
	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::PropagationLossModel
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.

Private Member Functions
int64_t	DoAssignStreams (int64_t stream) override
	Assign a fixed random variable stream number to the random variables used by this model.

double	DoCalcRxPower (double txPowerDbm, Ptr< MobilityModel > a, Ptr< MobilityModel > b) const override
	PropagationLossModel.

Static Private Member Functions
static Ptr< PropagationLossModel >	CreateDefaultReference ()
	Creates a default reference loss model.

Private Attributes
double	m_exponent
	model exponent

double	m_referenceDistance
	reference distance

double	m_referenceLoss
	reference loss

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

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.

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

a log distance propagation model.

This model calculates the reception power with a so-called log-distance propagation model: $L = L_0 + 10 n log_{10}(\frac{d}{d_0})$

where:

: the path loss distance exponent
: reference distance (m)
: path loss at reference distance (dB)
: distance (m)
: path loss (dB)

When the path loss is requested at a distance smaller than the reference distance, the tx power is returned.

Config Paths

ns3::LogDistancePropagationLossModel is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::LogDistancePropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::LogDistancePropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::LogDistancePropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::LogDistancePropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::lrwpan::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::LogDistancePropagationLossModel"
"/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::LogDistancePropagationLossModel"
"/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::LogDistancePropagationLossModel"

Attributes

Exponent: The exponent of the Path Loss propagation model
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 3
- Flags: constructwriteread
- Support level: SUPPORTED
ReferenceDistance: The distance at which the reference loss is calculated (m)
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1
- Flags: constructwriteread
- Support level: SUPPORTED
ReferenceLoss: The reference loss at reference distance (dB). (Default is Friis at 1m with 5.15 GHz)
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 46.6777
- Flags: constructwriteread
- Support level: SUPPORTED

No TraceSources are defined for this type
Group: Propagation
Size of this type is 88 bytes (on a 64-bit architecture).

Definition at line 452 of file propagation-loss-model.h.

Constructor & Destructor Documentation

◆ LogDistancePropagationLossModel() [1/2]

ns3::LogDistancePropagationLossModel::LogDistancePropagationLossModel ( )

Definition at line 496 of file propagation-loss-model.cc.

Referenced by LogDistancePropagationLossModel(), GetTypeId(), and operator=().

Here is the caller graph for this function:

◆ LogDistancePropagationLossModel() [2/2]

ns3::LogDistancePropagationLossModel::LogDistancePropagationLossModel ( const LogDistancePropagationLossModel & )

delete

References LogDistancePropagationLossModel().

Here is the call graph for this function:

Member Function Documentation

◆ CreateDefaultReference()

static Ptr< PropagationLossModel > ns3::LogDistancePropagationLossModel::CreateDefaultReference ( )

staticprivate

Creates a default reference loss model.

Returns: a default reference loss model

◆ DoAssignStreams()

int64_t ns3::LogDistancePropagationLossModel::DoAssignStreams ( int64_t stream )

overrideprivatevirtual

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

Definition at line 554 of file propagation-loss-model.cc.

◆ DoCalcRxPower()

double ns3::LogDistancePropagationLossModel::DoCalcRxPower	(	double	txPowerDbm,
		Ptr< MobilityModel >	a,
		Ptr< MobilityModel >	b ) const

overrideprivatevirtual

PropagationLossModel.

Parameters

txPowerDbm	current transmission power (in dBm)
a	the mobility model of the source
b	the mobility model of the destination

Returns: the reception power after adding/multiplying propagation loss (in dBm)

The formula is: rx = 10 * log (Pr0(tx)) - n * 10 * log (d/d0)

Pr0: rx power at reference distance d0 (W) d0: reference distance: 1.0 (m) d: distance (m) tx: tx power (dB) rx: dB

Which, in our case is:

rx = rx0(tx) - 10 * n * log (d/d0)

Implements ns3::PropagationLossModel.

Definition at line 520 of file propagation-loss-model.cc.

References m_exponent, m_referenceDistance, m_referenceLoss, and NS_LOG_DEBUG.

◆ GetPathLossExponent()

double ns3::LogDistancePropagationLossModel::GetPathLossExponent ( ) const

Returns: the current path loss exponent.

Definition at line 514 of file propagation-loss-model.cc.

References m_exponent.

◆ GetTypeId()

TypeId ns3::LogDistancePropagationLossModel::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 470 of file propagation-loss-model.cc.

References LogDistancePropagationLossModel(), ns3::PropagationLossModel::PropagationLossModel(), m_exponent, m_referenceDistance, m_referenceLoss, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ operator=()

LogDistancePropagationLossModel & ns3::LogDistancePropagationLossModel::operator= ( const LogDistancePropagationLossModel & )

delete

References LogDistancePropagationLossModel().

Here is the call graph for this function:

◆ SetPathLossExponent()

void ns3::LogDistancePropagationLossModel::SetPathLossExponent ( double n )

Parameters

n	the path loss exponent. Set the path loss exponent.

Definition at line 501 of file propagation-loss-model.cc.

References m_exponent.

◆ SetReference()

void ns3::LogDistancePropagationLossModel::SetReference	(	double	referenceDistance,
		double	referenceLoss )

Set the reference path loss at a given distance.

Parameters

referenceDistance	reference distance
referenceLoss	reference path loss

Definition at line 507 of file propagation-loss-model.cc.

References m_referenceDistance, and m_referenceLoss.

Member Data Documentation

◆ m_exponent

double ns3::LogDistancePropagationLossModel::m_exponent

private

model exponent

Definition at line 496 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), GetPathLossExponent(), GetTypeId(), and SetPathLossExponent().

◆ m_referenceDistance

double ns3::LogDistancePropagationLossModel::m_referenceDistance

private

reference distance

Definition at line 497 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), GetTypeId(), and SetReference().

◆ m_referenceLoss

double ns3::LogDistancePropagationLossModel::m_referenceLoss

private

reference loss

Definition at line 498 of file propagation-loss-model.h.

Referenced by DoCalcRxPower(), GetTypeId(), and SetReference().

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

src/propagation/model/propagation-loss-model.h
src/propagation/model/propagation-loss-model.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Constructor & Destructor Documentation

◆ LogDistancePropagationLossModel() [1/2]

◆ LogDistancePropagationLossModel() [2/2]

Member Function Documentation

◆ CreateDefaultReference()

◆ DoAssignStreams()

◆ DoCalcRxPower()

◆ GetPathLossExponent()

◆ GetTypeId()

◆ operator=()

◆ SetPathLossExponent()

◆ SetReference()

Member Data Documentation

◆ m_exponent

◆ m_referenceDistance

◆ m_referenceLoss