The propagation loss is fixed for each pair of nodes and doesn't depend on their actual positions. More...

#include "propagation-loss-model.h"

Inheritance diagram for ns3::MatrixPropagationLossModel:

Collaboration diagram for ns3::MatrixPropagationLossModel:

Public Member Functions
	MatrixPropagationLossModel ()

	MatrixPropagationLossModel (const MatrixPropagationLossModel &)=delete

virtual	~MatrixPropagationLossModel ()

MatrixPropagationLossModel &	operator= (const MatrixPropagationLossModel &)=delete

void	SetDefaultLoss (double defaultLoss)
	Set the default propagation loss (in dB, positive) to be used, infinity if not set. More...

void	SetLoss (Ptr< MobilityModel > a, Ptr< MobilityModel > b, double loss, bool symmetric=true)
	Set loss (in dB, positive) between pair of ns-3 objects (typically, nodes). More...

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

	PropagationLossModel (const PropagationLossModel &)=delete

virtual	~PropagationLossModel ()

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'. More...

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. More...

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

PropagationLossModel &	operator= (const PropagationLossModel &)=delete

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

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. 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
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...

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

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

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

Private Types
typedef std::pair< Ptr< MobilityModel >, Ptr< MobilityModel > >	MobilityPair
	Typedef: Mobility models pair. More...

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. More...

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

Private Attributes
double	m_default
	default loss More...

std::map< MobilityPair, double >	m_loss
	Propagation loss between pair of nodes. More...

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

virtual void	DoDispose (void)
	Destructor implementation. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

The propagation loss is fixed for each pair of nodes and doesn't depend on their actual positions.

This is supposed to be used by synthetic tests. Note that by default propagation loss is assumed to be symmetric.

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::SpectrumChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::LrWpanNetDevice/Channel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
"/ChannelList/[i]/$ns3::SpectrumChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"
"/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::MatrixPropagationLossModel"

Attributes

DefaultLoss: The default value for propagation loss, dB.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1.79769e+308
- Flags: construct write read

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

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

Member Typedef Documentation

◆ MobilityPair

typedef std::pair< Ptr<MobilityModel>, Ptr<MobilityModel> > ns3::MatrixPropagationLossModel::MobilityPair

private

Typedef: Mobility models pair.

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

Constructor & Destructor Documentation

◆ MatrixPropagationLossModel() [1/2]

ns3::MatrixPropagationLossModel::MatrixPropagationLossModel ( )

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

◆ ~MatrixPropagationLossModel()

ns3::MatrixPropagationLossModel::~MatrixPropagationLossModel ( )

virtual

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

◆ MatrixPropagationLossModel() [2/2]

ns3::MatrixPropagationLossModel::MatrixPropagationLossModel ( const MatrixPropagationLossModel & )

delete

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::MatrixPropagationLossModel::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 882 of file propagation-loss-model.cc.

◆ DoCalcRxPower()

double ns3::MatrixPropagationLossModel::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)

Implements ns3::PropagationLossModel.

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

References m_default, and m_loss.

◆ GetTypeId()

TypeId ns3::MatrixPropagationLossModel::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References m_default, ns3::MakeDoubleAccessor(), max, and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ operator=()

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

delete

◆ SetDefaultLoss()

void ns3::MatrixPropagationLossModel::SetDefaultLoss ( double defaultLoss )

Set the default propagation loss (in dB, positive) to be used, infinity if not set.

Parameters

defaultLoss the default proagation loss

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

References m_default.

Referenced by MatrixPropagationLossModelTestCase::DoRun().

Here is the caller graph for this function:

◆ SetLoss()

void ns3::MatrixPropagationLossModel::SetLoss	(	Ptr< MobilityModel >	a,
		Ptr< MobilityModel >	b,
		double	loss,
		bool	symmetric = `true`
	)

Set loss (in dB, positive) between pair of ns-3 objects (typically, nodes).

Parameters

a	ma Source mobility model
b	mb Destination mobility model
loss	a -> b path loss, positive in dB
symmetric	If true (default), both a->b and b->a paths will be affected

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

References m_loss, and NS_ASSERT.

Referenced by MatrixPropagationLossModelTestCase::DoRun().

Here is the caller graph for this function:

Member Data Documentation

◆ m_default

double ns3::MatrixPropagationLossModel::m_default

private

default loss

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

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

◆ m_loss

std::map<MobilityPair, double> ns3::MatrixPropagationLossModel::m_loss

private

Propagation loss between pair of nodes.

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

Referenced by DoCalcRxPower(), and SetLoss().

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 Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Member Typedef Documentation

◆ MobilityPair

Constructor & Destructor Documentation

◆ MatrixPropagationLossModel() [1/2]

◆ ~MatrixPropagationLossModel()

◆ MatrixPropagationLossModel() [2/2]

Member Function Documentation

◆ DoAssignStreams()

◆ DoCalcRxPower()

◆ GetTypeId()

◆ operator=()

◆ SetDefaultLoss()

◆ SetLoss()

Member Data Documentation

◆ m_default

◆ m_loss