A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
spectrum-analyzer-helper.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2010 CTTC
3
*
4
* This program is free software; you can redistribute it and/or modify
5
* it under the terms of the GNU General Public License version 2 as
6
* published by the Free Software Foundation;
7
*
8
* This program is distributed in the hope that it will be useful,
9
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
* GNU General Public License for more details.
12
*
13
* You should have received a copy of the GNU General Public License
14
* along with this program; if not, write to the Free Software
15
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
*
17
* Author: Nicola Baldo <nbaldo@cttc.es>
18
*/
19
20
#ifndef SPECTRUM_ANALYZER_HELPER_H
21
#define SPECTRUM_ANALYZER_HELPER_H
22
23
#include <ns3/attribute.h>
24
#include <ns3/net-device-container.h>
25
#include <ns3/node-container.h>
26
#include <ns3/object-factory.h>
27
#include <ns3/queue.h>
28
29
#include <string>
30
31
namespace
ns3
32
{
33
34
class
SpectrumValue;
35
class
SpectrumChannel;
36
class
SpectrumModel;
37
42
class
SpectrumAnalyzerHelper
43
{
44
public
:
45
SpectrumAnalyzerHelper
();
46
~SpectrumAnalyzerHelper
();
47
53
void
SetChannel
(
Ptr<SpectrumChannel>
channel
);
54
60
void
SetChannel
(std::string channelName);
61
68
void
SetPhyAttribute
(std::string name,
const
AttributeValue
& v);
69
76
void
SetDeviceAttribute
(std::string n1,
const
AttributeValue
& v1);
77
85
template
<
typename
... Ts>
86
void
SetAntenna
(std::string
type
, Ts&&...
args
);
87
94
void
SetRxSpectrumModel
(
Ptr<SpectrumModel>
m
);
95
102
void
EnableAsciiAll
(std::string prefix);
103
108
NetDeviceContainer
Install
(
NodeContainer
c)
const
;
113
NetDeviceContainer
Install
(
Ptr<Node>
node)
const
;
118
NetDeviceContainer
Install
(std::string nodeName)
const
;
119
120
private
:
121
ObjectFactory
m_phy
;
122
ObjectFactory
m_device
;
123
ObjectFactory
m_antenna
;
124
125
Ptr<SpectrumChannel>
m_channel
;
126
Ptr<SpectrumModel>
m_rxSpectrumModel
;
127
std::string
m_prefix
;
128
};
129
130
/***************************************************************
131
* Implementation of the templates declared above.
132
***************************************************************/
133
134
template
<
typename
... Ts>
135
void
136
SpectrumAnalyzerHelper::SetAntenna
(std::string
type
, Ts&&...
args
)
137
{
138
m_antenna
=
ObjectFactory
(
type
, std::forward<Ts>(
args
)...);
139
}
140
141
}
// namespace ns3
142
143
#endif
/* SPECTRUM_ANALYZER_HELPER_H */
ns3::AttributeValue
Hold a value for an Attribute.
Definition:
attribute.h:70
ns3::NetDeviceContainer
holds a vector of ns3::NetDevice pointers
Definition:
net-device-container.h:43
ns3::NodeContainer
keep track of a set of node pointers.
Definition:
node-container.h:40
ns3::ObjectFactory
Instantiate subclasses of ns3::Object.
Definition:
object-factory.h:48
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:77
ns3::SpectrumAnalyzerHelper
Class to allow the Spectrum Analysis.
Definition:
spectrum-analyzer-helper.h:43
ns3::SpectrumAnalyzerHelper::m_phy
ObjectFactory m_phy
Object factory for the phy objects.
Definition:
spectrum-analyzer-helper.h:121
ns3::SpectrumAnalyzerHelper::SetAntenna
void SetAntenna(std::string type, Ts &&... args)
Definition:
spectrum-analyzer-helper.h:136
ns3::SpectrumAnalyzerHelper::Install
NetDeviceContainer Install(NodeContainer c) const
Definition:
spectrum-analyzer-helper.cc:125
ns3::SpectrumAnalyzerHelper::m_rxSpectrumModel
Ptr< SpectrumModel > m_rxSpectrumModel
Spectrum model.
Definition:
spectrum-analyzer-helper.h:126
ns3::SpectrumAnalyzerHelper::SetPhyAttribute
void SetPhyAttribute(std::string name, const AttributeValue &v)
Definition:
spectrum-analyzer-helper.cc:97
ns3::SpectrumAnalyzerHelper::SetDeviceAttribute
void SetDeviceAttribute(std::string n1, const AttributeValue &v1)
Definition:
spectrum-analyzer-helper.cc:104
ns3::SpectrumAnalyzerHelper::SetChannel
void SetChannel(Ptr< SpectrumChannel > channel)
Set the SpectrumChannel that will be used by SpectrumPhy instances created by this helper.
Definition:
spectrum-analyzer-helper.cc:82
ns3::SpectrumAnalyzerHelper::m_antenna
ObjectFactory m_antenna
Object factory for the Antenna objects.
Definition:
spectrum-analyzer-helper.h:123
ns3::SpectrumAnalyzerHelper::~SpectrumAnalyzerHelper
~SpectrumAnalyzerHelper()
Definition:
spectrum-analyzer-helper.cc:76
ns3::SpectrumAnalyzerHelper::m_prefix
std::string m_prefix
Prefix for the output files.
Definition:
spectrum-analyzer-helper.h:127
ns3::SpectrumAnalyzerHelper::EnableAsciiAll
void EnableAsciiAll(std::string prefix)
Enable ASCII output.
Definition:
spectrum-analyzer-helper.cc:118
ns3::SpectrumAnalyzerHelper::SpectrumAnalyzerHelper
SpectrumAnalyzerHelper()
Definition:
spectrum-analyzer-helper.cc:68
ns3::SpectrumAnalyzerHelper::m_channel
Ptr< SpectrumChannel > m_channel
Channel.
Definition:
spectrum-analyzer-helper.h:125
ns3::SpectrumAnalyzerHelper::m_device
ObjectFactory m_device
Object factory for the NetDevice objects.
Definition:
spectrum-analyzer-helper.h:122
ns3::SpectrumAnalyzerHelper::SetRxSpectrumModel
void SetRxSpectrumModel(Ptr< SpectrumModel > m)
Set the spectrum model used by the created SpectrumAnalyzer instances to represent incoming signals.
Definition:
spectrum-analyzer-helper.cc:111
check-style-clang-format.args
args
Definition:
check-style-clang-format.py:754
check-style-clang-format.type
type
Definition:
check-style-clang-format.py:704
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
third.channel
channel
Definition:
third.py:88
two-ray-to-three-gpp-ch-calibration.m
m
Definition:
two-ray-to-three-gpp-ch-calibration.py:591
src
spectrum
helper
spectrum-analyzer-helper.h
Generated on Sun Mar 3 2024 17:11:08 for ns-3 by
1.9.1