ns3::SpectrumPhyHelper Class Reference

Create and configure several SpectrumPhy instances and connect them to a channel. More...

#include "spectrum-helper.h"

Collaboration diagram for ns3::SpectrumPhyHelper:

Public Member Functions
Ptr< SpectrumPhy >	Create (Ptr< Node > node, Ptr< NetDevice > device) const
void	SetChannel (Ptr< SpectrumChannel > channel)
	set the channel that will be used by SpectrumPhy instances created by this helper
void	SetChannel (std::string channelName)
	set the channel that will be used by SpectrumPhy instances created by this helper
template<typename... Ts>
void	SetPhy (std::string name, Ts &&... args)
void	SetPhyAttribute (std::string name, const AttributeValue &v)

Private Attributes
Ptr< SpectrumChannel >	m_channel
	Channel.
ObjectFactory	m_phy
	Object factory for the phy objects.

Detailed Description

Create and configure several SpectrumPhy instances and connect them to a channel.

Definition at line 117 of file spectrum-helper.h.

Member Function Documentation

Create()

Ptr< SpectrumPhy > ns3::SpectrumPhyHelper::Create	(	Ptr< Node >	node,
		Ptr< NetDevice >	device ) const

Parameters

node
device

Returns

a newly created SpectrumPhy instance

Definition at line 77 of file spectrum-helper.cc.

References m_channel, m_phy, and NS_ASSERT.

SetChannel() [1/2]

void ns3::SpectrumPhyHelper::SetChannel

(

Ptr< SpectrumChannel >

channel

)

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

Parameters

channel

Definition at line 58 of file spectrum-helper.cc.

References m_channel.

SetChannel() [2/2]

void ns3::SpectrumPhyHelper::SetChannel

(

std::string

channelName

)

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

Parameters

channelName

Definition at line 64 of file spectrum-helper.cc.

References ns3::Names::Find(), and m_channel.

Here is the call graph for this function:

SetPhy()

template<typename... Ts>

void ns3::SpectrumPhyHelper::SetPhy	(	std::string	name,
		Ts &&...	args )

Template Parameters

Ts	[deduced] Argument types

Parameters

	name	the type of SpectrumPhy to use
[in]	args	Name and AttributeValue pairs to set.

Definition at line 203 of file spectrum-helper.h.

References m_phy.

SetPhyAttribute()

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

Parameters

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

Set an attribute of the SpectrumPhy instances to be created

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

References m_phy.

Member Data Documentation

m_channel

Ptr<SpectrumChannel> ns3::SpectrumPhyHelper::m_channel

private

Channel.

Definition at line 161 of file spectrum-helper.h.

Referenced by Create(), SetChannel(), and SetChannel().

m_phy

ObjectFactory ns3::SpectrumPhyHelper::m_phy

private

Object factory for the phy objects.

Definition at line 160 of file spectrum-helper.h.

Referenced by Create(), SetPhy(), and SetPhyAttribute().

---

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

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