A Discrete-Event Network Simulator
API
waveform-generator-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 WAVEFORM_GENERATOR_HELPER_H
21 #define WAVEFORM_GENERATOR_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 
43 {
44  public:
47 
54 
60  void SetChannel(std::string channelName);
61 
68 
75  void SetPhyAttribute(std::string name, const AttributeValue& v);
76 
83  void SetDeviceAttribute(std::string n1, const AttributeValue& v1);
84 
92  template <typename... Ts>
93  void SetAntenna(std::string type, Ts&&... args);
94 
109  NetDeviceContainer Install(std::string nodeName) const;
110 
111  protected:
117 };
118 
119 /***************************************************************
120  * Implementation of the templates declared above.
121  ***************************************************************/
122 
123 template <typename... Ts>
124 void
126 {
127  m_antenna = ObjectFactory(type, std::forward<Ts>(args)...);
128 }
129 
130 } // namespace ns3
131 
132 #endif /* WAVEFORM_GENERATOR_HELPER_H */
Hold a value for an Attribute.
Definition: attribute.h:70
holds a vector of ns3::NetDevice pointers
keep track of a set of node pointers.
Instantiate subclasses of ns3::Object.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
Create a Waveform generator, which can be used to inject specific noise in the channel.
void SetTxPowerSpectralDensity(Ptr< SpectrumValue > txPsd)
void SetAntenna(std::string type, Ts &&... args)
Ptr< SpectrumValue > m_txPsd
Tx power spectral density.
void SetDeviceAttribute(std::string n1, const AttributeValue &v1)
ObjectFactory m_phy
Object factory for the phy objects.
void SetChannel(Ptr< SpectrumChannel > channel)
set the SpectrumChannel that will be used by SpectrumPhy instances created by this helper
Ptr< SpectrumChannel > m_channel
Channel.
NetDeviceContainer Install(NodeContainer c) const
void SetPhyAttribute(std::string name, const AttributeValue &v)
ObjectFactory m_device
Object factory for the NetDevice objects.
ObjectFactory m_antenna
Object factory for the Antenna objects.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
channel
Definition: third.py:88