ns3::SpectrumAnalyzer Class Reference

#include <spectrum-analyzer.h>

Inheritance diagram for ns3::SpectrumAnalyzer:
Inheritance graph
[legend]
Collaboration diagram for ns3::SpectrumAnalyzer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void SetChannel (Ptr< SpectrumChannel > c)
void SetMobility (Ptr< Object > m)
void SetDevice (Ptr< Object > d)
Ptr< Object > GetMobility ()
Ptr< Object > GetDevice ()
Ptr< const SpectrumModel > GetRxSpectrumModel () const
void StartRx (Ptr< PacketBurst > pb, Ptr< const SpectrumValue > rxPowerSpectralDensity, SpectrumType st, Time duration)
void SetRxSpectrumModel (Ptr< SpectrumModel > m)
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.

Member Function Documentation

void ns3::SpectrumAnalyzer::DoDispose (  )  [protected, virtual]

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.

Ptr<Object> ns3::SpectrumAnalyzer::GetDevice (  )  [virtual]

get the associated NetDevice instance

Returns:
a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

Ptr<Object> ns3::SpectrumAnalyzer::GetMobility (  )  [virtual]

get the associated MobilityModel instance

Returns:
a Ptr to the associated NetDevice instance

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.

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

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

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/LinkManager/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/SSManager/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/Classifier/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/NoiseModel/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Channel/PropagationModel/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Mac/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Phy/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::UanNetDevice/Transducer/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/BsIpcsPacketClassifier/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/LinkManager/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/SSManager/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::BaseStationNetDevice/ServiceFlowManager/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/Classifier/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/LinkManager/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/$ns3::SubscriberStationNetDevice/SSScheduler/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BandwidthManager/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/BurstProfileManager/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/NoiseModel/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Channel/$ns3::UanChannel/PropagationModel/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/ConnectionManager/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/NoiseModel/$ns3::SpectrumPhy/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::SpectrumAnalyzer
  • /NodeList/[i]/DeviceList/[i]/$ns3::WimaxNetDevice/Phy/Channel/$ns3::UanChannel/PropagationModel/$ns3::SpectrumPhy/$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: 1000000ns
    • 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.

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

Set the channel attached to this device.

Parameters:
c the channel

Implements ns3::SpectrumPhy.

void ns3::SpectrumAnalyzer::SetDevice ( Ptr< Object >  d  )  [virtual]

set the associated NetDevice instance

Parameters:
d the NetDevice instance

Implements ns3::SpectrumPhy.

void ns3::SpectrumAnalyzer::SetMobility ( Ptr< Object >  m  )  [virtual]

Set the mobility model associated with this device.

Parameters:
m the mobility model

Implements ns3::SpectrumPhy.

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

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

Parameters:
m 
virtual void ns3::SpectrumAnalyzer::Start (  )  [virtual]

Start the spectrum analyzer

Reimplemented from ns3::Object.

void ns3::SpectrumAnalyzer::StartRx ( Ptr< PacketBurst >  p,
Ptr< const SpectrumValue >  rxPsd,
SpectrumType  st,
Time  duration 
) [virtual]

Notify the SpectrumPhy instance of an incoming waveform

Parameters:
p the PacketBurst associated with the incoming waveform
rxPsd the Power Spectral Density of the incoming waveform. The units of the PSD are the same specified for SpectrumChannel::StartTx().
st spectrum type
duration the duration of the incoming waveform

Implements ns3::SpectrumPhy.

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

Stop the spectrum analyzer

The documentation for this class was generated from the following files:
Generated on 6 Jan 2011 for NS-3 by  doxygen 1.6.1