A Discrete-Event Network Simulator
API
wifi-mac-helper.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016
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: Sébastien Deronne <sebastien.deronne@gmail.com>
18  */
19 
20 #ifndef WIFI_MAC_HELPER_H
21 #define WIFI_MAC_HELPER_H
22 
23 #include "ns3/object-factory.h"
24 #include "ns3/wifi-standards.h"
25 
26 namespace ns3
27 {
28 
29 class WifiMac;
30 class WifiNetDevice;
31 
48 {
49  public:
54  WifiMacHelper();
58  virtual ~WifiMacHelper();
59 
68  template <typename... Args>
69  void SetType(std::string type, Args&&... args);
70 
78  template <typename... Args>
79  void SetAssocManager(std::string type, Args&&... args);
80 
88  template <typename... Args>
89  void SetMacQueueScheduler(std::string type, Args&&... args);
90 
98  template <typename... Args>
99  void SetProtectionManager(std::string type, Args&&... args);
100 
108  template <typename... Args>
109  void SetAckManager(std::string type, Args&&... args);
110 
119  template <typename... Args>
120  void SetMultiUserScheduler(std::string type, Args&&... args);
121 
129  template <typename... Args>
130  void SetEmlsrManager(std::string type, Args&&... args);
131 
139  virtual Ptr<WifiMac> Create(Ptr<WifiNetDevice> device, WifiStandard standard) const;
140 
141  protected:
149 };
150 
151 } // namespace ns3
152 
153 /***************************************************************
154  * Implementation of the templates declared above.
155  ***************************************************************/
156 
157 namespace ns3
158 {
159 
160 template <typename... Args>
161 void
162 WifiMacHelper::SetType(std::string type, Args&&... args)
163 {
165  m_mac.Set(args...);
166 }
167 
168 template <typename... Args>
169 void
170 WifiMacHelper::SetAssocManager(std::string type, Args&&... args)
171 {
173  m_assocManager.Set(args...);
174 }
175 
176 template <typename... Args>
177 void
179 {
182 }
183 
184 template <typename... Args>
185 void
187 {
190 }
191 
192 template <typename... Args>
193 void
194 WifiMacHelper::SetAckManager(std::string type, Args&&... args)
195 {
197  m_ackManager.Set(args...);
198 }
199 
200 template <typename... Args>
201 void
203 {
205  m_muScheduler.Set(args...);
206 }
207 
208 template <typename... Args>
209 void
210 WifiMacHelper::SetEmlsrManager(std::string type, Args&&... args)
211 {
213  m_emlsrManager.Set(args...);
214 }
215 
216 } // namespace ns3
217 
218 #endif /* WIFI_MAC_HELPER_H */
Instantiate subclasses of ns3::Object.
void Set(const std::string &name, const AttributeValue &value, Args &&... args)
Set an attribute to be set during construction.
void SetTypeId(TypeId tid)
Set the TypeId of the Objects to be created by this factory.
create MAC layers for a ns3::WifiNetDevice.
ObjectFactory m_mac
MAC object factory.
ObjectFactory m_queueScheduler
MAC queue scheduler.
void SetAckManager(std::string type, Args &&... args)
Helper function used to set the Acknowledgment Manager.
virtual ~WifiMacHelper()
Destroy a WifiMacHelper.
virtual Ptr< WifiMac > Create(Ptr< WifiNetDevice > device, WifiStandard standard) const
ObjectFactory m_protectionManager
Factory to create a protection manager.
ObjectFactory m_muScheduler
Multi-user Scheduler object factory.
void SetProtectionManager(std::string type, Args &&... args)
Helper function used to set the Protection Manager.
void SetMacQueueScheduler(std::string type, Args &&... args)
Helper function used to set the MAC queue scheduler.
ObjectFactory m_assocManager
Association Manager.
WifiMacHelper()
Create a WifiMacHelper to make life easier for people who want to work with Wifi MAC layers.
ObjectFactory m_emlsrManager
EMLSR Manager object factory.
void SetAssocManager(std::string type, Args &&... args)
Helper function used to set the Association Manager.
void SetMultiUserScheduler(std::string type, Args &&... args)
Helper function used to set the Multi User Scheduler that can be aggregated to an HE AP's MAC.
void SetEmlsrManager(std::string type, Args &&... args)
Helper function used to set the EMLSR Manager that can be installed on an EHT non-AP MLD.
ObjectFactory m_ackManager
Factory to create an acknowledgment manager.
void SetType(std::string type, Args &&... args)
WifiStandard
Identifies the IEEE 802.11 specifications that a Wifi device can be configured to use.
Every class exported by the ns3 library is enclosed in the ns3 namespace.