Class to allow the Spectrum Analysis. More...

#include "spectrum-analyzer-helper.h"

Collaboration diagram for ns3::SpectrumAnalyzerHelper:

Public Member Functions
	SpectrumAnalyzerHelper ()

	~SpectrumAnalyzerHelper ()

void	EnableAsciiAll (std::string prefix)
	Enable ASCII output. More...

NetDeviceContainer	Install (NodeContainer c) const

NetDeviceContainer	Install (Ptr< Node > node) const

NetDeviceContainer	Install (std::string nodeName) const

void	SetAntenna (std::string type, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())

void	SetChannel (Ptr< SpectrumChannel > channel)
	Set the SpectrumChannel that will be used by SpectrumPhy instances created by this helper. More...

void	SetChannel (std::string channelName)
	Set the SpectrumChannel that will be used by SpectrumPhy instances created by this helper. More...

void	SetDeviceAttribute (std::string n1, const AttributeValue &v1)

void	SetPhyAttribute (std::string name, const AttributeValue &v)

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

Private Attributes
ObjectFactory	m_antenna
	Object factory for the Antenna objects. More...

Ptr< SpectrumChannel >	m_channel
	Channel. More...

ObjectFactory	m_device
	Object factory for the NetDevice objects. More...

ObjectFactory	m_phy
	Object factory for the phy objects. More...

std::string	m_prefix
	Prefix for the output files. More...

Ptr< SpectrumModel >	m_rxSpectrumModel
	Spectrum model. More...

Detailed Description

Class to allow the Spectrum Analysis.

Definition at line 44 of file spectrum-analyzer-helper.h.

Constructor & Destructor Documentation

◆ SpectrumAnalyzerHelper()

ns3::SpectrumAnalyzerHelper::SpectrumAnalyzerHelper ( )

Definition at line 74 of file spectrum-analyzer-helper.cc.

References m_antenna, m_device, m_phy, NS_LOG_FUNCTION, and ns3::ObjectFactory::SetTypeId().

Here is the call graph for this function:

◆ ~SpectrumAnalyzerHelper()

ns3::SpectrumAnalyzerHelper::~SpectrumAnalyzerHelper ( )

Definition at line 82 of file spectrum-analyzer-helper.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ EnableAsciiAll()

void ns3::SpectrumAnalyzerHelper::EnableAsciiAll ( std::string prefix )

Enable ASCII output.

This will create one filename for every created SpectrumAnalyzer instance.

Parameters

prefix the prefix of the filename of the traces that will be created.

Definition at line 151 of file spectrum-analyzer-helper.cc.

References m_prefix, and NS_LOG_FUNCTION.

◆ Install() [1/3]

NetDeviceContainer ns3::SpectrumAnalyzerHelper::Install ( NodeContainer c ) const

Parameters

c	the set of nodes on which a device must be created

Returns: a device container which contains all the devices created by this method.

Definition at line 160 of file spectrum-analyzer-helper.cc.

References ns3::Node::AddDevice(), ns3::NodeContainer::Begin(), ns3::Config::ConnectWithoutContext(), ns3::ObjectFactory::Create(), ns3::AsciiTraceHelper::CreateFileStream(), first::devices, ns3::NodeContainer::End(), ns3::AsciiTraceHelper::GetFilenameFromDevice(), ns3::Node::GetId(), ns3::Object::GetObject(), m_antenna, m_channel, m_device, m_phy, m_prefix, m_rxSpectrumModel, ns3::MakeBoundCallback(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, third::phy, and ns3::WriteAveragePowerSpectralDensityReport().

Referenced by Install().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Install() [2/3]

NetDeviceContainer ns3::SpectrumAnalyzerHelper::Install ( Ptr< Node > node ) const

Parameters

node	the node on which a device must be created

Returns: a device container which contains all the devices created by this method.

Definition at line 220 of file spectrum-analyzer-helper.cc.

References Install(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ Install() [3/3]

NetDeviceContainer ns3::SpectrumAnalyzerHelper::Install ( std::string nodeName ) const

Parameters

nodeName the name of node on which a device must be created

Returns: a device container which contains all the devices created by this method.

Definition at line 227 of file spectrum-analyzer-helper.cc.

References Install(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetAntenna()

void ns3::SpectrumAnalyzerHelper::SetAntenna	(	std::string	type,
		std::string	n0 = `""`,
		const AttributeValue &	v0 = `EmptyAttributeValue ()`,
		std::string	n1 = `""`,
		const AttributeValue &	v1 = `EmptyAttributeValue ()`,
		std::string	n2 = `""`,
		const AttributeValue &	v2 = `EmptyAttributeValue ()`,
		std::string	n3 = `""`,
		const AttributeValue &	v3 = `EmptyAttributeValue ()`,
		std::string	n4 = `""`,
		const AttributeValue &	v4 = `EmptyAttributeValue ()`,
		std::string	n5 = `""`,
		const AttributeValue &	v5 = `EmptyAttributeValue ()`,
		std::string	n6 = `""`,
		const AttributeValue &	v6 = `EmptyAttributeValue ()`,
		std::string	n7 = `""`,
		const AttributeValue &	v7 = `EmptyAttributeValue ()`
	)

Parameters

type	the type of the model to set
n0	the name of the attribute to set
v0	the value of the attribute to set
n1	the name of the attribute to set
v1	the value of the attribute to set
n2	the name of the attribute to set
v2	the value of the attribute to set
n3	the name of the attribute to set
v3	the value of the attribute to set
n4	the name of the attribute to set
v4	the value of the attribute to set
n5	the name of the attribute to set
v5	the value of the attribute to set
n6	the name of the attribute to set
v6	the value of the attribute to set
n7	the name of the attribute to set
v7	the value of the attribute to set