A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::SNRToBlockErrorRateRecord Class Reference

This class represents a record (handled by SnrToBlockErrorRate manager) that keeps a mapping between an SNR value and its corresponding (1) Bit Error Rate, (2) Block Error Rate, (3) Standard deviation, (4 and 5) confidence interval. More...

#include "snr-to-block-error-rate-record.h"

+ Collaboration diagram for ns3::SNRToBlockErrorRateRecord:

Public Member Functions

 SNRToBlockErrorRateRecord (double snrValue, double bitErrorRate, double BlockErrorRate, double sigma2, double I1, double I2)
 creates a record and sets its values
 
 ~SNRToBlockErrorRateRecord ()
 
SNRToBlockErrorRateRecordCopy () const
 copy a record
 
double GetBitErrorRate () const
 
double GetBlockErrorRate () const
 
double GetI1 () const
 
double GetI2 () const
 
double GetSigma2 () const
 
double GetSNRValue () const
 
void SetBitErrorRate (double bitErrorRate)
 set the BER value
 
void SetBlockErrorRate (double blockErrorRate)
 set the BlcER value
 
void SetI1 (double i1)
 set the lower boundary of the confidence interval
 
void SetI2 (double i2)
 set the upper boundary of the confidence interval
 
void SetSNRValue (double snrValue)
 set the snr value
 

Private Attributes

double m_bitErrorRate
 bit error rate
 
double m_blockErrorRate
 block error rate
 
double m_i1
 The lower boundary of the confidence interval.
 
double m_i2
 The upper boundary of the confidence interval.
 
double m_sigma2
 sigma2
 
double m_snrValue
 SNR value.
 

Detailed Description

This class represents a record (handled by SnrToBlockErrorRate manager) that keeps a mapping between an SNR value and its corresponding (1) Bit Error Rate, (2) Block Error Rate, (3) Standard deviation, (4 and 5) confidence interval.

Definition at line 23 of file snr-to-block-error-rate-record.h.

Constructor & Destructor Documentation

◆ SNRToBlockErrorRateRecord()

ns3::SNRToBlockErrorRateRecord::SNRToBlockErrorRateRecord ( double snrValue,
double bitErrorRate,
double BlockErrorRate,
double sigma2,
double I1,
double I2 )

creates a record and sets its values

Parameters
snrValueThe SNR value
bitErrorRatethe BER
BlockErrorRatethe BlcER
sigma2the standard deviation
I1the lower boundary of the confidence interval
I2the upper boundary of the confidence interval

Definition at line 18 of file snr-to-block-error-rate-record.cc.

References m_bitErrorRate, m_blockErrorRate, m_i1, m_i2, m_sigma2, and m_snrValue.

Referenced by Copy().

+ Here is the caller graph for this function:

◆ ~SNRToBlockErrorRateRecord()

ns3::SNRToBlockErrorRateRecord::~SNRToBlockErrorRateRecord ( )

Member Function Documentation

◆ Copy()

SNRToBlockErrorRateRecord * ns3::SNRToBlockErrorRateRecord::Copy ( ) const

copy a record

Returns
a copy of this record

Definition at line 34 of file snr-to-block-error-rate-record.cc.

References SNRToBlockErrorRateRecord(), m_bitErrorRate, m_blockErrorRate, m_i1, m_i2, m_sigma2, and m_snrValue.

+ Here is the call graph for this function:

◆ GetBitErrorRate()

double ns3::SNRToBlockErrorRateRecord::GetBitErrorRate ( ) const
Returns
the BER value

Definition at line 61 of file snr-to-block-error-rate-record.cc.

References m_bitErrorRate.

◆ GetBlockErrorRate()

double ns3::SNRToBlockErrorRateRecord::GetBlockErrorRate ( ) const
Returns
the BlcER value

Definition at line 67 of file snr-to-block-error-rate-record.cc.

References m_blockErrorRate.

◆ GetI1()

double ns3::SNRToBlockErrorRateRecord::GetI1 ( ) const
Returns
the lower boundary of the confidence interval

Definition at line 79 of file snr-to-block-error-rate-record.cc.

References m_i1.

Referenced by ns3::SimpleOfdmWimaxPhy::StartReceive().

+ Here is the caller graph for this function:

◆ GetI2()

double ns3::SNRToBlockErrorRateRecord::GetI2 ( ) const
Returns
the upper boundary of the confidence interval

Definition at line 85 of file snr-to-block-error-rate-record.cc.

References m_i2.

Referenced by ns3::SimpleOfdmWimaxPhy::StartReceive().

+ Here is the caller graph for this function:

◆ GetSigma2()

double ns3::SNRToBlockErrorRateRecord::GetSigma2 ( ) const
Returns
the standard deviation

Definition at line 73 of file snr-to-block-error-rate-record.cc.

References m_sigma2.

◆ GetSNRValue()

double ns3::SNRToBlockErrorRateRecord::GetSNRValue ( ) const
Returns
the SNR value

Definition at line 45 of file snr-to-block-error-rate-record.cc.

References m_snrValue.

◆ SetBitErrorRate()

void ns3::SNRToBlockErrorRateRecord::SetBitErrorRate ( double bitErrorRate)

set the BER value

Parameters
bitErrorRatethe bit error rate value

Definition at line 97 of file snr-to-block-error-rate-record.cc.

References m_bitErrorRate.

◆ SetBlockErrorRate()

void ns3::SNRToBlockErrorRateRecord::SetBlockErrorRate ( double blockErrorRate)

set the BlcER value

Parameters
blockErrorRatethe block error rate value

Definition at line 103 of file snr-to-block-error-rate-record.cc.

References m_blockErrorRate.

◆ SetI1()

void ns3::SNRToBlockErrorRateRecord::SetI1 ( double i1)

set the lower boundary of the confidence interval

Parameters
i1the lower boundary of the confidence interval

Definition at line 109 of file snr-to-block-error-rate-record.cc.

References m_i1.

◆ SetI2()

void ns3::SNRToBlockErrorRateRecord::SetI2 ( double i2)

set the upper boundary of the confidence interval

Parameters
i2the upper boundary of the confidence interval

Definition at line 115 of file snr-to-block-error-rate-record.cc.

References m_i2.

◆ SetSNRValue()

void ns3::SNRToBlockErrorRateRecord::SetSNRValue ( double snrValue)

set the snr value

Parameters
snrValuethe SNR value

Definition at line 91 of file snr-to-block-error-rate-record.cc.

References m_snrValue.

Member Data Documentation

◆ m_bitErrorRate

double ns3::SNRToBlockErrorRateRecord::m_bitErrorRate
private

◆ m_blockErrorRate

double ns3::SNRToBlockErrorRateRecord::m_blockErrorRate
private

◆ m_i1

double ns3::SNRToBlockErrorRateRecord::m_i1
private

The lower boundary of the confidence interval.

Definition at line 104 of file snr-to-block-error-rate-record.h.

Referenced by SNRToBlockErrorRateRecord(), ~SNRToBlockErrorRateRecord(), Copy(), GetI1(), and SetI1().

◆ m_i2

double ns3::SNRToBlockErrorRateRecord::m_i2
private

The upper boundary of the confidence interval.

Definition at line 105 of file snr-to-block-error-rate-record.h.

Referenced by SNRToBlockErrorRateRecord(), ~SNRToBlockErrorRateRecord(), Copy(), GetI2(), and SetI2().

◆ m_sigma2

double ns3::SNRToBlockErrorRateRecord::m_sigma2
private

◆ m_snrValue

double ns3::SNRToBlockErrorRateRecord::m_snrValue
private

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