fading loss model based on precalculated fading traces More...

#include "trace-fading-loss-model.h"

Inheritance diagram for ns3::TraceFadingLossModel:

Collaboration diagram for ns3::TraceFadingLossModel:

Public Types
typedef std::pair< Ptr< const MobilityModel >, Ptr< const MobilityModel > >	ChannelRealizationId_t
	The couple of mobility node that form a fading channel realization. More...

Public Member Functions
	TraceFadingLossModel ()

virtual	~TraceFadingLossModel ()

int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this model. More...

virtual void	DoInitialize (void)
	Initialize() implementation. 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<>
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 ()
	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 Types
typedef std::vector< FadingTraceSample >	FadingTrace
	Vector collecting the time fading traces in the frequency domain (per RB) More...

typedef std::vector< double >	FadingTraceSample
	Vector with fading samples in time domain (for a fixed RB) More...

Private Member Functions
Ptr< SpectrumValue >	DoCalcRxPowerSpectralDensity (Ptr< const SpectrumValue > txPsd, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const

double	GetValue (int subChannel, double speed)
	Get the value for a particular sub channel and a given speed. More...

void	LoadTrace ()
	Load trace function. More...

void	SetTraceFileName (std::string fileName)
	Set the trace file name. More...

void	SetTraceLength (Time t)
	Set the trace time. More...

Private Attributes
uint64_t	m_currentStream
	the current stream More...

FadingTrace	m_fadingTrace
	fading trace More...

uint64_t	m_lastStream
	the last stream More...

Time	m_lastWindowUpdate
	time of last window update More...

uint8_t	m_rbNum
	RB number. More...

uint32_t	m_samplesNum
	number of samples More...

std::map< ChannelRealizationId_t, Ptr< UniformRandomVariable > >	m_startVariableMap
	start variable map More...

bool	m_streamsAssigned
	is streams assigned? More...

uint64_t	m_streamSetSize
	stream set size More...

uint8_t	m_timeGranularity
	time granularity More...

std::string	m_traceFile
	the trace file name More...

Time	m_traceLength
	the trace time More...

std::map< ChannelRealizationId_t, int >	m_windowOffsetsMap
	windows offsets map More...

Time	m_windowSize
	window size More...

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

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

fading loss model based on precalculated fading traces

Introspection did not find any typical Config paths.

Attributes

TraceFilename: Name of file to load a trace from.
- Set with class: StringValue
- Underlying type:
- Initial value:
- Flags: construct write
TraceLength: The total length of the fading trace (default value 10 s.)
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +1e+10ns
- Flags: construct write
SamplesNum: The number of samples the trace is made of (default 10000)
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 10000
- Flags: construct write read
WindowSize: The size of the window for the fading trace (default value 0.5 s.)
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +5e+08ns
- Flags: construct write read
RbNum: The number of RB the trace is made of (default 100)
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 100
- Flags: construct write read
RngStreamSetSize: The number of RNG streams reserved for the fading model. The maximum number of streams that are needed for an LTE FDD scenario is 2 * numUEs * numeNBs.
- Set with class: ns3::UintegerValue
- Underlying type: uint64_t 0:18446744073709551615
- Initial value: 200000
- Flags: construct write read

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

Definition at line 44 of file trace-fading-loss-model.h.

Member Typedef Documentation

◆ ChannelRealizationId_t

typedef std::pair<Ptr<const MobilityModel>, Ptr<const MobilityModel> > ns3::TraceFadingLossModel::ChannelRealizationId_t

The couple of mobility node that form a fading channel realization.

Definition at line 61 of file trace-fading-loss-model.h.

◆ FadingTrace

typedef std::vector<FadingTraceSample> ns3::TraceFadingLossModel::FadingTrace

private

Vector collecting the time fading traces in the frequency domain (per RB)

Definition at line 122 of file trace-fading-loss-model.h.

◆ FadingTraceSample

typedef std::vector<double> ns3::TraceFadingLossModel::FadingTraceSample

private

Vector with fading samples in time domain (for a fixed RB)

Definition at line 118 of file trace-fading-loss-model.h.

Constructor & Destructor Documentation

◆ TraceFadingLossModel()

ns3::TraceFadingLossModel::TraceFadingLossModel ( )

Definition at line 41 of file trace-fading-loss-model.cc.

References NS_LOG_FUNCTION, and ns3::SpectrumPropagationLossModel::SetNext().

Here is the call graph for this function:

◆ ~TraceFadingLossModel()

ns3::TraceFadingLossModel::~TraceFadingLossModel ( )

virtual

Definition at line 49 of file trace-fading-loss-model.cc.

References m_fadingTrace, m_startVariableMap, and m_windowOffsetsMap.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::TraceFadingLossModel::AssignStreams ( int64_t stream )

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Definition at line 237 of file trace-fading-loss-model.cc.

References m_currentStream, m_lastStream, m_startVariableMap, m_streamsAssigned, m_streamSetSize, NS_ASSERT, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

◆ DoCalcRxPowerSpectralDensity()

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

privatevirtual

Parameters

txPsd	set of values vs frequency representing the transmission power. See SpectrumChannel for details.
a	sender mobility
b	receiver mobility

Returns: set of values vs frequency representing the received power in the same units used for the txPsd parameter.

Implements ns3::SpectrumPropagationLossModel.

Definition at line 151 of file trace-fading-loss-model.cc.

References ns3::Time::GetMilliSeconds(), ns3::Time::GetSeconds(), ns3::UniformRandomVariable::GetValue(), m_currentStream, m_fadingTrace, m_lastStream, m_lastWindowUpdate, m_samplesNum, m_startVariableMap, m_streamsAssigned, m_timeGranularity, m_traceLength, m_windowOffsetsMap, m_windowSize, ns3::Simulator::Now(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ns3::ObjectBase::SetAttribute(), ns3::RandomVariableStream::SetStream(), ns3::SpectrumValue::ValuesBegin(), and ns3::SpectrumValue::ValuesEnd().

Here is the call graph for this function:

◆ DoInitialize()

void ns3::TraceFadingLossModel::DoInitialize ( void )

virtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 113 of file trace-fading-loss-model.cc.

References LoadTrace().

Here is the call graph for this function: