Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
ns3::SatRayleighConf Class Reference

A configuration class for Rayleigh model fader. More...

#include "satellite-rayleigh-conf.h"

+ Inheritance diagram for ns3::SatRayleighConf:
+ Collaboration diagram for ns3::SatRayleighConf:

Public Member Functions

 SatRayleighConf ()
 Constructor. More...
 
 ~SatRayleighConf ()
 Destructor. More...
 
void DoDispose ()
 Do needed dispose actions. More...
 
std::vector< std::vector< double > > GetParameters (uint32_t set)
 Function for getting the Rayleigh parameters. More...
 
- Public Member Functions inherited from ns3::SatBaseFaderConf
 SatBaseFaderConf ()
 Constructor. More...
 
virtual ~SatBaseFaderConf ()
 Destructor. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 NS-3 function for type id. More...
 
- Static Public Member Functions inherited from ns3::SatBaseFaderConf
static TypeId GetTypeId (void)
 NS-3 type id function. More...
 

Static Public Attributes

static const uint32_t DEFAULT_RAYLEIGH_PARAMETER_COUNT = 2
 Default Rayleigh parameter count. More...
 

Private Member Functions

void Reset ()
 Clear used variables. More...
 

Private Attributes

uint32_t m_elevationCount
 Number of parameters sets. More...
 
std::vector< std::vector< std::vector< double > > > m_rayleighParameters
 Rayleigh model parameters. More...
 
uint32_t m_stateCount
 Number of states. More...
 

Detailed Description

A configuration class for Rayleigh model fader.

The class provides configuration parameters for Rayleigh fader used with Markov-based fading model.

Definition at line 36 of file satellite-rayleigh-conf.h.

Constructor & Destructor Documentation

◆ SatRayleighConf()

ns3::SatRayleighConf::SatRayleighConf ( )

Constructor.

Definition at line 67 of file satellite-rayleigh-conf.cc.

References DEFAULT_RAYLEIGH_PARAMETER_COUNT, ns3::g_RayleighParameters, m_elevationCount, m_rayleighParameters, and m_stateCount.

◆ ~SatRayleighConf()

ns3::SatRayleighConf::~SatRayleighConf ( )

Destructor.

Definition at line 91 of file satellite-rayleigh-conf.cc.

References Reset().

+ Here is the call graph for this function:

Member Function Documentation

◆ DoDispose()

void ns3::SatRayleighConf::DoDispose ( void  )

Do needed dispose actions.

Definition at line 126 of file satellite-rayleigh-conf.cc.

References Reset().

+ Here is the call graph for this function:

◆ GetParameters()

std::vector< std::vector< double > > ns3::SatRayleighConf::GetParameters ( uint32_t  set)
virtual

Function for getting the Rayleigh parameters.

Parameters
setparameter set
Returns
Rayleigh parameter values

Implements ns3::SatBaseFaderConf.

Definition at line 99 of file satellite-rayleigh-conf.cc.

References m_elevationCount, and m_rayleighParameters.

◆ GetTypeId()

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

NS-3 function for type id.

Returns

Definition at line 49 of file satellite-rayleigh-conf.cc.

References ns3::SatMarkovConf::DEFAULT_ELEVATION_COUNT, ns3::SatMarkovConf::DEFAULT_STATE_COUNT, m_elevationCount, and m_stateCount.

◆ Reset()

void ns3::SatRayleighConf::Reset ( void  )
private

Clear used variables.

Definition at line 112 of file satellite-rayleigh-conf.cc.

References m_elevationCount, m_rayleighParameters, and m_stateCount.

Referenced by ~SatRayleighConf(), and DoDispose().

+ Here is the caller graph for this function:

Member Data Documentation

◆ DEFAULT_RAYLEIGH_PARAMETER_COUNT

const uint32_t ns3::SatRayleighConf::DEFAULT_RAYLEIGH_PARAMETER_COUNT = 2
static

Default Rayleigh parameter count.

Definition at line 42 of file satellite-rayleigh-conf.h.

Referenced by SatRayleighConf().

◆ m_elevationCount

uint32_t ns3::SatRayleighConf::m_elevationCount
private

Number of parameters sets.

Definition at line 81 of file satellite-rayleigh-conf.h.

Referenced by SatRayleighConf(), GetParameters(), GetTypeId(), and Reset().

◆ m_rayleighParameters

std::vector<std::vector<std::vector<double> > > ns3::SatRayleighConf::m_rayleighParameters
private

Rayleigh model parameters.

Definition at line 91 of file satellite-rayleigh-conf.h.

Referenced by SatRayleighConf(), GetParameters(), and Reset().

◆ m_stateCount

uint32_t ns3::SatRayleighConf::m_stateCount
private

Number of states.

Definition at line 86 of file satellite-rayleigh-conf.h.

Referenced by SatRayleighConf(), GetTypeId(), and Reset().

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