Implementation for a single path Stationary Jakes propagation loss model. More...

#include "jakes-process.h"

Inheritance diagram for ns3::JakesProcess:

Collaboration diagram for ns3::JakesProcess:

Classes
struct	Oscillator
	This class Represents a single oscillator. More...

Public Member Functions
	JakesProcess ()

	~JakesProcess () override

double	GetChannelGainDb () const
	Get the channel gain in dB.

std::complex< double >	GetComplexGain () const
	Get the channel complex gain.

void	SetPropagationLossModel (Ptr< const PropagationLossModel > model)
	Set the propagation model using this class.

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

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

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.

Private Member Functions
void	ConstructOscillators ()
	Builds the object Oscillators.

void	SetDopplerFrequencyHz (double dopplerFrequencyHz)
	Set the Doppler frequency.

void	SetNOscillators (unsigned int nOscillators)
	Set the number of Oscillators to use.

Private Attributes
Ptr< const JakesPropagationLossModel >	m_jakes
	pointer to the propagation loss model

unsigned int	m_nOscillators
	number of oscillators

double	m_omegaDopplerMax
	max rotation speed Doppler frequency

std::vector< Oscillator >	m_oscillators
	Vector of oscillators.

Ptr< UniformRandomVariable >	m_uniformVariable
	random stream

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

Implementation for a single path Stationary Jakes propagation loss model.

Introspection did not find any typical Config paths

The Jakes propagation loss model implemented here is described in [1].

We consider one transmitter - receiver pair and calculate the complex coefficients for this case as follow:

$X(t)=X_c(t) + j X_s(t)$

$X_c(t) = \frac{2}{\sqrt{M}}\sum_{n=1}^{M}\cos(\psi_n)\cos(\omega_d t\cos(\alpha_n)+\phi_n)$

$X_s(t) = \frac{2}{\sqrt{M}}\sum_{n=1}^{M}\sin(\psi_n)\cos(\omega_d t\cos(\alpha_n)+\phi_n)$

with

$\alpha_n = \frac{2\pi n - \pi + \theta}{4M}, n=1,2, \ldots,M$

where $\theta$ , $\phi$ , and $\psi_n$ are statically independent and uniformly distributed over $[-\pi, \pi)$ for all $n$ .

[1] Y. R. Zheng and C. Xiao, "Simulation Models With Correct Statistical Properties for Rayleigh Fading Channel", IEEE Trans. on Communications, Vol. 51, pp 920-928, June 2003

Attributes

DopplerFrequencyHz: Corresponding doppler frequency[Hz]
- Set with class: ns3::DoubleValue
- Underlying type: double 0:10000
- Initial value: 80
- Flags: constructwrite
- Support level: SUPPORTED
NumberOfOscillators: The number of oscillators
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 4:1000
- Initial value: 20
- Flags: constructwrite
- Support level: SUPPORTED

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

Definition at line 45 of file jakes-process.h.

Constructor & Destructor Documentation

◆ JakesProcess()

ns3::JakesProcess::JakesProcess ( )

Definition at line 114 of file jakes-process.cc.

References m_nOscillators, and m_omegaDopplerMax.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ ~JakesProcess()

ns3::JakesProcess::~JakesProcess ( )

override

Definition at line 120 of file jakes-process.cc.

References m_oscillators.

Member Function Documentation

◆ ConstructOscillators()

void ns3::JakesProcess::ConstructOscillators ( )

private

Builds the object Oscillators.

Rotation speed 1a. Initiate
$\alpha_n = \frac{2\pi n - \pi + \theta}{4M}, n=1,2, \ldots,M$
, n is oscillatorNumber, M is m_nOscillators

1b. Initiate rotation speed:

Initiate complex amplitude:

Construct oscillator:

Definition at line 89 of file jakes-process.cc.

References m_jakes, m_nOscillators, m_omegaDopplerMax, m_oscillators, and NS_ASSERT.

Referenced by SetPropagationLossModel().

Here is the caller graph for this function:

◆ DoDispose()

void ns3::JakesProcess::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 126 of file jakes-process.cc.

References m_jakes, and m_uniformVariable.

◆ GetChannelGainDb()

double ns3::JakesProcess::GetChannelGainDb ( ) const

Get the channel gain in dB.

Returns: the channel gain [dB]

Definition at line 144 of file jakes-process.cc.

References GetComplexGain().

Here is the call graph for this function:

◆ GetComplexGain()

std::complex< double > ns3::JakesProcess::GetComplexGain ( ) const

Get the channel complex gain.

Returns: the channel complex gain

Definition at line 133 of file jakes-process.cc.

References m_oscillators, and ns3::Now().

Referenced by GetChannelGainDb().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::JakesProcess::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 43 of file jakes-process.cc.

References JakesProcess(), ns3::Object::Object(), ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), SetDopplerFrequencyHz(), SetNOscillators(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ SetDopplerFrequencyHz()

void ns3::JakesProcess::SetDopplerFrequencyHz ( double dopplerFrequencyHz )

private

Set the Doppler frequency.

Parameters

dopplerFrequencyHz the Doppler frequency [Hz]

Definition at line 83 of file jakes-process.cc.

References m_omegaDopplerMax.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetNOscillators()

void ns3::JakesProcess::SetNOscillators ( unsigned int nOscillators )

private

Set the number of Oscillators to use.

Parameters

nOscillators the number of oscillators

Definition at line 77 of file jakes-process.cc.

References m_nOscillators.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetPropagationLossModel()

void ns3::JakesProcess::SetPropagationLossModel ( Ptr< const PropagationLossModel > model )

Set the propagation model using this class.

Parameters

model the propagation model using this class

Definition at line 63 of file jakes-process.cc.

References ConstructOscillators(), m_jakes, m_nOscillators, m_omegaDopplerMax, NS_ASSERT, and NS_ASSERT_MSG.

Here is the call graph for this function:

Member Data Documentation

◆ m_jakes

Ptr<const JakesPropagationLossModel> ns3::JakesProcess::m_jakes

private

pointer to the propagation loss model

Definition at line 125 of file jakes-process.h.

Referenced by ConstructOscillators(), DoDispose(), and SetPropagationLossModel().

◆ m_nOscillators

unsigned int ns3::JakesProcess::m_nOscillators

private

number of oscillators

Definition at line 123 of file jakes-process.h.

Referenced by JakesProcess(), ConstructOscillators(), SetNOscillators(), and SetPropagationLossModel().

◆ m_omegaDopplerMax

double ns3::JakesProcess::m_omegaDopplerMax

private

max rotation speed Doppler frequency

Definition at line 122 of file jakes-process.h.

Referenced by JakesProcess(), ConstructOscillators(), SetDopplerFrequencyHz(), and SetPropagationLossModel().

◆ m_oscillators

std::vector<Oscillator> ns3::JakesProcess::m_oscillators

private

Vector of oscillators.

Definition at line 121 of file jakes-process.h.

Referenced by ~JakesProcess(), ConstructOscillators(), and GetComplexGain().

◆ m_uniformVariable

Ptr<UniformRandomVariable> ns3::JakesProcess::m_uniformVariable

private

random stream

Definition at line 124 of file jakes-process.h.

Referenced by DoDispose().

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

src/propagation/model/jakes-process.h
src/propagation/model/jakes-process.cc

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Constructor & Destructor Documentation

◆ JakesProcess()

◆ ~JakesProcess()

Member Function Documentation

◆ ConstructOscillators()

◆ DoDispose()

◆ GetChannelGainDb()

◆ GetComplexGain()

◆ GetTypeId()

◆ SetDopplerFrequencyHz()

◆ SetNOscillators()

◆ SetPropagationLossModel()

Member Data Documentation

◆ m_jakes

◆ m_nOscillators

◆ m_omegaDopplerMax

◆ m_oscillators

◆ m_uniformVariable