3GPP Spectrum Propagation Loss Model More...

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

Inheritance diagram for ns3::ThreeGppSpectrumPropagationLossModel:

Collaboration diagram for ns3::ThreeGppSpectrumPropagationLossModel:

Classes
struct	LongTerm
	Data structure that stores the long term component for a tx-rx pair. More...

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

	~ThreeGppSpectrumPropagationLossModel ()
	Destructor. More...

void	AddDevice (Ptr< NetDevice > n, Ptr< const ThreeGppAntennaArrayModel > a)
	Add a device-antenna pair. More...

Ptr< SpectrumValue >	DoCalcRxPowerSpectralDensity (Ptr< const SpectrumValue > txPsd, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const override
	Computes the received PSD. More...

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

Ptr< MatrixBasedChannelModel >	GetChannelModel () const
	Get the channel model object. More...

void	GetChannelModelAttribute (const std::string &name, AttributeValue &value) const
	Returns the value of an attribute belonging to the associated MatrixBasedChannelModel instance. More...

void	SetChannelModel (Ptr< MatrixBasedChannelModel > channel)
	Set the channel model object. More...

void	SetChannelModelAttribute (const std::string &name, const AttributeValue &value)
	Sets the value of an attribute belonging to the associated MatrixBasedChannelModel instance. More...

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

virtual	~SpectrumPropagationLossModel ()

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

void	SetNext (Ptr< SpectrumPropagationLossModel > next)
	Used to chain various instances of SpectrumPropagationLossModel. 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<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated 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 () const

template<>
Ptr< Object >	GetObject (TypeId tid) const

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)
	Copy constructor. More...

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

SimpleRefCount &	operator= (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 ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::SpectrumPropagationLossModel
static TypeId	GetTypeId ()
	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
Ptr< SpectrumValue >	CalcBeamformingGain (Ptr< SpectrumValue > txPsd, ThreeGppAntennaArrayModel::ComplexVector longTerm, Ptr< const MatrixBasedChannelModel::ChannelMatrix > params, const Vector &sSpeed, const Vector &uSpeed) const
	Computes the beamforming gain and applies it to the tx PSD. More...

ThreeGppAntennaArrayModel::ComplexVector	CalcLongTerm (Ptr< const MatrixBasedChannelModel::ChannelMatrix > channelMatrix, const ThreeGppAntennaArrayModel::ComplexVector &sW, const ThreeGppAntennaArrayModel::ComplexVector &uW) const
	Computes the long term component. More...

double	GetFrequency () const
	Get the operating frequency. More...

ThreeGppAntennaArrayModel::ComplexVector	GetLongTerm (uint32_t aId, uint32_t bId, Ptr< const MatrixBasedChannelModel::ChannelMatrix > channelMatrix, const ThreeGppAntennaArrayModel::ComplexVector &aW, const ThreeGppAntennaArrayModel::ComplexVector &bW) const
	Looks for the long term component in m_longTermMap. More...

Private Attributes
Ptr< MatrixBasedChannelModel >	m_channelModel
	the model to generate the channel matrix More...

std::unordered_map< uint32_t, Ptr< const ThreeGppAntennaArrayModel > >	m_deviceAntennaMap
	map containig the <node, antenna> associations More...

std::unordered_map< uint32_t, Ptr< const LongTerm > >	m_longTermMap
	map containing the long term components More...

Additional Inherited Members
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...

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

3GPP Spectrum Propagation Loss Model

Introspection did not find any typical Config paths.

This class models the frequency dependent propagation phenomena in the way described by 3GPP TR 38.901 document. The main method is DoCalcRxPowerSpectralDensity, which takes as input the power spectral density (PSD) of the transmitted signal, the mobility models of the transmitting node and receiving node, and returns the PSD of the received signal.

See also: MatrixBasedChannelModel; ThreeGppAntennaArrayModel; ChannelCondition

Attributes

ChannelModel: The channel model. It needs to implement the MatrixBasedChannelModel interface
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::Object>
- Initial value: ns3::ThreeGppChannelModel
- Flags: construct write read

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

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

Constructor & Destructor Documentation

◆ ThreeGppSpectrumPropagationLossModel()

ns3::ThreeGppSpectrumPropagationLossModel::ThreeGppSpectrumPropagationLossModel ( )

Constructor.

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

References NS_LOG_FUNCTION.

◆ ~ThreeGppSpectrumPropagationLossModel()

ns3::ThreeGppSpectrumPropagationLossModel::~ThreeGppSpectrumPropagationLossModel ( )

Destructor.

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddDevice()

void ns3::ThreeGppSpectrumPropagationLossModel::AddDevice	(	Ptr< NetDevice >	n,
		Ptr< const ThreeGppAntennaArrayModel >	a
	)

Add a device-antenna pair.

Parameters

n	a pointer to the NetDevice
a	a pointer to the associated ThreeGppAntennaArrayModel

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

References m_deviceAntennaMap, sample-rng-plot::n, and NS_ASSERT_MSG.

◆ CalcBeamformingGain()

Ptr< SpectrumValue > ns3::ThreeGppSpectrumPropagationLossModel::CalcBeamformingGain	(	Ptr< SpectrumValue >	txPsd,
		ThreeGppAntennaArrayModel::ComplexVector	longTerm,
		Ptr< const MatrixBasedChannelModel::ChannelMatrix >	params,
		const Vector &	sSpeed,
		const Vector &	uSpeed
	)		const

private

Computes the beamforming gain and applies it to the tx PSD.

Parameters

txPsd	the tx PSD
longTerm	the long term component
params	The channel matrix
sSpeed	speed of the first node
uSpeed	speed of the second node

Returns: the rx PSD

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

References ns3::MatrixBasedChannelModel::AOA_INDEX, ns3::MatrixBasedChannelModel::AOD_INDEX, ns3::SpectrumValue::ConstBandsBegin(), GetFrequency(), ns3::Time::GetSeconds(), MRG32k3a::norm, ns3::Simulator::Now(), NS_LOG_FUNCTION, ns3::SpectrumValue::ValuesBegin(), ns3::SpectrumValue::ValuesEnd(), ns3::MatrixBasedChannelModel::ZOA_INDEX, and ns3::MatrixBasedChannelModel::ZOD_INDEX.

Referenced by DoCalcRxPowerSpectralDensity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalcLongTerm()

ThreeGppAntennaArrayModel::ComplexVector ns3::ThreeGppSpectrumPropagationLossModel::CalcLongTerm	(	Ptr< const MatrixBasedChannelModel::ChannelMatrix >	channelMatrix,
		const ThreeGppAntennaArrayModel::ComplexVector &	sW,
		const ThreeGppAntennaArrayModel::ComplexVector &	uW
	)		const

private

Computes the long term component.

Parameters

channelMatrix	the channel matrix H
sW	the beamforming vector of the s device
uW	the beamforming vector of the u device

Returns: the long term component

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

References NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by GetLongTerm().

Here is the caller graph for this function:

◆ DoCalcRxPowerSpectralDensity()

Ptr< SpectrumValue > ns3::ThreeGppSpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity	(	Ptr< const SpectrumValue >	txPsd,
		Ptr< const MobilityModel >	a,
		Ptr< const MobilityModel >	b
	)		const

overridevirtual

Computes the received PSD.

This function computes the received PSD by applying the 3GPP fast fading model and the beamforming gain. In particular, it retrieves the matrix representing the channel between node a and node b, computes the corresponding long term component, i.e., the product between the cluster matrices and the TX and RX beamforming vectors (w_rx^T H^n_ab w_tx), and accounts for the Doppler component and the propagation delay. To reduce the computational load, the long term component associated with a certain channel is cached and recomputed only when the channel realization is updated, or when the beamforming vectors change.

Parameters

txPsd	tx PSD
a	first node mobility model
b	second node mobility model

Returns: the received PSD

Implements ns3::SpectrumPropagationLossModel.

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

References CalcBeamformingGain(), GetLongTerm(), m_channelModel, m_deviceAntennaMap, NS_ASSERT, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by ThreeGppSpectrumPropagationLossModelTest::CheckLongTermUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDispose()

void ns3::ThreeGppSpectrumPropagationLossModel::DoDispose ( void )

overridevirtual

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

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

References m_channelModel, m_deviceAntennaMap, and m_longTermMap.

◆ GetChannelModel()

Ptr< MatrixBasedChannelModel > ns3::ThreeGppSpectrumPropagationLossModel::GetChannelModel ( ) const

Get the channel model object.

Returns: a pointer to the object implementing the MatrixBasedChannelModel interface

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

References m_channelModel.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetChannelModelAttribute()

void ns3::ThreeGppSpectrumPropagationLossModel::GetChannelModelAttribute	(	const std::string &	name,
		AttributeValue &	value
	)		const

Returns the value of an attribute belonging to the associated MatrixBasedChannelModel instance.

Parameters

name	name of the attribute
where	the result should be stored

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

References m_channelModel.

◆ GetFrequency()

double ns3::ThreeGppSpectrumPropagationLossModel::GetFrequency ( void ) const

private

Get the operating frequency.

Returns: the operating frequency in Hz

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

References ns3::DoubleValue::Get(), and m_channelModel.

Referenced by CalcBeamformingGain().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLongTerm()

ThreeGppAntennaArrayModel::ComplexVector ns3::ThreeGppSpectrumPropagationLossModel::GetLongTerm	(	uint32_t	aId,
		uint32_t	bId,
		Ptr< const MatrixBasedChannelModel::ChannelMatrix >	channelMatrix,
		const ThreeGppAntennaArrayModel::ComplexVector &	aW,
		const ThreeGppAntennaArrayModel::ComplexVector &	bW
	)		const

private

Looks for the long term component in m_longTermMap.

If found, checks whether it has to be updated. If not found or if it has to be updated, calls the method CalcLongTerm to compute it.

Parameters

aId	id of the first node
bId	id of the second node
channelMatrix	the channel matrix
aW	the beamforming vector of the first device
bW	the beamforming vector of the second device