ns-3
ns3::SpectrumAnalyzer Class Reference

#include <spectrum-analyzer.h>

Inheritance diagram for ns3::SpectrumAnalyzer:
Collaboration diagram for ns3::SpectrumAnalyzer:

List of all members.

Public Member Functions

void SetChannel (Ptr< SpectrumChannel > c)
void SetMobility (Ptr< MobilityModel > m)
void SetDevice (Ptr< NetDevice > d)
Ptr< MobilityModelGetMobility ()
Ptr< NetDeviceGetDevice ()
Ptr< const SpectrumModelGetRxSpectrumModel () const
Ptr< AntennaModelGetRxAntenna ()
void StartRx (Ptr< SpectrumSignalParameters > params)
void SetRxSpectrumModel (Ptr< SpectrumModel > m)
void SetAntenna (Ptr< AntennaModel > a)
virtual void Start ()
virtual void Stop ()

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::SpectrumAnalyzer.

Protected Member Functions

void DoDispose ()

Detailed Description

Simple SpectrumPhy implemetation that averages the spectrum power density of incoming transmissions to produce a spectrogram.

This PHY model supports a single antenna model instance which is used for reception (this PHY model never transmits).


Member Function Documentation

void ns3::SpectrumAnalyzer::DoDispose ( void  )
protectedvirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

References NS_LOG_FUNCTION.

Ptr< NetDevice > ns3::SpectrumAnalyzer::GetDevice ( )
virtual

get the associated NetDevice instance

Returns:
a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

Ptr< MobilityModel > ns3::SpectrumAnalyzer::GetMobility ( )
virtual

get the associated MobilityModel instance

Returns:
a Ptr to the associated MobilityModel instance

Implements ns3::SpectrumPhy.

Ptr< AntennaModel > ns3::SpectrumAnalyzer::GetRxAntenna ( )
virtual

get the AntennaModel used by the NetDevice for reception

Returns:
a Ptr to the AntennaModel used by the NetDevice for reception

Implements ns3::SpectrumPhy.

Ptr< const SpectrumModel > ns3::SpectrumAnalyzer::GetRxSpectrumModel ( ) const
virtual
Returns:
returns the SpectrumModel that this SpectrumPhy expects to be used for all SpectrumValues that are passed to StartRx. If 0 is returned, it means that any model will be accepted.

Implements ns3::SpectrumPhy.

TypeId ns3::SpectrumAnalyzer::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::SpectrumAnalyzer.

Attributes defined for this type:

  • Resolution: the lengh of the time interval over which the power spectral density of incoming signals is averaged
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: +1000000.0ns
    • Flags: construct write read
  • NoisePowerSpectralDensity: the power spectral density of the measuring instrument noise, in Watt/Hz. Mostly useful to make spectrograms look more similar to those obtained by real devices. Defaults to the value for thermal noise at 300K.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 4.14e-21
    • Flags: construct write read

TraceSources defined for this type:

  • AveragePowerSpectralDensityReport: Trace fired whenever a new value for the average Power Spectral Density is calculated

Reimplemented from ns3::SpectrumPhy.

References ns3::MakeTraceSourceAccessor(), ns3::MilliSeconds(), and ns3::TypeId::SetParent().

void ns3::SpectrumAnalyzer::SetAntenna ( Ptr< AntennaModel a)

set the AntennaModel to be used

Parameters:
athe Antenna Model

References NS_LOG_FUNCTION.

void ns3::SpectrumAnalyzer::SetChannel ( Ptr< SpectrumChannel c)
virtual

Set the channel attached to this device.

Parameters:
cthe channel

Implements ns3::SpectrumPhy.

References NS_LOG_FUNCTION.

void ns3::SpectrumAnalyzer::SetDevice ( Ptr< NetDevice d)
virtual

set the associated NetDevice instance

Parameters:
dthe NetDevice instance

Implements ns3::SpectrumPhy.

References NS_LOG_FUNCTION.

void ns3::SpectrumAnalyzer::SetMobility ( Ptr< MobilityModel m)
virtual

Set the mobility model associated with this device.

Parameters:
mthe mobility model

Implements ns3::SpectrumPhy.

References NS_LOG_FUNCTION.

void ns3::SpectrumAnalyzer::SetRxSpectrumModel ( Ptr< SpectrumModel m)

Set the spectrum model used by the SpectrumAnalyzer to represent incoming signals

Parameters:
m

References NS_ASSERT, and NS_LOG_FUNCTION.

void ns3::SpectrumAnalyzer::Start ( void  )
virtual

Start the spectrum analyzer

Reimplemented from ns3::Object.

References NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Simulator::Schedule().

void ns3::SpectrumAnalyzer::StartRx ( Ptr< SpectrumSignalParameters params)
virtual

Notify the SpectrumPhy instance of an incoming signal

Parameters:
paramsthe parameters of the signals being received

Implements ns3::SpectrumPhy.

References NS_LOG_FUNCTION, and ns3::Simulator::Schedule().

void ns3::SpectrumAnalyzer::Stop ( void  )
virtual

Stop the spectrum analyzer


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