A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::BleSpectrumValueHelper Class Reference

This class defines all functions to create spectrum value for spectrum model for BLE. More...

#include "ble-spectrum-value-helper.h"

+ Inheritance diagram for ns3::BleSpectrumValueHelper:
+ Collaboration diagram for ns3::BleSpectrumValueHelper:

Public Member Functions

 BleSpectrumValueHelper (void)
 
 BleSpectrumValueHelper (double)
 
virtual ~BleSpectrumValueHelper (void)
 
Ptr< SpectrumValueCreateNoisePowerSpectralDensity (uint32_t channel)
 create a noise in channel The noise power spectral density will be calculated from noise factor More...
 
Ptr< SpectrumValueCreateNoisePowerSpectralDensity (void)
 
Ptr< SpectrumValueCreateTxPowerSpectralDensity (double txPower, uint32_t channel)
 create spectrum value To create a spectrum value object with given txPower in given channel. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< BleSpectrumValueHelper >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 

Static Public Member Functions

static double TotalAvgPower (Ptr< const SpectrumValue > psd, uint32_t channel)
 total average power of the signal is the integral of the PSD using the limits of the given channel More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< BleSpectrumValueHelper >
static void Cleanup (void)
 Noop. More...
 

Private Attributes

double m_noiseFactor
 A scaling factor for the noise power. More...
 

Detailed Description

This class defines all functions to create spectrum value for spectrum model for BLE.

Definition at line 39 of file ble-spectrum-value-helper.h.

Constructor & Destructor Documentation

ns3::BleSpectrumValueHelper::BleSpectrumValueHelper ( void  )

Definition at line 80 of file ble-spectrum-value-helper.cc.

References m_noiseFactor, and NS_LOG_FUNCTION.

ns3::BleSpectrumValueHelper::BleSpectrumValueHelper ( double  noiseFactor)

Definition at line 86 of file ble-spectrum-value-helper.cc.

ns3::BleSpectrumValueHelper::~BleSpectrumValueHelper ( void  )
virtual

Definition at line 90 of file ble-spectrum-value-helper.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

Ptr< SpectrumValue > ns3::BleSpectrumValueHelper::CreateNoisePowerSpectralDensity ( uint32_t  channel)

create a noise in channel The noise power spectral density will be calculated from noise factor

Parameters
channel(Default all Channels i.e. white noise spectrum values)
Returns
a Ptr to a newly created SpectrumValue instance

Definition at line 114 of file ble-spectrum-value-helper.cc.

References third::channel, ns3::g_BleSpectrumModel, m_noiseFactor, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by ns3::BlePhy::BlePhy().

+ Here is the caller graph for this function:

Ptr< SpectrumValue > ns3::BleSpectrumValueHelper::CreateNoisePowerSpectralDensity ( void  )
Ptr< SpectrumValue > ns3::BleSpectrumValueHelper::CreateTxPowerSpectralDensity ( double  txPower,
uint32_t  channel 
)

create spectrum value To create a spectrum value object with given txPower in given channel.

  • Parameters
    txPowerthe power transmission in dBm
    channelthe channel number of BLE channels
    Returns
    a Ptr to a newly created SpectrumValue instance

Definition at line 96 of file ble-spectrum-value-helper.cc.

References third::channel, ns3::g_BleSpectrumModel, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by ns3::BlePhy::CheckInterference(), and ns3::BlePhy::StartTx().

+ Here is the caller graph for this function:

double ns3::BleSpectrumValueHelper::TotalAvgPower ( Ptr< const SpectrumValue psd,
uint32_t  channel 
)
static

total average power of the signal is the integral of the PSD using the limits of the given channel

Parameters
psdspectral density
channelthe channel number as per BLE specifications
Returns
total power (using composite trap. rule to numerally integrate)

Definition at line 147 of file ble-spectrum-value-helper.cc.

References third::channel, ns3::g_BleSpectrumModel, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::BlePhy::CheckInterference(), and ns3::BlePhy::StartRx().

+ Here is the caller graph for this function:

Member Data Documentation

double ns3::BleSpectrumValueHelper::m_noiseFactor
private

A scaling factor for the noise power.

Definition at line 77 of file ble-spectrum-value-helper.h.

Referenced by BleSpectrumValueHelper(), and CreateNoisePowerSpectralDensity().


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