Implements the pathloss model defined in 3GPP TR 38.901, Table 7.4.1-1 for the UMa scenario. More...

#include "three-gpp-propagation-loss-model.h"

Inheritance diagram for ns3::ThreeGppUmaPropagationLossModel:

Collaboration diagram for ns3::ThreeGppUmaPropagationLossModel:

Public Member Functions
	ThreeGppUmaPropagationLossModel ()
	Constructor. More...

	ThreeGppUmaPropagationLossModel (const ThreeGppUmaPropagationLossModel &)=delete
	Copy constructor. More...

virtual	~ThreeGppUmaPropagationLossModel () override
	Destructor. More...

ThreeGppUmaPropagationLossModel &	operator= (const ThreeGppUmaPropagationLossModel &)=delete
	Copy constructor. More...

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

	ThreeGppPropagationLossModel (const ThreeGppPropagationLossModel &)=delete
	Copy constructor. More...

virtual	~ThreeGppPropagationLossModel () override
	Destructor. More...

Ptr< ChannelConditionModel >	GetChannelConditionModel (void) const
	Returns the associated channel condition model. More...

double	GetFrequency (void) const
	Return the current central frequency. More...

ThreeGppPropagationLossModel &	operator= (const ThreeGppPropagationLossModel &)=delete
	Copy constructor. More...

void	SetChannelConditionModel (Ptr< ChannelConditionModel > model)
	Set the channel condition model used to determine the channel state (e.g., the LOS/NLOS condition) More...

void	SetFrequency (double f)
	Set the central frequency of the model. 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::ThreeGppPropagationLossModel
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 Member Functions
virtual int64_t	DoAssignStreams (int64_t stream) override
	Assign a fixed random variable stream number to the random variables used by this model. More...

double	GetBpDistance (double hUt, double hBs, double distance2D) const
	Computes the breakpoint distance. More...

double	GetLossLos (double distance2D, double distance3D, double hUt, double hBs) const override
	Computes the pathloss between a and b considering that the line of sight is not obstructed. More...

double	GetLossNlos (double distance2D, double distance3D, double hUt, double hBs) const override
	Computes the pathloss between a and b considering that the line of sight is obstructed. More...

virtual double	GetShadowingCorrelationDistance (ChannelCondition::LosConditionValue cond) const override
	Returns the shadow fading correlation distance. More...

virtual double	GetShadowingStd (Ptr< MobilityModel > a, Ptr< MobilityModel > b, ChannelCondition::LosConditionValue cond) const override
	Returns the shadow fading standard deviation. More...

Private Attributes
Ptr< UniformRandomVariable >	m_uniformVar
	a uniform random variable used for the computation of the breakpoint distance More...

Additional Inherited Members
Protected Member Functions inherited from ns3::ThreeGppPropagationLossModel
virtual void	DoDispose () override
	Destructor implementation. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. 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...

Static Protected Member Functions inherited from ns3::ThreeGppPropagationLossModel
static double	Calculate2dDistance (Vector a, Vector b)
	Computes the 2D distance between two 3D vectors. More...

Protected Attributes inherited from ns3::ThreeGppPropagationLossModel
Ptr< ChannelConditionModel >	m_channelConditionModel
	pointer to the channel condition model More...

double	m_frequency
	operating frequency in Hz More...

Ptr< NormalRandomVariable >	m_normRandomVariable
	normal random variable More...

bool	m_shadowingEnabled
	enable/disable shadowing More...

std::unordered_map< uint32_t, ShadowingMapItem >	m_shadowingMap
	map to store the shadowing values 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

Implements the pathloss model defined in 3GPP TR 38.901, Table 7.4.1-1 for the UMa scenario.

Config Paths

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

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

No Attributes are defined for this type.

Attributes defined in parent class ns3::ThreeGppPropagationLossModel

Frequency: The centre frequency in Hz.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 5e+08
- Flags: construct write read
ShadowingEnabled: Enable/disable shadowing.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
ChannelConditionModel: Pointer to the channel condition model.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::ChannelConditionModel>
- Initial value: 0
- Flags: construct write read

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

Definition at line 352 of file three-gpp-propagation-loss-model.h.

Constructor & Destructor Documentation

◆ ThreeGppUmaPropagationLossModel() [1/2]

ns3::ThreeGppUmaPropagationLossModel::ThreeGppUmaPropagationLossModel ( )

Constructor.

Definition at line 511 of file three-gpp-propagation-loss-model.cc.

References ns3::ThreeGppPropagationLossModel::m_channelConditionModel, m_uniformVar, and NS_LOG_FUNCTION.

◆ ~ThreeGppUmaPropagationLossModel()

ns3::ThreeGppUmaPropagationLossModel::~ThreeGppUmaPropagationLossModel ( )

overridevirtual

Destructor.

Definition at line 521 of file three-gpp-propagation-loss-model.cc.

References NS_LOG_FUNCTION.

◆ ThreeGppUmaPropagationLossModel() [2/2]

ns3::ThreeGppUmaPropagationLossModel::ThreeGppUmaPropagationLossModel ( const ThreeGppUmaPropagationLossModel & )

delete

Copy constructor.

Defined and unimplemented to avoid misuse

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::ThreeGppUmaPropagationLossModel::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

Reimplemented from ns3::ThreeGppPropagationLossModel.

Definition at line 700 of file three-gpp-propagation-loss-model.cc.

References ns3::ThreeGppPropagationLossModel::m_normRandomVariable, m_uniformVar, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

◆ GetBpDistance()

double ns3::ThreeGppUmaPropagationLossModel::GetBpDistance	(	double	hUt,
		double	hBs,
		double	distance2D
	)		const

private

Computes the breakpoint distance.

Parameters

hUt	height of the UT in meters
hBs	height of the BS in meters
distance2D	distance between the two nodes in meters

Returns: the breakpoint distance in meters

Definition at line 527 of file three-gpp-propagation-loss-model.cc.

References ns3::UniformRandomVariable::GetInteger(), ns3::UniformRandomVariable::GetValue(), ns3::M_C, ns3::ThreeGppPropagationLossModel::m_frequency, m_uniformVar, and NS_LOG_FUNCTION.

Referenced by GetLossLos().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLossLos()

double ns3::ThreeGppUmaPropagationLossModel::GetLossLos	(	double	distance2D,
		double	distance3D,
		double	hUt,
		double	hBs
	)		const

overrideprivatevirtual

Computes the pathloss between a and b considering that the line of sight is not obstructed.

Parameters

distance2D	the 2D distance between tx and rx in meters
distance3D	the 3D distance between tx and rx in meters
hUt	the height of the UT in meters
hBs	the height of the BS in meters

Returns: pathloss value in dB

Implements ns3::ThreeGppPropagationLossModel.

Definition at line 565 of file three-gpp-propagation-loss-model.cc.

References GetBpDistance(), ns3::ThreeGppPropagationLossModel::m_frequency, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_WARN.

Referenced by GetLossNlos().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLossNlos()

double ns3::ThreeGppUmaPropagationLossModel::GetLossNlos	(	double	distance2D,
		double	distance3D,
		double	hUt,
		double	hBs
	)		const

overrideprivatevirtual

Computes the pathloss between a and b considering that the line of sight is obstructed.

Parameters

distance2D	the 2D distance between tx and rx in meters
distance3D	the 3D distance between tx and rx in meters
hUt	the height of the UT in meters
hBs	the height of the BS in meters

Returns: pathloss value in dB

Implements ns3::ThreeGppPropagationLossModel.

Definition at line 616 of file three-gpp-propagation-loss-model.cc.

References GetLossLos(), ns3::ThreeGppPropagationLossModel::m_frequency, max, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_WARN.

Here is the call graph for this function:

◆ GetShadowingCorrelationDistance()

double ns3::ThreeGppUmaPropagationLossModel::GetShadowingCorrelationDistance ( ChannelCondition::LosConditionValue cond ) const

overrideprivatevirtual

Returns the shadow fading correlation distance.

Parameters

cond	the LOS/NLOS channel condition

Returns: shadowing correlation distance in meters

Implements ns3::ThreeGppPropagationLossModel.

Definition at line 677 of file three-gpp-propagation-loss-model.cc.

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

◆ GetShadowingStd()

double ns3::ThreeGppUmaPropagationLossModel::GetShadowingStd	(	Ptr< MobilityModel >	a,
		Ptr< MobilityModel >	b,
		ChannelCondition::LosConditionValue	cond
	)		const