ns3::SatBaseFading Class Referenceabstract

Base class for fading models such as Markov-based fading or fading trace. More...

#include "satellite-base-fading.h"

+ Inheritance diagram for ns3::SatBaseFading:
+ Collaboration diagram for ns3::SatBaseFading:

Public Types

typedef Callback< double > ElevationCallback
 Gets elevation angle in degrees. More...
 
typedef Callback< double > VelocityCallback
 Gets velocity in m/s. More...
 

Public Member Functions

 SatBaseFading ()
 Constructor. More...
 
virtual ~SatBaseFading ()
 Destructor. More...
 
virtual double DoGetFading (Address macAddress, SatEnums::ChannelType_t channelType)=0
 Function for getting the fading value. More...
 
double GetFading (Address macAddress, SatEnums::ChannelType_t channelType)
 Function for getting the fading value. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 NS-3 type id function. More...
 

Detailed Description

Base class for fading models such as Markov-based fading or fading trace.

This class defines the functions which all the different fading models must implement for the fading interface. This base class itself is abstract and will not implement any real functionality.

Definition at line 42 of file satellite-base-fading.h.

Member Typedef Documentation

◆ ElevationCallback

typedef Callback<double> ns3::SatBaseFading::ElevationCallback

Gets elevation angle in degrees.

Definition at line 48 of file satellite-base-fading.h.

◆ VelocityCallback

typedef Callback<double> ns3::SatBaseFading::VelocityCallback

Gets velocity in m/s.

Definition at line 53 of file satellite-base-fading.h.

Constructor & Destructor Documentation

◆ SatBaseFading()

ns3::SatBaseFading::SatBaseFading ( )

Constructor.

Definition at line 39 of file satellite-base-fading.cc.

◆ ~SatBaseFading()

ns3::SatBaseFading::~SatBaseFading ( )
virtual

Destructor.

Definition at line 44 of file satellite-base-fading.cc.

Member Function Documentation

◆ DoGetFading()

virtual double ns3::SatBaseFading::DoGetFading ( Address  macAddress,
SatEnums::ChannelType_t  channelType 
)
pure virtual

Function for getting the fading value.

This is an abstract method, thus it is implemented in the inherited fading classes.

Parameters
macAddress
channelTypechannel type
Returns
fading value

Implemented in ns3::SatMarkovContainer, and ns3::SatFadingInputTrace.

Referenced by GetFading().

+ Here is the caller graph for this function:

◆ GetFading()

double ns3::SatBaseFading::GetFading ( Address  macAddress,
SatEnums::ChannelType_t  channelType 
)

Function for getting the fading value.

Parameters
macAddress
channelTypechannel type
Returns
fading value

Definition at line 50 of file satellite-base-fading.cc.

References DoGetFading().

+ Here is the call graph for this function:

◆ GetTypeId()

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

NS-3 type id function.

Returns
type id

Definition at line 33 of file satellite-base-fading.cc.


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