ns3::SatFadingOscillator Class Reference

Oscillator class for faders. More...

#include "satellite-fading-oscillator.h"

Inheritance diagram for ns3::SatFadingOscillator:

Collaboration diagram for ns3::SatFadingOscillator:

Public Member Functions
	SatFadingOscillator ()
	Constructor.
	SatFadingOscillator (double amplitude, double initialPhase, double omega)
	Constructor.
	SatFadingOscillator (std::complex< double > amplitude, double initialPhase, double omega)
	Constructor.
	~SatFadingOscillator ()
	Destructor.
void	DoDispose ()
	Do needed dispose actions.
std::complex< double >	GetComplexValueAt (double timeInSeconds) const
	Returns complex value at time t.
std::complex< double >	GetCosineWaveValueAt (double timeInSeconds) const
	Returns cosine wave complex value at time t.

Static Public Member Functions
static TypeId	GetTypeId (void)
	NS-3 function for type id.

Private Attributes
double	m_amplitude
	Amplitude.
std::complex< double >	m_complexAmplitude
	Complex amplitude.
double	m_omega
	Rotation speed.
double	m_phase
	Initial phase.

Detailed Description

Oscillator class for faders.

This class implements the oscillators required by the faders for Markov-fading. The provided oscillator values are used to form individual fading samples.

Definition at line 40 of file satellite-fading-oscillator.h.

Constructor & Destructor Documentation

SatFadingOscillator() [1/3]

ns3::SatFadingOscillator::SatFadingOscillator

(

)

Constructor.

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

References m_amplitude, m_complexAmplitude, m_omega, and m_phase.

SatFadingOscillator() [2/3]

ns3::SatFadingOscillator::SatFadingOscillator	(	std::complex< double >	amplitude,
		double	initialPhase,
		double	omega )

Constructor.

Parameters

amplitude	amplitude
initialPhase	intial phase
omega	rotation speed

Definition at line 55 of file satellite-fading-oscillator.cc.

References m_amplitude, m_complexAmplitude, m_omega, and m_phase.

SatFadingOscillator() [3/3]

ns3::SatFadingOscillator::SatFadingOscillator	(	double	amplitude,
		double	initialPhase,
		double	omega )

Constructor.

Parameters

amplitude	amplitude
initialPhase	initial phase
omega	rotation speed

Definition at line 66 of file satellite-fading-oscillator.cc.

References m_amplitude, m_complexAmplitude, m_omega, and m_phase.

~SatFadingOscillator()

ns3::SatFadingOscillator::~SatFadingOscillator

(

)

Destructor.

Definition at line 93 of file satellite-fading-oscillator.cc.

Member Function Documentation

DoDispose()

void ns3::SatFadingOscillator::DoDispose

(

)

Do needed dispose actions.

Definition at line 99 of file satellite-fading-oscillator.cc.

GetComplexValueAt()

std::complex< double > ns3::SatFadingOscillator::GetComplexValueAt

(

double

timeInSeconds

)

const

Returns complex value at time t.

Parameters

timeInSeconds

current time in seconds

Returns

complex value

Definition at line 76 of file satellite-fading-oscillator.cc.

References m_complexAmplitude, m_omega, and m_phase.

GetCosineWaveValueAt()

std::complex< double > ns3::SatFadingOscillator::GetCosineWaveValueAt

(

double

timeInSeconds

)

const

Returns cosine wave complex value at time t.

Parameters

timeInSeconds

current time in seconds

Returns

complex value

Definition at line 84 of file satellite-fading-oscillator.cc.

References m_amplitude, m_omega, and m_phase.

GetTypeId()

TypeId ns3::SatFadingOscillator::GetTypeId ( void )

static

NS-3 function for type id.

Returns

type id

Definition at line 36 of file satellite-fading-oscillator.cc.

Member Data Documentation

m_amplitude

double ns3::SatFadingOscillator::m_amplitude

private

Amplitude.

Definition at line 103 of file satellite-fading-oscillator.h.

Referenced by SatFadingOscillator(), SatFadingOscillator(), SatFadingOscillator(), and GetCosineWaveValueAt().

m_complexAmplitude

std::complex<double> ns3::SatFadingOscillator::m_complexAmplitude

private

Complex amplitude.

Definition at line 98 of file satellite-fading-oscillator.h.

Referenced by SatFadingOscillator(), SatFadingOscillator(), SatFadingOscillator(), and GetComplexValueAt().

m_omega

double ns3::SatFadingOscillator::m_omega

private

Rotation speed.

Definition at line 113 of file satellite-fading-oscillator.h.

Referenced by SatFadingOscillator(), SatFadingOscillator(), SatFadingOscillator(), GetComplexValueAt(), and GetCosineWaveValueAt().

m_phase

double ns3::SatFadingOscillator::m_phase

private

Initial phase.

Definition at line 108 of file satellite-fading-oscillator.h.

Referenced by SatFadingOscillator(), SatFadingOscillator(), SatFadingOscillator(), GetComplexValueAt(), and GetCosineWaveValueAt().

---

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

• /builds/sns3/satellite/satellite/model/satellite-fading-oscillator.h
• /builds/sns3/satellite/satellite/model/satellite-fading-oscillator.cc