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

#include <spectrum-analyzer.h>

Inheritance diagram for ns3::SpectrumAnalyzer:

Collaboration diagram for ns3::SpectrumAnalyzer:

Public Member Functions
	SpectrumAnalyzer ()

virtual	~SpectrumAnalyzer ()

Ptr< NetDevice >	GetDevice ()
	get the associated NetDevice instance More...

Ptr< MobilityModel >	GetMobility ()
	get the associated MobilityModel instance More...

Ptr< AntennaModel >	GetRxAntenna ()
	get the AntennaModel used by the NetDevice for reception More...

Ptr< const SpectrumModel >	GetRxSpectrumModel () const

void	SetAntenna (Ptr< AntennaModel > a)
	set the AntennaModel to be used More...

void	SetChannel (Ptr< SpectrumChannel > c)
	Set the channel attached to this device. More...

void	SetDevice (Ptr< NetDevice > d)
	set the associated NetDevice instance More...

void	SetMobility (Ptr< MobilityModel > m)
	Set the mobility model associated with this device. More...

void	SetRxSpectrumModel (Ptr< SpectrumModel > m)
	Set the spectrum model used by the SpectrumAnalyzer to represent incoming signals. More...

virtual void	Start ()
	Start the spectrum analyzer. More...

void	StartRx (Ptr< SpectrumSignalParameters > params)
	Notify the SpectrumPhy instance of an incoming signal. More...

virtual void	Stop ()
	Stop the spectrum analyzer. More...

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)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

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)

Static Public Member Functions inherited from ns3::SpectrumPhy
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Protected Member Functions
void	DoDispose ()
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

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.

Doxygen introspection did not find any typical Config paths.

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

Attributes

Resolution: the lengh of the time interval over which the power spectral density of incoming signals is averaged
- Set with class: ns3::TimeValue
- Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
- 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

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

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

Constructor & Destructor Documentation

ns3::SpectrumAnalyzer::SpectrumAnalyzer ( )

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

References NS_LOG_FUNCTION.

ns3::SpectrumAnalyzer::~SpectrumAnalyzer ( )

virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

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

private

Definition at line 165 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 58 of file spectrum-analyzer.cc.

References ns3::Object::DoDispose(), m_channel, m_energySpectralDensity, m_mobility, m_netDevice, m_spectrumModel, m_sumPowerSpectralDensity, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::SpectrumAnalyzer::GenerateReport ( )

privatevirtual

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

References ns3::Time::GetSeconds(), 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 97 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 104 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 141 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 111 of file spectrum-analyzer.cc.

References m_spectrumModel.

TypeId ns3::SpectrumAnalyzer::GetTypeId ( void )

static

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

References m_averagePowerSpectralDensityReportTrace, m_noisePowerSpectralDensity, m_resolution, ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function: