A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
ns3::SpectrumModel Class Reference

#include <spectrum-model.h>

+ Inheritance diagram for ns3::SpectrumModel:

Public Member Functions

 SpectrumModel (std::vector< double > centerFreqs)
 
 SpectrumModel (Bands bands)
 
Bands::const_iterator Begin () const
 
Bands::const_iterator End () const
 
size_t GetNumBands () const
 
SpectrumModelUid_t GetUid () const
 
- Public Member Functions inherited from ns3::SimpleRefCount< SpectrumModel >
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 

Private Attributes

Bands m_bands
 
SpectrumModelUid_t m_uid
 unique id for a given set of frequencies
 

Static Private Attributes

static SpectrumModelUid_t m_uidCount = 0
 counter to assign m_uids
 

Friends

bool operator== (const SpectrumModel &lhs, const SpectrumModel &rhs)
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::SimpleRefCount< SpectrumModel >
static void Cleanup (void)
 

Detailed Description

Set of frequency values implementing the domain of the functions in the Function Space defined by SpectrumValue. Frequency values are in Hz. It is intended that frequency values are non-negative, though this is not enforced.

Definition at line 63 of file spectrum-model.h.

Constructor & Destructor Documentation

ns3::SpectrumModel::SpectrumModel ( std::vector< double >  centerFreqs)

This constructs a SpectrumModel based on a given set of frequencies, which is assumed to be sorted by increasing frequency. The lower (resp. upper) frequency band limit is determined as the mean value between the center frequency of the considered band and the center frequency of the adjacent lower (resp. upper) band.

Parameters
centerFreqsthe vector of center frequencies.
Returns

Definition at line 44 of file spectrum-model.cc.

References ns3::BandInfo::fc, ns3::BandInfo::fh, ns3::BandInfo::fl, m_bands, m_uid, m_uidCount, and NS_ASSERT.

ns3::SpectrumModel::SpectrumModel ( Bands  bands)

This construct a SpectrumModel based on the explicit values of center frequencies and boundaries of each subband.

Parameters
bands
Returns

Definition at line 76 of file spectrum-model.cc.

References m_bands, m_uid, m_uidCount, and NS_LOG_INFO.

Member Function Documentation

size_t ns3::SpectrumModel::GetNumBands ( ) const
Returns
the number of frequencies in this SpectrumModel

Definition at line 96 of file spectrum-model.cc.

References m_bands.

SpectrumModelUid_t ns3::SpectrumModel::GetUid ( void  ) const
Returns
the unique id of this SpectrumModel

Definition at line 102 of file spectrum-model.cc.

References m_uid.

Member Data Documentation

Bands ns3::SpectrumModel::m_bands
private

actual definition of frequency bands within this SpectrumModel

Definition at line 110 of file spectrum-model.h.

Referenced by GetNumBands(), and SpectrumModel().

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