This struct provides the generic signal representation to be used by all wireless technologies. More...

#include "spectrum-signal-parameters.h"

Inheritance diagram for ns3::SpectrumSignalParameters:

Collaboration diagram for ns3::SpectrumSignalParameters:

Public Member Functions
	SpectrumSignalParameters ()
	default constructor More...

	SpectrumSignalParameters (const SpectrumSignalParameters &p)
	copy constructor More...

virtual	~SpectrumSignalParameters ()
	destructor More...

virtual Ptr< SpectrumSignalParameters >	Copy () const
	make a "virtual" copy of this class, where "virtual" refers to the fact that if the actual object is a derived class of SpectrumSignalParameters, then the copy is also a derived class of the same type. More...

Public Member Functions inherited from ns3::SimpleRefCount< SpectrumSignalParameters >
	SimpleRefCount ()
	Default constructor. More...

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

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

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () const
	Decrement the reference count. More...

Public Attributes
Time	duration
	The duration of the packet transmission. More...

Ptr< const ComplexMatrixArray >	precodingMatrix
	The 3D precoding matrix where the dimensions are: the number of TX ports, the number of TX streams, the number of RBs. More...

Ptr< SpectrumValue >	psd
	The Power Spectral Density of the waveform, in linear units. More...

Ptr< const ComplexMatrixArray >	spectrumChannelMatrix
	The 3D channel matrix where the dimensions are: the number of RX ports, the number of TX Ports, the number of resource blocks (RBs). More...

Ptr< AntennaModel >	txAntenna
	The AntennaModel instance that was used to transmit this signal. More...

Ptr< SpectrumPhy >	txPhy
	The SpectrumPhy instance that is making the transmission. More...

Detailed Description

This struct provides the generic signal representation to be used by all wireless technologies.

Any specific wireless technology is allowed to define additional signal parameters by inheriting from this struct and providing additional member variables. This makes sure that a minimum set of parameters (in particular, the ones needed for interference calculation) is common across all wireless technologies, while at the same time allowing each technology to have its own specific signal parameters.

Furthermore, since the signal parameters specific of every technology inherit directly from this struct, each PHY can test (by using a dynamic cast) if a signal being received belongs to a given technology or not.

Note: when inheriting from this class, make sure that the assignment operator and the copy constructor work properly, making deep copies if needed.

Definition at line 52 of file spectrum-signal-parameters.h.

Constructor & Destructor Documentation

◆ SpectrumSignalParameters() [1/2]

ns3::SpectrumSignalParameters::SpectrumSignalParameters ( )

default constructor

Definition at line 33 of file spectrum-signal-parameters.cc.

References NS_LOG_FUNCTION.

◆ ~SpectrumSignalParameters()

ns3::SpectrumSignalParameters::~SpectrumSignalParameters ( )

virtual

destructor

Definition at line 38 of file spectrum-signal-parameters.cc.

References NS_LOG_FUNCTION.

◆ SpectrumSignalParameters() [2/2]

ns3::SpectrumSignalParameters::SpectrumSignalParameters ( const SpectrumSignalParameters & p )

copy constructor

Parameters

p	object to copy

Definition at line 43 of file spectrum-signal-parameters.cc.

References ns3::SpectrumValue::Copy(), duration, NS_LOG_FUNCTION, precodingMatrix, psd, spectrumChannelMatrix, txAntenna, and txPhy.

Here is the call graph for this function:

Member Function Documentation

◆ Copy()

Ptr< SpectrumSignalParameters > ns3::SpectrumSignalParameters::Copy ( void ) const

virtual

make a "virtual" copy of this class, where "virtual" refers to the fact that if the actual object is a derived class of SpectrumSignalParameters, then the copy is also a derived class of the same type.

Each class inheriting from SpectrumSignalParameters should override this method and use it to call the copy constructor of the derived class.

Returns: a copy of the (possibly derived) class

Reimplemented in ns3::WifiSpectrumSignalParameters, ns3::HalfDuplexIdealPhySignalParameters, ns3::LteSpectrumSignalParametersUlSrsFrame, ns3::LteSpectrumSignalParametersDlCtrlFrame, ns3::LteSpectrumSignalParametersDataFrame, ns3::LteSpectrumSignalParameters, and ns3::LrWpanSpectrumSignalParameters.

Definition at line 57 of file spectrum-signal-parameters.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::MultiModelSpectrumChannel::StartTx(), and ns3::SingleModelSpectrumChannel::StartTx().

Here is the caller graph for this function:

Member Data Documentation

◆ duration

Time ns3::SpectrumSignalParameters::duration

The duration of the packet transmission.

It is assumed that the Power Spectral Density remains constant for the whole duration of the transmission. In other words, all waveform have a rect shape with respect to time.

Definition at line 102 of file spectrum-signal-parameters.h.

Referenced by SpectrumSignalParameters(), ns3::WaveformGenerator::GenerateWaveform(), WifiPhyThresholdsTest::MakeForeignSignal(), ns3::TvSpectrumTransmitter::SetupTx(), ns3::LrWpanPhy::StartRx(), ns3::LteSpectrumPhy::StartRx(), ns3::LteSimpleSpectrumPhy::StartRx(), ns3::HalfDuplexIdealPhy::StartRx(), ns3::SpectrumWifiPhy::StartRx(), and ns3::SingleModelSpectrumChannel::StartTx().

◆ precodingMatrix

Ptr<const ComplexMatrixArray> ns3::SpectrumSignalParameters::precodingMatrix

The 3D precoding matrix where the dimensions are: the number of TX ports, the number of TX streams, the number of RBs.

Definition at line 126 of file spectrum-signal-parameters.h.

Referenced by SpectrumSignalParameters(), and ns3::ThreeGppSpectrumPropagationLossModel::CalcBeamformingGain().

◆ psd

Ptr<SpectrumValue> ns3::SpectrumSignalParameters::psd

The Power Spectral Density of the waveform, in linear units.

The exact unit will depend on the type of transmission medium involved: W for radio communications, Pa for underwater acoustic communications. Other transmission media to be defined.

Note: when SpectrumSignalParameters is copied, only the pointer to the PSD will be copied. This is because SpectrumChannel objects normally overwrite the psd anyway, so there is no point in making a copy.

Definition at line 94 of file spectrum-signal-parameters.h.

Referenced by SpectrumSignalParameters(), ns3::ThreeGppSpectrumPropagationLossModel::CalcBeamformingGain(), ComputeEndToEndGain(), ComputeSnr(), ns3::TwoRaySpectrumPropagationLossModel::DoCalcRxPowerSpectralDensity(), ThreeGppSpectrumPropagationLossModelTest::DoRun(), OverallGainAverageTest::DoRun(), ns3::LrWpanPhy::EndRx(), ns3::WaveformGenerator::GenerateWaveform(), WifiPhyThresholdsTest::MakeForeignSignal(), ns3::TvSpectrumTransmitter::SetupTx(), ns3::LrWpanPhy::StartRx(), ns3::LteSpectrumPhy::StartRx(), ns3::LteSimpleSpectrumPhy::StartRx(), ns3::HalfDuplexIdealPhy::StartRx(), ns3::SpectrumWifiPhy::StartRx(), ns3::MultiModelSpectrumChannel::StartTx(), ns3::SingleModelSpectrumChannel::StartTx(), and Bug2843TestCase::StoreDistinctTuple().