A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
ns3::SpectrumPhyHelper Class Reference
Spectrum Models

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 ns3::ObjectFactory::Create(), Create(), m_channel, m_phy, and NS_ASSERT.

Referenced by visualizer.ipython_view.ConsoleView::__init__(), show_last_packets.ShowLastPackets.PacketList::__init__(), visualizer.ipython_view.ConsoleView::_write(), test-ns3.NS3BaseTestCase::config_ok(), Create(), visualizer.svgitem.SvgItem::do_set_property(), SetChannel(), test-ns3.NS3StyleTestCase::setUp(), test-ns3.NS3BaseTestCase::setUp(), test-ns3.NS3ExpectedUseTestCase::setUp(), test-ns3.NS3BuildBaseTestCase::test_01_BuildExistingTargets(), test-ns3.NS3ExpectedUseTestCase::test_01_BuildProject(), test-ns3.NS3StyleTestCase::test_01_CheckCMakeFormat(), test-ns3.NS3QualityControlTestCase::test_01_CheckForDeadLinksInSources(), test-ns3.NS3DependenciesTestCase::test_01_CheckIfIncludedHeadersMatchLinkedModules(), test-ns3.NS3ConfigureBuildProfileTestCase::test_01_Debug(), test-ns3.NS3CommonSettingsTestCase::test_01_NoOption(), test-ns3.NS3UnusedSourcesTestCase::test_01_UnusedExampleSources(), test-ns3.NS3ExpectedUseTestCase::test_02_BuildAndRunExistingExecutableTarget(), test-ns3.NS3BuildBaseTestCase::test_02_BuildNonExistingTargets(), test-ns3.NS3QualityControlTestCase::test_02_MemoryCheckWithSanitizers(), test-ns3.NS3CommonSettingsTestCase::test_02_NoTaskLines(), test-ns3.NS3ConfigureBuildProfileTestCase::test_02_Release(), test-ns3.NS3ConfigureTestCase::test_02_Tests(), test-ns3.NS3UnusedSourcesTestCase::test_02_UnusedModuleSources(), test-ns3.NS3ExpectedUseTestCase::test_03_BuildAndRunExistingLibraryTarget(), test-ns3.NS3BuildBaseTestCase::test_03_BuildProject(), test-ns3.NS3CommonSettingsTestCase::test_03_CheckConfig(), test-ns3.NS3QualityControlTestCase::test_03_CheckImageBrightness(), test-ns3.NS3ConfigureBuildProfileTestCase::test_03_Optimized(), test-ns3.NS3UnusedSourcesTestCase::test_03_UnusedUtilsSources(), test-ns3.NS3ExpectedUseTestCase::test_04_BuildAndRunNonExistingTarget(), test-ns3.NS3BuildBaseTestCase::test_04_BuildProjectNoTaskLines(), test-ns3.NS3QualityControlTestCase::test_04_CheckForBrokenLogs(), test-ns3.NS3CommonSettingsTestCase::test_04_CheckProfile(), test-ns3.NS3ConfigureTestCase::test_04_DisableModules(), test-ns3.NS3ConfigureBuildProfileTestCase::test_04_Typo(), test-ns3.NS3BuildBaseTestCase::test_05_BreakBuild(), test-ns3.NS3CommonSettingsTestCase::test_05_CheckVersion(), test-ns3.NS3ConfigureTestCase::test_05_EnableModulesComma(), test-ns3.NS3ExpectedUseTestCase::test_05_RunNoBuildExistingExecutableTarget(), test-ns3.NS3ConfigureBuildProfileTestCase::test_05_TYPO(), test-ns3.NS3ConfigureTestCase::test_06_DisableModulesComma(), test-ns3.NS3ConfigureBuildProfileTestCase::test_06_OverwriteDefaultSettings(), test-ns3.NS3ExpectedUseTestCase::test_06_RunNoBuildExistingLibraryTarget(), test-ns3.NS3BuildBaseTestCase::test_06_TestVersionFile(), test-ns3.NS3BuildBaseTestCase::test_07_OutputDirectory(), test-ns3.NS3ExpectedUseTestCase::test_07_RunNoBuildNonExistingExecutableTarget(), test-ns3.NS3ConfigureTestCase::test_08_DryRun(), test-ns3.NS3BuildBaseTestCase::test_08_InstallationAndUninstallation(), test-ns3.NS3ExpectedUseTestCase::test_08_RunNoBuildGdb(), test-ns3.NS3ConfigureTestCase::test_09_PropagationOfReturnCode(), test-ns3.NS3ExpectedUseTestCase::test_09_RunNoBuildValgrind(), test-ns3.NS3BuildBaseTestCase::test_09_Scratches(), test-ns3.NS3BuildBaseTestCase::test_10_AmbiguityCheck(), test-ns3.NS3ConfigureTestCase::test_10_CheckConfig(), test-ns3.NS3ExpectedUseTestCase::test_10_DoxygenWithBuild(), test-ns3.NS3ConfigureTestCase::test_11_CheckProfile(), test-ns3.NS3ExpectedUseTestCase::test_11_DoxygenWithoutBuild(), test-ns3.NS3BuildBaseTestCase::test_11_StaticBuilds(), test-ns3.NS3ConfigureTestCase::test_12_CheckVersion(), test-ns3.NS3BuildBaseTestCase::test_12_CppyyBindings(), test-ns3.NS3ExpectedUseTestCase::test_12_SphinxDocumentation(), test-ns3.NS3ExpectedUseTestCase::test_13_Documentation(), test-ns3.NS3BuildBaseTestCase::test_13_FetchOptionalComponents(), test-ns3.NS3ConfigureTestCase::test_13_Scratches(), test-ns3.NS3ExpectedUseTestCase::test_14_EnableSudo(), test-ns3.NS3BuildBaseTestCase::test_14_LinkContribModuleToSrcModule(), test-ns3.NS3ConfigureTestCase::test_14_MpiCommandTemplate(), test-ns3.NS3ExpectedUseTestCase::test_15_CommandTemplate(), test-ns3.NS3ConfigureTestCase::test_15_InvalidLibrariesToLink(), test-ns3.NS3ExpectedUseTestCase::test_16_ForwardArgumentsToRunTargets(), test-ns3.NS3ConfigureTestCase::test_16_LibrariesContainingLib(), test-ns3.NS3ConfigureTestCase::test_17_CMakePerformanceTracing(), test-ns3.NS3ExpectedUseTestCase::test_17_RunNoBuildLldb(), test-ns3.NS3ConfigureTestCase::test_18_CheckBuildVersionAndVersionCache(), test-ns3.NS3ExpectedUseTestCase::test_18_CpmAndVcpkgManagers(), test-ns3.NS3ConfigureTestCase::test_19_FilterModuleExamplesAndTests(), test-ns3.NS3ConfigureTestCase::test_20_CheckFastLinkers(), test-ns3.NS3ConfigureTestCase::test_21_ClangTimeTrace(), test-ns3.NS3ConfigureTestCase::test_22_NinjaTrace(), test-ns3.NS3ConfigureTestCase::test_23_PrecompiledHeaders(), test-ns3.NS3ConfigureTestCase::test_24_CheckTestSettings(), python-unit-tests.TestSimulator::testAttributes(), python-unit-tests.TestSimulator::testCommandLine(), python-unit-tests.TestSimulator::testIdentity(), python-unit-tests.TestSimulator::testSchedule(), python-unit-tests.TestSimulator::testScheduleDestroy(), python-unit-tests.TestSimulator::testSubclass(), python-unit-tests.TestSimulator::testTimeComparison(), python-unit-tests.TestSimulator::testTimeNumericOperations(), python-unit-tests.TestSimulator::testTypeId(), and visualizer.core.Node::tooltip_query().

+ Here is the call graph for this function:

◆ 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 Create(), 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
namethe type of SpectrumPhy to use
[in]argsName and AttributeValue pairs to set.

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

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

+ Here is the call graph for this function:

◆ SetPhyAttribute()

void ns3::SpectrumPhyHelper::SetPhyAttribute ( std::string  name,
const AttributeValue &  v 
)
Parameters
namethe name of the attribute to set
vthe 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, and ns3::ObjectFactory::Set().

+ Here is the call graph for this function:

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: