A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Classes | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::JakesProcess Class Reference

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

#include <jakes-process.h>

+ Inheritance diagram for ns3::JakesProcess:

Classes

struct  Oscillator
 Represents a single oscillator. More...
 

Public Member Functions

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
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 Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::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)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

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)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (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

Doxygen introspection did not find any typical Config paths.

Attributes

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

No TraceSources are defined for this type.

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

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:
  2. Construct oscillator:

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

References NS_ASSERT.

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.

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