Base class for the 3GPP propagation models. More...

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

Inheritance diagram for ns3::ThreeGppPropagationLossModel:

Collaboration diagram for ns3::ThreeGppPropagationLossModel:

Classes
struct	O2iLossMapItem
	Define a struct for the m_o2iLossMap entries. More...

struct	ShadowingMapItem
	Define a struct for the m_shadowingMap entries. More...

Public Member Functions
	ThreeGppPropagationLossModel ()
	Constructor.

	ThreeGppPropagationLossModel (const ThreeGppPropagationLossModel &)=delete

	~ThreeGppPropagationLossModel () override
	Destructor.

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

double	GetFrequency () const
	Return the current central frequency.

bool	IsO2iLowPenetrationLoss (Ptr< const ChannelCondition > cond) const
	Return true if the O2I Building Penetration loss corresponds to a low loss condition.

ThreeGppPropagationLossModel &	operator= (const ThreeGppPropagationLossModel &)=delete

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

void	SetFrequency (double f)
	Set the central frequency of the model.

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

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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.

Protected Member Functions
void	DoDispose () override
	Destructor implementation.

virtual int64_t	DoAssignStreams (int64_t stream)=0
	Assign a fixed random variable stream number to the random variables used by this model.

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.

Static Protected Member Functions
static double	Calculate2dDistance (Vector a, Vector b)
	Computes the 2D distance between two 3D vectors.

Protected Attributes
bool	m_buildingPenLossesEnabled
	enable/disable building penetration losses

Ptr< ChannelConditionModel >	m_channelConditionModel
	pointer to the channel condition model

bool	m_enforceRanges
	strictly enforce TR 38.901 parameter ranges

double	m_frequency
	operating frequency in Hz

Ptr< NormalRandomVariable >	m_normalO2iHighLossVar
	a normal random variable for the calculation of 02i high loss, see TR38.901 Table 7.4.3-2

Ptr< NormalRandomVariable >	m_normalO2iLowLossVar
	a normal random variable for the calculation of 02i low loss, see TR38.901 Table 7.4.3-2

Ptr< NormalRandomVariable >	m_normRandomVariable
	normal random variable

std::unordered_map< uint32_t, O2iLossMapItem >	m_o2iLossMap
	map to store the o2i Loss values

Ptr< UniformRandomVariable >	m_randomO2iVar1
	a uniform random variable for the calculation of the indoor loss, see TR38.901 Table 7.4.3-2

Ptr< UniformRandomVariable >	m_randomO2iVar2
	a uniform random variable for the calculation of the indoor loss, see TR38.901 Table 7.4.3-2

bool	m_shadowingEnabled
	enable/disable shadowing

std::unordered_map< uint32_t, ShadowingMapItem >	m_shadowingMap
	map to store the shadowing values

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
	Computes the received power by applying the pathloss model described in 3GPP TR 38.901.

virtual bool	DoIsO2iLowPenetrationLoss (Ptr< const ChannelCondition > cond) const
	Indicates the condition of the o2i building penetration loss (defined in 3GPP TR 38.901 7.4.3.1).

double	GetLoss (Ptr< ChannelCondition > cond, double distance2D, double distance3D, double hUt, double hBs) const
	Computes the pathloss between a and b.

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

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

virtual double	GetLossNlosv (double distance2D, double distance3D, double hUt, double hBs) const
	Computes the pathloss between a and b considering that the line of sight is obstructed by a vehicle.

virtual double	GetO2iDistance2dIn () const =0
	Returns the minimum of the two independently generated distances according to the uniform distribution between the minimum and the maximum value depending on the specific 3GPP scenario (UMa, UMi-Street Canyon, RMa), i.e., between 0 and 25 m for UMa and UMi-Street Canyon, and between 0 and 10 m for RMa.

virtual double	GetO2iHighPenetrationLoss (Ptr< MobilityModel > a, Ptr< MobilityModel > b, ChannelCondition::LosConditionValue cond) const
	Retrieves the o2i building penetration loss value by looking at m_o2iLossMap.

virtual double	GetO2iLowPenetrationLoss (Ptr< MobilityModel > a, Ptr< MobilityModel > b, ChannelCondition::LosConditionValue cond) const
	Retrieves the o2i building penetration loss value by looking at m_o2iLossMap.

double	GetShadowing (Ptr< MobilityModel > a, Ptr< MobilityModel > b, ChannelCondition::LosConditionValue cond) const
	Retrieves the shadowing value by looking at m_shadowingMap.

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

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

virtual std::pair< double, double >	GetUtAndBsHeights (double za, double zb) const
	Determines hUT and hBS.

Static Private Member Functions
static uint32_t	GetKey (Ptr< MobilityModel > a, Ptr< MobilityModel > b)
	Returns an unique key for the channel between a and b.

static Vector	GetVectorDifference (Ptr< MobilityModel > a, Ptr< MobilityModel > b)
	Get the difference between the node position.

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

Detailed Description

Base class for the 3GPP propagation models.

Config Paths

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

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

Attributes

BuildingPenetrationLossesEnabled: Enable/disable Building Penetration Losses.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread
ChannelConditionModel: Pointer to the channel condition model.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::ChannelConditionModel>
- Initial value: 0
- Flags: constructwriteread
EnforceParameterRanges: Whether to strictly enforce TR38.901 applicability ranges
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: constructwriteread
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: constructwriteread
ShadowingEnabled: Enable/disable shadowing.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread

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

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

Constructor & Destructor Documentation

◆ ThreeGppPropagationLossModel() [1/2]

ns3::ThreeGppPropagationLossModel::ThreeGppPropagationLossModel ( )

Constructor.

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

References m_normalO2iHighLossVar, m_normalO2iLowLossVar, m_normRandomVariable, m_randomO2iVar1, m_randomO2iVar2, and NS_LOG_FUNCTION.

◆ ~ThreeGppPropagationLossModel()

ns3::ThreeGppPropagationLossModel::~ThreeGppPropagationLossModel ( )

override

Destructor.

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

References NS_LOG_FUNCTION.

◆ ThreeGppPropagationLossModel() [2/2]

ns3::ThreeGppPropagationLossModel::ThreeGppPropagationLossModel ( const ThreeGppPropagationLossModel & )

delete

Member Function Documentation

◆ Calculate2dDistance()

double ns3::ThreeGppPropagationLossModel::Calculate2dDistance	(	Vector	a,
		Vector	b
	)

staticprotected

Computes the 2D distance between two 3D vectors.

Parameters

a	the first 3D vector
b	the second 3D vector

Returns: the 2D distance between a and b

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

Referenced by DoCalcRxPower(), and ns3::ThreeGppRmaPropagationLossModel::GetShadowingStd().

Here is the caller graph for this function:

◆ DoAssignStreams()

int64_t ns3::ThreeGppPropagationLossModel::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.

Reimplemented in ns3::ThreeGppUmaPropagationLossModel, and ns3::ThreeGppV2vUrbanPropagationLossModel.

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

References m_normalO2iHighLossVar, m_normalO2iLowLossVar, m_normRandomVariable, m_randomO2iVar1, m_randomO2iVar2, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

◆ DoCalcRxPower()

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

overrideprivatevirtual

Computes the received power by applying the pathloss model described in 3GPP TR 38.901.

Parameters

txPowerDbm	tx power in dBm
a	tx mobility model
b	rx mobility model

Returns: the rx power in dBm

Implements ns3::PropagationLossModel.

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

References Calculate2dDistance(), ns3::CalculateDistance(), GetLoss(), GetO2iHighPenetrationLoss(), GetO2iLowPenetrationLoss(), GetShadowing(), GetUtAndBsHeights(), ns3::ChannelCondition::I2I, IsO2iLowPenetrationLoss(), m_buildingPenLossesEnabled, m_channelConditionModel, m_frequency, m_shadowingEnabled, ns3::ChannelCondition::NLOS, NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::ChannelCondition::O2I.

Here is the call graph for this function:

◆ DoDispose()

void ns3::ThreeGppPropagationLossModel::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 111 of file three-gpp-propagation-loss-model.cc.

References m_channelConditionModel, and m_shadowingMap.

◆ DoIsO2iLowPenetrationLoss()

bool ns3::ThreeGppPropagationLossModel::DoIsO2iLowPenetrationLoss ( Ptr< const ChannelCondition > cond ) const

privatevirtual

Indicates the condition of the o2i building penetration loss (defined in 3GPP TR 38.901 7.4.3.1).

The default implementation returns the condition as set (either based on the buildings materials, or if the probabilistic model is used in the ThreeGppChannelConditionModel, then based on the result of a random variable). The derived classes can change the default behavior by overriding this method.

Parameters

cond	the ptr to the channel condition model

Returns: True for low losses, false for high losses

Reimplemented in ns3::ThreeGppRmaPropagationLossModel.

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

References ns3::ChannelCondition::HIGH, ns3::ChannelCondition::LOW, and NS_ABORT_MSG.

Referenced by IsO2iLowPenetrationLoss().

Here is the caller graph for this function:

◆ GetChannelConditionModel()

Ptr< ChannelConditionModel > ns3::ThreeGppPropagationLossModel::GetChannelConditionModel ( ) const

Returns the associated channel condition model.

Returns: the channel condition model

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

References m_channelConditionModel, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetFrequency()

double ns3::ThreeGppPropagationLossModel::GetFrequency ( ) const

Return the current central frequency.

Returns: The current central frequency

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

References m_frequency, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetKey()

uint32_t ns3::ThreeGppPropagationLossModel::GetKey	(	Ptr< MobilityModel >	a,
		Ptr< MobilityModel >	b
	)

staticprivate

Returns an unique key for the channel between a and b.

The key is the value of the Cantor function calculated by using as first parameter the lowest node ID, and as a second parameter the highest node ID.

Parameters

a	tx mobility model
b	rx mobility model

Returns: channel key

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

References ns3::Node::GetId().

Referenced by GetO2iHighPenetrationLoss(), GetO2iLowPenetrationLoss(), and GetShadowing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLoss()

double ns3::ThreeGppPropagationLossModel::GetLoss	(	Ptr< ChannelCondition >	cond,
		double	distance2D,
		double	distance3D,
		double	hUt,
		double	hBs
	)		const

private

Computes the pathloss between a and b.

Parameters

cond	the channel condition
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

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

References GetLossLos(), GetLossNlos(), GetLossNlosv(), ns3::ChannelCondition::LOS, ns3::ChannelCondition::NLOS, ns3::ChannelCondition::NLOSv, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by DoCalcRxPower().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLossLos()

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

privatepure virtual

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

Implemented in ns3::ThreeGppRmaPropagationLossModel, ns3::ThreeGppUmaPropagationLossModel, ns3::ThreeGppUmiStreetCanyonPropagationLossModel, ns3::ThreeGppIndoorOfficePropagationLossModel, ns3::ThreeGppV2vUrbanPropagationLossModel, and ns3::ThreeGppV2vHighwayPropagationLossModel.

Referenced by GetLoss().

Here is the caller graph for this function:

◆ GetLossNlos()

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

privatepure virtual

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

Implemented in ns3::ThreeGppRmaPropagationLossModel, ns3::ThreeGppUmaPropagationLossModel, ns3::ThreeGppUmiStreetCanyonPropagationLossModel, ns3::ThreeGppIndoorOfficePropagationLossModel, and ns3::ThreeGppV2vUrbanPropagationLossModel.

Referenced by GetLoss().

Here is the caller graph for this function:

◆ GetLossNlosv()

double ns3::ThreeGppPropagationLossModel::GetLossNlosv	(	double	distance2D,
		double	distance3D,
		double	hUt,
		double	hBs
	)		const

privatevirtual

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

By default it raises an error to avoid misuse.

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

Reimplemented in ns3::ThreeGppV2vUrbanPropagationLossModel.

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

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by GetLoss().

Here is the caller graph for this function:

◆ GetO2iDistance2dIn()

virtual double ns3::ThreeGppPropagationLossModel::GetO2iDistance2dIn ( ) const

privatepure virtual

Returns the minimum of the two independently generated distances according to the uniform distribution between the minimum and the maximum value depending on the specific 3GPP scenario (UMa, UMi-Street Canyon, RMa), i.e., between 0 and 25 m for UMa and UMi-Street Canyon, and between 0 and 10 m for RMa.

According to 3GPP TR 38.901 this 2D−in distance shall be UT-specifically generated. 2D−in distance is used for the O2I penetration losses calculation according to 3GPP TR 38.901 7.4.3. See GetO2iLowPenetrationLoss/GetO2iHighPenetrationLoss functions.

Returns: Returns 02i 2D distance (in meters) used to calculate low/high losses.

Implemented in ns3::ThreeGppRmaPropagationLossModel, ns3::ThreeGppUmaPropagationLossModel, ns3::ThreeGppUmiStreetCanyonPropagationLossModel, ns3::ThreeGppIndoorOfficePropagationLossModel, and ns3::ThreeGppV2vUrbanPropagationLossModel.

Referenced by GetO2iHighPenetrationLoss(), and GetO2iLowPenetrationLoss().

Here is the caller graph for this function:

◆ GetO2iHighPenetrationLoss()

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

privatevirtual

Retrieves the o2i building penetration loss value by looking at m_o2iLossMap.

If not found or if the channel condition changed it generates a new independent realization and stores it in the map, otherwise it calculates a new value as defined in 3GPP TR 38.901 7.4.3.1.

Note that all child classes should implement this function to support high losses calculation. As such, this function should be purely virtual.

Parameters

a	tx mobility model (used for the key calculation)
b	rx mobility model (used for the key calculation)
cond	the LOS/NLOS channel condition

Returns: o2iLoss

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

References GetKey(), GetO2iDistance2dIn(), m_frequency, m_normalO2iHighLossVar, m_o2iLossMap, and NS_LOG_FUNCTION.

Referenced by DoCalcRxPower().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetO2iLowPenetrationLoss()

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

privatevirtual

Retrieves the o2i building penetration loss value by looking at m_o2iLossMap.

If not found or if the channel condition changed it generates a new independent realization and stores it in the map, otherwise it calculates a new value as defined in 3GPP TR 38.901 7.4.3.1.

Note that all child classes should implement this function to support low losses calculation. As such, this function should be purely virtual.

Parameters

a	tx mobility model (used for the key calculation)
b	rx mobility model (used for the key calculation)
cond	the LOS/NLOS channel condition

Returns: o2iLoss

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

References GetKey(), GetO2iDistance2dIn(), m_frequency, m_normalO2iLowLossVar, m_o2iLossMap, and NS_LOG_FUNCTION.

Referenced by DoCalcRxPower().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetShadowing()

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

private

Retrieves the shadowing value by looking at m_shadowingMap.

If not found or if the channel condition changed it generates a new independent realization and stores it in the map, otherwise it correlates the new value with the previous one using the autocorrelation function defined in 3GPP TR 38.901, Sec. 7.4.4.

Parameters

a	tx mobility model
b	rx mobility model
cond	the LOS/NLOS channel condition

Returns: shadowing loss in dB

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

References GetKey(), ns3::Vector2D::GetLength(), GetShadowingCorrelationDistance(), GetShadowingStd(), GetVectorDifference(), m_normRandomVariable, m_shadowingMap, and NS_LOG_FUNCTION.

Referenced by DoCalcRxPower().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetShadowingCorrelationDistance()

virtual double ns3::ThreeGppPropagationLossModel::GetShadowingCorrelationDistance ( ChannelCondition::LosConditionValue cond ) const

privatepure virtual

Returns the shadow fading correlation distance.

Parameters

cond	the LOS/NLOS channel condition

Returns: shadowing correlation distance in meters

Implemented in ns3::ThreeGppRmaPropagationLossModel, ns3::ThreeGppUmaPropagationLossModel, ns3::ThreeGppUmiStreetCanyonPropagationLossModel, ns3::ThreeGppIndoorOfficePropagationLossModel, and ns3::ThreeGppV2vUrbanPropagationLossModel.

Referenced by GetShadowing().

Here is the caller graph for this function:

◆ GetShadowingStd()

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

privatepure virtual

Returns the shadow fading standard deviation.

Parameters

a	tx mobility model
b	rx mobility model
cond	the LOS/NLOS channel condition

Returns: shadowing std in dB

Implemented in ns3::ThreeGppRmaPropagationLossModel, ns3::ThreeGppUmaPropagationLossModel, ns3::ThreeGppUmiStreetCanyonPropagationLossModel, ns3::ThreeGppIndoorOfficePropagationLossModel, and ns3::ThreeGppV2vUrbanPropagationLossModel.

Referenced by GetShadowing().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::ThreeGppPropagationLossModel::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References GetChannelConditionModel(), GetFrequency(), m_buildingPenLossesEnabled, m_enforceRanges, m_shadowingEnabled, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeDoubleAccessor(), ns3::MakePointerAccessor(), SetChannelConditionModel(), SetFrequency(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ GetUtAndBsHeights()

std::pair< double, double > ns3::ThreeGppPropagationLossModel::GetUtAndBsHeights	(	double	za,
		double	zb
	)		const

privatevirtual

Determines hUT and hBS.

The default implementation assumes that the tallest node is the BS and the smallest is the UT. The derived classes can change the default behavior by overriding this method.

Parameters

za	the height of the first node in meters
zb	the height of the second node in meters

Returns: std::pair of heights in meters, the first element is hUt and the second is hBs

Reimplemented in ns3::ThreeGppUmiStreetCanyonPropagationLossModel.

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

Referenced by DoCalcRxPower().

Here is the caller graph for this function:

◆ GetVectorDifference()

Vector ns3::ThreeGppPropagationLossModel::GetVectorDifference	(	Ptr< MobilityModel >	a,
		Ptr< MobilityModel >	b
	)

staticprivate

Get the difference between the node position.

The difference is calculated as (b-a) if Id(a) < Id (b), or (a-b) if Id(b) <= Id(a).

Parameters

a	First node
b	Second node

Returns: the difference between the node vector position

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

Referenced by GetShadowing().

Here is the caller graph for this function:

◆ IsO2iLowPenetrationLoss()

bool ns3::ThreeGppPropagationLossModel::IsO2iLowPenetrationLoss ( Ptr< const ChannelCondition > cond ) const

Return true if the O2I Building Penetration loss corresponds to a low loss condition.

Parameters

cond	The ptr to the channel condition model

Returns: True for low loss, false for high

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

References DoIsO2iLowPenetrationLoss().

Referenced by DoCalcRxPower().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

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

delete

◆ SetChannelConditionModel()

void ns3::ThreeGppPropagationLossModel::SetChannelConditionModel ( Ptr< ChannelConditionModel > model )

Set the channel condition model used to determine the channel state (e.g., the LOS/NLOS condition)

Parameters

model pointer to the channel condition model

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

References m_channelConditionModel, and NS_LOG_FUNCTION.

Referenced by ThreeGppShadowingTestCase::ChangeChannelCondition(), BuildingsPenetrationLossesTestCase::DoRun(), GetTypeId(), and ThreeGppShadowingTestCase::RunTest().

Here is the caller graph for this function:

◆ SetFrequency()

void ns3::ThreeGppPropagationLossModel::SetFrequency ( double f )

Set the central frequency of the model.

Parameters

f	the central frequency in the range in Hz, between 500.0e6 and 100.0e9 Hz

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

References m_frequency, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

◆ m_buildingPenLossesEnabled

bool ns3::ThreeGppPropagationLossModel::m_buildingPenLossesEnabled

protected

enable/disable building penetration losses

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

Referenced by DoCalcRxPower(), and GetTypeId().

◆ m_channelConditionModel

Ptr<ChannelConditionModel> ns3::ThreeGppPropagationLossModel::m_channelConditionModel

protected

pointer to the channel condition model

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

Referenced by ns3::ThreeGppIndoorOfficePropagationLossModel::ThreeGppIndoorOfficePropagationLossModel(), ns3::ThreeGppRmaPropagationLossModel::ThreeGppRmaPropagationLossModel(), ns3::ThreeGppUmaPropagationLossModel::ThreeGppUmaPropagationLossModel(), ns3::ThreeGppUmiStreetCanyonPropagationLossModel::ThreeGppUmiStreetCanyonPropagationLossModel(), DoCalcRxPower(), DoDispose(), GetChannelConditionModel(), and SetChannelConditionModel().

◆ m_enforceRanges

bool ns3::ThreeGppPropagationLossModel::m_enforceRanges

protected

strictly enforce TR 38.901 parameter ranges

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

Referenced by ns3::ThreeGppRmaPropagationLossModel::GetLossLos(), ns3::ThreeGppUmaPropagationLossModel::GetLossLos(), ns3::ThreeGppUmiStreetCanyonPropagationLossModel::GetLossLos(), ns3::ThreeGppIndoorOfficePropagationLossModel::GetLossLos(), ns3::ThreeGppRmaPropagationLossModel::GetLossNlos(), ns3::ThreeGppUmaPropagationLossModel::GetLossNlos(), ns3::ThreeGppUmiStreetCanyonPropagationLossModel::GetLossNlos(), ns3::ThreeGppIndoorOfficePropagationLossModel::GetLossNlos(), and GetTypeId().

◆ m_frequency

double ns3::ThreeGppPropagationLossModel::m_frequency

protected

operating frequency in Hz

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

◆ m_normalO2iHighLossVar

Ptr<NormalRandomVariable> ns3::ThreeGppPropagationLossModel::m_normalO2iHighLossVar

protected

a normal random variable for the calculation of 02i high loss, see TR38.901 Table 7.4.3-2

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

Referenced by ThreeGppPropagationLossModel(), DoAssignStreams(), and GetO2iHighPenetrationLoss().

◆ m_normalO2iLowLossVar

Ptr<NormalRandomVariable> ns3::ThreeGppPropagationLossModel::m_normalO2iLowLossVar

protected

a normal random variable for the calculation of 02i low loss, see TR38.901 Table 7.4.3-2

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

Referenced by ThreeGppPropagationLossModel(), DoAssignStreams(), and GetO2iLowPenetrationLoss().

◆ m_normRandomVariable

Ptr<NormalRandomVariable> ns3::ThreeGppPropagationLossModel::m_normRandomVariable

protected

normal random variable

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

Referenced by ThreeGppPropagationLossModel(), DoAssignStreams(), ns3::ThreeGppUmaPropagationLossModel::DoAssignStreams(), ns3::ThreeGppV2vUrbanPropagationLossModel::DoAssignStreams(), and GetShadowing().

◆ m_o2iLossMap

std::unordered_map<uint32_t, O2iLossMapItem> ns3::ThreeGppPropagationLossModel::m_o2iLossMap

mutableprotected

map to store the o2i Loss values

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

Referenced by GetO2iHighPenetrationLoss(), and GetO2iLowPenetrationLoss().

◆ m_randomO2iVar1

Ptr<UniformRandomVariable> ns3::ThreeGppPropagationLossModel::m_randomO2iVar1

protected

a uniform random variable for the calculation of the indoor loss, see TR38.901 Table 7.4.3-2

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

Referenced by ThreeGppPropagationLossModel(), DoAssignStreams(), ns3::ThreeGppRmaPropagationLossModel::GetO2iDistance2dIn(), ns3::ThreeGppUmaPropagationLossModel::GetO2iDistance2dIn(), and ns3::ThreeGppUmiStreetCanyonPropagationLossModel::GetO2iDistance2dIn().

◆ m_randomO2iVar2

Ptr<UniformRandomVariable> ns3::ThreeGppPropagationLossModel::m_randomO2iVar2

protected

a uniform random variable for the calculation of the indoor loss, see TR38.901 Table 7.4.3-2

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

Referenced by ThreeGppPropagationLossModel(), DoAssignStreams(), ns3::ThreeGppRmaPropagationLossModel::GetO2iDistance2dIn(), ns3::ThreeGppUmaPropagationLossModel::GetO2iDistance2dIn(), and ns3::ThreeGppUmiStreetCanyonPropagationLossModel::GetO2iDistance2dIn().

◆ m_shadowingEnabled

bool ns3::ThreeGppPropagationLossModel::m_shadowingEnabled

protected

enable/disable shadowing

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

Referenced by DoCalcRxPower(), and GetTypeId().

◆ m_shadowingMap

std::unordered_map<uint32_t, ShadowingMapItem> ns3::ThreeGppPropagationLossModel::m_shadowingMap

mutableprotected

map to store the shadowing values

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

Referenced by DoDispose(), and GetShadowing().

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

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Constructor & Destructor Documentation

◆ ThreeGppPropagationLossModel() [1/2]

◆ ~ThreeGppPropagationLossModel()

◆ ThreeGppPropagationLossModel() [2/2]

Member Function Documentation

◆ Calculate2dDistance()

◆ DoAssignStreams()

◆ DoCalcRxPower()

◆ DoDispose()

◆ DoIsO2iLowPenetrationLoss()

◆ GetChannelConditionModel()

◆ GetFrequency()

◆ GetKey()

◆ GetLoss()

◆ GetLossLos()

◆ GetLossNlos()

◆ GetLossNlosv()

◆ GetO2iDistance2dIn()

◆ GetO2iHighPenetrationLoss()

◆ GetO2iLowPenetrationLoss()

◆ GetShadowing()

◆ GetShadowingCorrelationDistance()

◆ GetShadowingStd()

◆ GetTypeId()

◆ GetUtAndBsHeights()

◆ GetVectorDifference()

◆ IsO2iLowPenetrationLoss()

◆ operator=()

◆ SetChannelConditionModel()

◆ SetFrequency()

Member Data Documentation

◆ m_buildingPenLossesEnabled

◆ m_channelConditionModel

◆ m_enforceRanges

◆ m_frequency

◆ m_normalO2iHighLossVar

◆ m_normalO2iLowLossVar

◆ m_normRandomVariable

◆ m_o2iLossMap

◆ m_randomO2iVar1

◆ m_randomO2iVar2

◆ m_shadowingEnabled

◆ m_shadowingMap