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.

Public Member Functions
	TraceFadingLossModel ()

	~TraceFadingLossModel () override

void	DoInitialize () override
	Initialize() implementation.

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

	~SpectrumPropagationLossModel () 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'.

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

Ptr< SpectrumPropagationLossModel >	GetNext () const
	Return the pointer to the next SpectrumPropagationLossModel, if any.

void	SetNext (Ptr< SpectrumPropagationLossModel > next)
	Used to chain various instances of SpectrumPropagationLossModel.

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, bool permissive=false) 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.

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::SpectrumPropagationLossModel
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
int64_t	DoAssignStreams (int64_t stream) override
	Assign a fixed random variable stream number to the random variables used by this model.

Protected Member Functions inherited from ns3::SpectrumPropagationLossModel
void	DoDispose () override
	Destructor implementation.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

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.

Private Types
typedef std::vector< FadingTraceSample >	FadingTrace
	Vector collecting the time fading traces in the frequency domain (per RB)

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

Private Member Functions
Ptr< SpectrumValue >	DoCalcRxPowerSpectralDensity (Ptr< const SpectrumSignalParameters > params, Ptr< const MobilityModel > a, Ptr< const MobilityModel > b) const override

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

void	LoadTrace ()
	Load trace function.

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

void	SetTraceLength (Time t)
	Set the trace time.

Private Attributes
uint64_t	m_currentStream
	the current stream

FadingTrace	m_fadingTrace
	fading trace

uint64_t	m_lastStream
	the last stream

Time	m_lastWindowUpdate
	time of last window update

uint32_t	m_rbNum
	RB number.

uint32_t	m_samplesNum
	number of samples

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

bool	m_streamsAssigned
	is streams assigned?

uint64_t	m_streamSetSize
	stream set size

uint32_t	m_timeGranularity
	time granularity

std::string	m_traceFile
	the trace file name

Time	m_traceLength
	the trace time

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

Time	m_windowSize
	window size

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

Detailed Description

fading loss model based on precalculated fading traces

Definition at line 31 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 48 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 99 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 95 of file trace-fading-loss-model.h.

Constructor & Destructor Documentation

◆ TraceFadingLossModel()

ns3::TraceFadingLossModel::TraceFadingLossModel ( )

Definition at line 31 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 ( )

override

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

References m_fadingTrace, m_startVariableMap, and m_windowOffsetsMap.

Member Function Documentation

◆ DoAssignStreams()

int64_t ns3::TraceFadingLossModel::DoAssignStreams ( int64_t stream )

overrideprotectedvirtual

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

Definition at line 230 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 SpectrumSignalParameters >	params,
		Ptr< const MobilityModel >	a,
		Ptr< const MobilityModel >	b ) const

overrideprivatevirtual

Parameters

params	the spectrum signal parameters.
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 139 of file trace-fading-loss-model.cc.

References ns3::Copy(), ns3::CreateObject(), ns3::Time::GetMilliSeconds(), ns3::Time::GetSeconds(), 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, and NS_LOG_LOGIC.

Here is the call graph for this function:

◆ DoInitialize()

void ns3::TraceFadingLossModel::DoInitialize ( )

overridevirtual

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 103 of file trace-fading-loss-model.cc.

References LoadTrace().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::TraceFadingLossModel::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References m_rbNum, m_samplesNum, m_streamSetSize, m_windowSize, ns3::MakeStringAccessor(), ns3::MakeStringChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ns3::Seconds(), ns3::TypeId::SetParent(), SetTraceFileName(), and SetTraceLength().

Here is the call graph for this function:

◆ GetValue()

double ns3::TraceFadingLossModel::GetValue	(	int	subChannel,
		double	speed )

private

Get the value for a particular sub channel and a given speed.

Parameters

subChannel	the sub channel for which a value is requested
speed	the relative speed of the two devices

Returns: the loss for a particular sub channel

◆ LoadTrace()

void ns3::TraceFadingLossModel::LoadTrace ( )

private

Load trace function.

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

References ns3::Time::GetMilliSeconds(), m_fadingTrace, m_lastWindowUpdate, m_rbNum, m_samplesNum, m_timeGranularity, m_traceFile, m_traceLength, ns3::Simulator::Now(), NS_ASSERT_MSG, NS_LOG_FUNCTION, and NS_LOG_INFO.

Referenced by DoInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTraceFileName()

void ns3::TraceFadingLossModel::SetTraceFileName ( std::string fileName )

private

Set the trace file name.

Parameters

fileName the trace file

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

References m_traceFile, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetTraceLength()

void ns3::TraceFadingLossModel::SetTraceLength ( Time t )

private

Set the trace time.

Parameters

t	the trace time

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

References m_traceLength.

Referenced by GetTypeId().

Here is the caller graph for this function:

Member Data Documentation

◆ m_currentStream

uint64_t ns3::TraceFadingLossModel::m_currentStream

mutableprivate

the current stream

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

Referenced by DoAssignStreams(), and DoCalcRxPowerSpectralDensity().

◆ m_fadingTrace

FadingTrace ns3::TraceFadingLossModel::m_fadingTrace

private

fading trace

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

Referenced by ~TraceFadingLossModel(), DoCalcRxPowerSpectralDensity(), and LoadTrace().

◆ m_lastStream

uint64_t ns3::TraceFadingLossModel::m_lastStream

mutableprivate

the last stream

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

Referenced by DoAssignStreams(), and DoCalcRxPowerSpectralDensity().

◆ m_lastWindowUpdate

Time ns3::TraceFadingLossModel::m_lastWindowUpdate

mutableprivate

time of last window update

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

Referenced by DoCalcRxPowerSpectralDensity(), and LoadTrace().

◆ m_rbNum

uint32_t ns3::TraceFadingLossModel::m_rbNum

private

RB number.

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

Referenced by GetTypeId(), and LoadTrace().

◆ m_samplesNum

uint32_t ns3::TraceFadingLossModel::m_samplesNum

private

number of samples

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

Referenced by DoCalcRxPowerSpectralDensity(), GetTypeId(), and LoadTrace().

◆ m_startVariableMap

std::map<ChannelRealizationId_t, Ptr<UniformRandomVariable> > ns3::TraceFadingLossModel::m_startVariableMap

mutableprivate

start variable map

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

Referenced by ~TraceFadingLossModel(), DoAssignStreams(), and DoCalcRxPowerSpectralDensity().

◆ m_streamsAssigned

bool ns3::TraceFadingLossModel::m_streamsAssigned

mutableprivate

is streams assigned?

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

Referenced by DoAssignStreams(), and DoCalcRxPowerSpectralDensity().

◆ m_streamSetSize

uint64_t ns3::TraceFadingLossModel::m_streamSetSize

private

stream set size

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

Referenced by DoAssignStreams(), and GetTypeId().

◆ m_timeGranularity

uint32_t ns3::TraceFadingLossModel::m_timeGranularity

private

time granularity

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

Referenced by DoCalcRxPowerSpectralDensity(), and LoadTrace().

◆ m_traceFile

std::string ns3::TraceFadingLossModel::m_traceFile

private

the trace file name

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

Referenced by LoadTrace(), and SetTraceFileName().

◆ m_traceLength

Time ns3::TraceFadingLossModel::m_traceLength

private

the trace time

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

Referenced by DoCalcRxPowerSpectralDensity(), LoadTrace(), and SetTraceLength().

◆ m_windowOffsetsMap

std::map<ChannelRealizationId_t, int> ns3::TraceFadingLossModel::m_windowOffsetsMap

mutableprivate

windows offsets map

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

Referenced by ~TraceFadingLossModel(), and DoCalcRxPowerSpectralDensity().

◆ m_windowSize

Time ns3::TraceFadingLossModel::m_windowSize

private

window size

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

Referenced by DoCalcRxPowerSpectralDensity(), and GetTypeId().

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

src/spectrum/model/trace-fading-loss-model.h
src/spectrum/model/trace-fading-loss-model.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ChannelRealizationId_t

◆ FadingTrace

◆ FadingTraceSample

Constructor & Destructor Documentation

◆ TraceFadingLossModel()

◆ ~TraceFadingLossModel()

Member Function Documentation

◆ DoAssignStreams()

◆ DoCalcRxPowerSpectralDensity()

◆ DoInitialize()

◆ GetTypeId()

◆ GetValue()

◆ LoadTrace()

◆ SetTraceFileName()

◆ SetTraceLength()

Member Data Documentation

◆ m_currentStream

◆ m_fadingTrace

◆ m_lastStream

◆ m_lastWindowUpdate

◆ m_rbNum

◆ m_samplesNum

◆ m_startVariableMap

◆ m_streamsAssigned

◆ m_streamSetSize

◆ m_timeGranularity

◆ m_traceFile

◆ m_traceLength

◆ m_windowOffsetsMap

◆ m_windowSize