A Discrete-Event Network Simulator
API
ns3::SpectrumConverter Class Reference

Class which implements a converter between SpectrumValue which are defined over different SpectrumModel. More...

#include "spectrum-converter.h"

+ Inheritance diagram for ns3::SpectrumConverter:
+ Collaboration diagram for ns3::SpectrumConverter:

Public Member Functions

 SpectrumConverter ()
 
 SpectrumConverter (Ptr< const SpectrumModel > fromSpectrumModel, Ptr< const SpectrumModel > toSpectrumModel)
 Create a SpectrumConverter class that will be able to convert ValueVsFreq instances defined over one SpectrumModel to corresponding ValueVsFreq instances defined over a diffent SpectrumModel. More...
 
Ptr< SpectrumValueConvert (Ptr< const SpectrumValue > vvf) const
 Convert a particular ValueVsFreq instance to. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< SpectrumConverter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Private Member Functions

double GetCoefficient (const BandInfo &from, const BandInfo &to) const
 Calculate the coefficient for value conversion between elements. More...
 

Private Attributes

std::vector< size_t > m_conversionColInd
 column of each non-zero element in m_conversionMatrix More...
 
std::vector< double > m_conversionMatrix
 matrix of conversion coefficients stored in Compressed Row Storage format More...
 
std::vector< size_t > m_conversionRowPtr
 offset of rows in m_conversionMatrix More...
 
Ptr< const SpectrumModelm_fromSpectrumModel
 the SpectrumModel this SpectrumConverter instance can convert from More...
 
Ptr< const SpectrumModelm_toSpectrumModel
 the SpectrumModel this SpectrumConverter instance can convert to More...
 

Detailed Description

Class which implements a converter between SpectrumValue which are defined over different SpectrumModel.

In more formal terms, this class allows conversion between different function spaces. In practical terms, this allows you to mix different spectrum representation within the same channel, such as a device using a coarse spectrum representation (e.g., one frequency for each IEEE 802.11 channel) and devices using a finer representation (e.g., one frequency for each OFDM subcarrier).

Definition at line 42 of file spectrum-converter.h.

Constructor & Destructor Documentation

◆ SpectrumConverter() [1/2]

ns3::SpectrumConverter::SpectrumConverter ( Ptr< const SpectrumModel fromSpectrumModel,
Ptr< const SpectrumModel toSpectrumModel 
)

Create a SpectrumConverter class that will be able to convert ValueVsFreq instances defined over one SpectrumModel to corresponding ValueVsFreq instances defined over a diffent SpectrumModel.

Parameters
fromSpectrumModelthe SpectrumModel to convert from
toSpectrumModelthe SpectrumModel to convert to

Definition at line 36 of file spectrum-converter.cc.

References ns3::SpectrumModel::Begin(), ns3::SpectrumModel::End(), GetCoefficient(), m_conversionColInd, m_conversionMatrix, m_conversionRowPtr, m_fromSpectrumModel, m_toSpectrumModel, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

+ Here is the call graph for this function:

◆ SpectrumConverter() [2/2]

ns3::SpectrumConverter::SpectrumConverter ( )

Definition at line 32 of file spectrum-converter.cc.

Member Function Documentation

◆ Convert()

Ptr< SpectrumValue > ns3::SpectrumConverter::Convert ( Ptr< const SpectrumValue vvf) const

Convert a particular ValueVsFreq instance to.

Parameters
vvfthe ValueVsFreq instance to be converted
Returns
the converted version of the provided ValueVsFreq

Definition at line 79 of file spectrum-converter.cc.

References m_conversionColInd, m_conversionMatrix, m_conversionRowPtr, m_fromSpectrumModel, m_toSpectrumModel, NS_ASSERT, and ns3::SpectrumValue::ValuesBegin().

Referenced by SpectrumConverterTestSuite::SpectrumConverterTestSuite().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetCoefficient()

double ns3::SpectrumConverter::GetCoefficient ( const BandInfo from,
const BandInfo to 
) const
private

Calculate the coefficient for value conversion between elements.

Parameters
fromBandInfo to convert from
toBandInfo to convert to
Returns
the fraction of the value of the "from" BandInfos that is mapped to the "to" BandInfo

Definition at line 67 of file spectrum-converter.cc.

References ns3::BandInfo::fh, ns3::BandInfo::fl, max, min, and NS_LOG_FUNCTION.

Referenced by SpectrumConverter().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_conversionColInd

std::vector<size_t> ns3::SpectrumConverter::m_conversionColInd
private

column of each non-zero element in m_conversionMatrix

Definition at line 83 of file spectrum-converter.h.

Referenced by SpectrumConverter(), and Convert().

◆ m_conversionMatrix

std::vector<double> ns3::SpectrumConverter::m_conversionMatrix
private

matrix of conversion coefficients stored in Compressed Row Storage format

Definition at line 81 of file spectrum-converter.h.

Referenced by SpectrumConverter(), and Convert().

◆ m_conversionRowPtr

std::vector<size_t> ns3::SpectrumConverter::m_conversionRowPtr
private

offset of rows in m_conversionMatrix

Definition at line 82 of file spectrum-converter.h.

Referenced by SpectrumConverter(), and Convert().

◆ m_fromSpectrumModel

Ptr<const SpectrumModel> ns3::SpectrumConverter::m_fromSpectrumModel
private

the SpectrumModel this SpectrumConverter instance can convert from

Definition at line 85 of file spectrum-converter.h.

Referenced by SpectrumConverter(), and Convert().

◆ m_toSpectrumModel

Ptr<const SpectrumModel> ns3::SpectrumConverter::m_toSpectrumModel
private

the SpectrumModel this SpectrumConverter instance can convert to

Definition at line 86 of file spectrum-converter.h.

Referenced by SpectrumConverter(), and Convert().


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