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
	Represents a single oscillator. More...

Public Member Functions
	JakesProcess ()

virtual	~JakesProcess ()

virtual void	DoDispose ()
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

double	GetChannelGainDb () const
	Get Channel gain [dB]. More...

std::complex< double >	GetComplexGain () const

void	SetPropagationLossModel (Ptr< const PropagationLossModel >)

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

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	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. 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

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Member Functions
void	ConstructOscillators ()

void	SetDopplerFrequencyHz (double dopplerFrequencyHz)

void	SetNOscillators (unsigned int nOscillators)

Private Attributes
name	Attributes: \{ double m_omegaDopplerMax

Ptr< const JakesPropagationLossModel >	m_jakes

unsigned int	m_nOscillators

Ptr< UniformRandomVariable >	m_uniformVariable

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

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

Implementation for a single path Stationary Jakes propagation loss model.

Doxygen 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: construct write
NumberOfOscillators: The number of oscillators
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 4:1000
- Initial value: 20
- Flags: construct write

No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::JakesProcess::JakesProcess ( )

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

ns3::JakesProcess::~JakesProcess ( )

virtual

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

Member Function Documentation

void ns3::JakesProcess::ConstructOscillators ( )

private

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 93 of file jakes-process.cc.

References m_jakes, m_nOscillators, NS_ASSERT, and ns3::JakesPropagationLossModel::PI.

Referenced by SetPropagationLossModel().

Here is the caller graph for this function:

void ns3::JakesProcess::DoDispose ( void )

virtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden 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 128 of file jakes-process.cc.

References m_jakes.

double ns3::JakesProcess::GetChannelGainDb ( ) const

Get Channel gain [dB].

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

References GetComplexGain().

Here is the call graph for this function: