A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::JakesProcess Class Reference

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 ()
double GetChannelGainDb () const
 Get Channel gain [dB].
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)
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 Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
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)
 This method returns the TypeId associated to ns3::JakesProcess.

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< UniformRandomVariablem_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 DoStart (void)
virtual void NotifyNewAggregate (void)

Detailed Description

Implementation for a single path Stationary Jakes propagation loss model.

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

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

Constructor & Destructor Documentation

ns3::JakesProcess::JakesProcess ( )

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

ns3::JakesProcess::~JakesProcess ( )
virtual

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

Member Function Documentation

void ns3::JakesProcess::ConstructOscillators ( )
private
  1. 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:

  1. Initiate complex amplitude:
  1. Construct oscillator:

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

References ns3::JakesPropagationLossModel::GetUniformRandomVariable(), ns3::UniformRandomVariable::GetValue(), m_jakes, m_nOscillators, NS_ASSERT, and ns3::JakesPropagationLossModel::PI.

Referenced by SetPropagationLossModel().

+ Here is the call graph for this function:

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

References m_jakes.

double ns3::JakesProcess::GetChannelGainDb ( ) const

Get Channel gain [dB].

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

References GetComplexGain().

Referenced by ns3::JakesPropagationLossModel::DoCalcRxPower().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

References ns3::Now().

Referenced by GetChannelGainDb().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

TypeId ns3::JakesProcess::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::JakesProcess.

Attributes defined for this type:

  • DopplerFrequencyHz: Corresponding doppler frequency[Hz]
  • NumberOfOscillators: The number of oscillators

No TraceSources defined for this type.

Reimplemented from ns3::Object.

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

References SetDopplerFrequencyHz(), SetNOscillators(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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

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

References ns3::JakesPropagationLossModel::PI.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

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

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

References m_nOscillators.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

void ns3::JakesProcess::SetPropagationLossModel ( Ptr< const PropagationLossModel propagationModel)

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

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

Referenced by ns3::JakesPropagationLossModel::DoCalcRxPower().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

name ns3::JakesProcess::Attributes
private

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

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

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

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

unsigned int ns3::JakesProcess::m_nOscillators
private

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

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

Ptr<UniformRandomVariable> ns3::JakesProcess::m_uniformVariable
private

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

Vector of ns3::JakesProcess::oscillators
private

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


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