SatCnoEstimator class defines interface for C/N0 estimators. More...

#include "satellite-cno-estimator.h"

Inheritance diagram for ns3::SatCnoEstimator:

Collaboration diagram for ns3::SatCnoEstimator:

Public Types
enum	EstimationMode_t { LAST , MINIMUM , AVERAGE }
	Definition of modes for estimator. More...

Public Member Functions
	SatCnoEstimator ()
	Default construct a SatCnoEstimator. More...

virtual	~SatCnoEstimator ()
	Destroy a SatCnoEstimator. More...

void	AddSample (double cno)
	Add a C/N0 sample to estimator. More...

double	GetCnoEstimation ()
	Estimate C/N0 value of the samples. More...

Private Member Functions
virtual void	DoAddSample (double cno)=0
	Add a C/N0 sample to estimator. More...

virtual double	DoGetCnoEstimation ()=0
	Estimate C/N0 value of the samples. More...

Detailed Description

SatCnoEstimator class defines interface for C/N0 estimators.

Definition at line 39 of file satellite-cno-estimator.h.

Member Enumeration Documentation

◆ EstimationMode_t

enum ns3::SatCnoEstimator::EstimationMode_t

Definition of modes for estimator.

Enumerator
LAST	Last value in the given window returned.
MINIMUM	Minimum value in the given window returned.
AVERAGE	Average value in the given window returned.

Definition at line 45 of file satellite-cno-estimator.h.

Constructor & Destructor Documentation

◆ SatCnoEstimator()

ns3::SatCnoEstimator::SatCnoEstimator ( )

Default construct a SatCnoEstimator.

Definition at line 41 of file satellite-cno-estimator.cc.

◆ ~SatCnoEstimator()

ns3::SatCnoEstimator::~SatCnoEstimator ( )

virtual

Destroy a SatCnoEstimator.

This is the destructor for the SatCnoEstimator.

Definition at line 46 of file satellite-cno-estimator.cc.

Member Function Documentation

◆ AddSample()

void ns3::SatCnoEstimator::AddSample ( double cno )

Add a C/N0 sample to estimator.

Calls the method DoAddSample.

Parameters

cno	C/N0 sample value

Definition at line 52 of file satellite-cno-estimator.cc.

References DoAddSample().

Here is the call graph for this function:

◆ DoAddSample()

virtual void ns3::SatCnoEstimator::DoAddSample ( double cno )

privatepure virtual

Add a C/N0 sample to estimator.

Method must be implemented by inheriting classes.

Parameters

cno	C/N0 sample value

Implemented in ns3::SatBasicCnoEstimator.

Referenced by AddSample().

Here is the caller graph for this function:

◆ DoGetCnoEstimation()

virtual double ns3::SatCnoEstimator::DoGetCnoEstimation ( )

privatepure virtual

Estimate C/N0 value of the samples.

Method must be implemented by inheriting classes.

Returns: Estimated value of the C/N0, in case that estimation cannot be done (e.g. no samples) NAN is returned.

Implemented in ns3::SatBasicCnoEstimator.

Referenced by GetCnoEstimation().

Here is the caller graph for this function:

◆ GetCnoEstimation()

double ns3::SatCnoEstimator::GetCnoEstimation ( )