ns3::SpectrumAnalyzerHelper Class Reference

Public Member Functions
void	EnableAsciiAll (std::string prefix)
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)
void	SetChannel (std::string channelName)
void	SetDeviceAttribute (std::string n1, const AttributeValue &v1)
void	SetPhyAttribute (std::string name, const AttributeValue &v)
void	SetRxSpectrumModel (Ptr< SpectrumModel > m)

Private Attributes
ObjectFactory	m_antenna
Ptr< SpectrumChannel >	m_channel
ObjectFactory	m_device
ObjectFactory	m_phy
std::string	m_prefix
Ptr< SpectrumModel >	m_rxSpectrumModel

Detailed Description

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

Member Function Documentation

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 146 of file spectrum-analyzer-helper.cc.

References NS_LOG_FUNCTION.

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 155 of file spectrum-analyzer-helper.cc.

References ns3::NetDeviceContainer::Add(), ns3::Node::AddDevice(), ns3::NodeContainer::Begin(), ns3::Config::ConnectWithoutContext(), ns3::ObjectFactory::Create(), ns3::AsciiTraceHelper::CreateFileStream(), ns3::NodeContainer::End(), ns3::AsciiTraceHelper::GetFilenameFromDevice(), ns3::Node::GetId(), ns3::Object::GetObject(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by Install().

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 215 of file spectrum-analyzer-helper.cc.

References Install(), and NS_LOG_FUNCTION.

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 222 of file spectrum-analyzer-helper.cc.

References Install(), and NS_LOG_FUNCTION.

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

Configure the AntennaModel instance for each new device to be created

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

References ns3::ObjectFactory::Set(), and ns3::ObjectFactory::SetTypeId().

void ns3::SpectrumAnalyzerHelper::SetChannel

(

Ptr< SpectrumChannel >

channel

)

set the SpectrumChannel that will be used by SpectrumPhy instances created by this helper

Parameters

channel

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

References NS_LOG_FUNCTION.

void ns3::SpectrumAnalyzerHelper::SetChannel

(

std::string

channelName

)

set the SpectrumChannel that will be used by SpectrumPhy instances created by this helper

Parameters

channelName

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

References NS_LOG_FUNCTION.

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

Parameters

n1	the name of the attribute to set
v1	the value of the attribute to set

Set these attributes on each AlohaNoackNetDevice created

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

References NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().

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

Parameters

name	the name of the attribute to set
v	the value of the attribute

Set these attributes on each HdOfdmSpectrumPhy instance to be created

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

References NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().

void ns3::SpectrumAnalyzerHelper::SetRxSpectrumModel

(

Ptr< SpectrumModel >

m

)

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

Parameters

m

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

References NS_LOG_FUNCTION.

---

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

• src/spectrum/helper/spectrum-analyzer-helper.h
• src/spectrum/helper/spectrum-analyzer-helper.cc