#include <spectrum-analyzer.h>

Inheritance diagram for ns3::SpectrumAnalyzer:

Collaboration diagram for ns3::SpectrumAnalyzer:

Public Member Functions
	SpectrumAnalyzer ()
virtual	~SpectrumAnalyzer ()
Ptr< NetDevice >	GetDevice ()
Ptr< MobilityModel >	GetMobility ()
Ptr< AntennaModel >	GetRxAntenna ()
Ptr< const SpectrumModel >	GetRxSpectrumModel () const
void	SetAntenna (Ptr< AntennaModel > a)
void	SetChannel (Ptr< SpectrumChannel > c)
void	SetDevice (Ptr< NetDevice > d)
void	SetMobility (Ptr< MobilityModel > m)
void	SetRxSpectrumModel (Ptr< SpectrumModel > m)
virtual void	Start ()
void	StartRx (Ptr< SpectrumSignalParameters > params)
virtual void	Stop ()
Public Member Functions inherited from ns3::SpectrumPhy
	SpectrumPhy ()
virtual	~SpectrumPhy ()
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

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

Protected Member Functions
void	DoDispose ()

Private Member Functions
void	AddSignal (Ptr< const SpectrumValue > psd)
virtual void	GenerateReport ()
void	SubtractSignal (Ptr< const SpectrumValue > psd)
void	UpdateEnergyReceivedSoFar ()

Private Attributes
bool	m_active
Ptr< AntennaModel >	m_antenna
TracedCallback< Ptr< const SpectrumValue > >	m_averagePowerSpectralDensityReportTrace
Ptr< SpectrumChannel >	m_channel
Ptr< SpectrumValue >	m_energySpectralDensity
Time	m_lastChangeTime
Ptr< MobilityModel >	m_mobility
Ptr< NetDevice >	m_netDevice
double	m_noisePowerSpectralDensity
Time	m_resolution
Ptr< SpectrumModel >	m_spectrumModel
Ptr< SpectrumValue >	m_sumPowerSpectralDensity

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).

Definition at line 48 of file spectrum-analyzer.h.

Constructor & Destructor Documentation

ns3::SpectrumAnalyzer::SpectrumAnalyzer ( )

Definition at line 37 of file spectrum-analyzer.cc.

References NS_LOG_FUNCTION.

ns3::SpectrumAnalyzer::~SpectrumAnalyzer ( )

virtual

Definition at line 51 of file spectrum-analyzer.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::SpectrumAnalyzer::AddSignal ( Ptr< const SpectrumValue > psd )

private

Definition at line 164 of file spectrum-analyzer.cc.

References NS_LOG_FUNCTION, and UpdateEnergyReceivedSoFar().

Referenced by StartRx().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Definition at line 57 of file spectrum-analyzer.cc.

References m_channel, m_energySpectralDensity, m_mobility, m_netDevice, m_spectrumModel, m_sumPowerSpectralDensity, and NS_LOG_FUNCTION.

void ns3::SpectrumAnalyzer::GenerateReport ( )

privatevirtual

Definition at line 195 of file spectrum-analyzer.cc.

References ns3::Time::GetSeconds(), ns3::SpectrumValue::GetSpectrumModel(), m_active, m_averagePowerSpectralDensityReportTrace, m_noisePowerSpectralDensity, m_resolution, m_sumPowerSpectralDensity, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::Simulator::Schedule(), and UpdateEnergyReceivedSoFar().

Referenced by Start().

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

get the associated NetDevice instance

Returns: a Ptr to the associated NetDevice instance

Implements ns3::SpectrumPhy.

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

References m_netDevice.

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

virtual

get the associated MobilityModel instance

Returns: a Ptr to the associated MobilityModel instance

Implements ns3::SpectrumPhy.

Definition at line 103 of file spectrum-analyzer.cc.

References m_mobility.

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.

Definition at line 140 of file spectrum-analyzer.cc.

References m_antenna.

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.

Definition at line 110 of file spectrum-analyzer.cc.

References m_spectrumModel.

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