A Discrete-Event Network Simulator
API
wifi-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 INRIA
4  * Copyright (c) 2009 MIRKO BANCHI
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation;
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
20  * Mirko Banchi <mk.banchi@gmail.com>
21  */
22 
23 #ifndef WIFI_HELPER_H
24 #define WIFI_HELPER_H
25 
26 #include "ns3/trace-helper.h"
27 #include "ns3/wifi-phy.h"
28 #include "ns3/qos-utils.h"
29 #include "wifi-mac-helper.h"
30 #include <functional>
31 
32 namespace ns3 {
33 
34 class WifiNetDevice;
35 class Node;
36 class RadiotapHeader;
37 class QueueItem;
38 
47 {
48 public:
49  WifiPhyHelper ();
50  virtual ~WifiPhyHelper ();
51 
65  virtual Ptr<WifiPhy> Create (Ptr<Node> node, Ptr<NetDevice> device) const = 0;
66 
73  void Set (std::string name, const AttributeValue &v);
95  void SetErrorRateModel (std::string name,
96  std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
97  std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
98  std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
99  std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
100  std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
101  std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
102  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
103  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
125  void SetFrameCaptureModel (std::string name,
126  std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
127  std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
128  std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
129  std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
130  std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
131  std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
132  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
133  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
155  void SetPreambleDetectionModel (std::string name,
156  std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
157  std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
158  std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
159  std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
160  std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
161  std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
162  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
163  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
164 
169 
176  {
180  };
181 
192 
201 
202 
203 protected:
214  Ptr<const Packet> packet,
215  uint16_t channelFreqMhz,
216  WifiTxVector txVector,
217  MpduInfo aMpdu);
229  Ptr<const Packet> packet,
230  uint16_t channelFreqMhz,
231  WifiTxVector txVector,
232  MpduInfo aMpdu,
233  SignalNoiseDbm signalNoise);
234 
239 
240 
241 private:
251  static void GetRadiotapHeader (RadiotapHeader &header,
252  Ptr<Packet> packet,
253  uint16_t channelFreqMhz,
254  WifiTxVector txVector,
255  MpduInfo aMpdu);
256 
267  static void GetRadiotapHeader (RadiotapHeader &header,
268  Ptr<Packet> packet,
269  uint16_t channelFreqMhz,
270  WifiTxVector txVector,
271  MpduInfo aMpdu,
272  SignalNoiseDbm signalNoise);
273 
285  virtual void EnablePcapInternal (std::string prefix,
286  Ptr<NetDevice> nd,
287  bool promiscuous,
288  bool explicitFilename);
289 
301  virtual void EnableAsciiInternal (Ptr<OutputStreamWrapper> stream,
302  std::string prefix,
303  Ptr<NetDevice> nd,
304  bool explicitFilename);
305 
307 };
308 
309 
318 {
319 public:
320  virtual ~WifiHelper ();
321 
330  WifiHelper ();
331 
354  void SetRemoteStationManager (std::string type,
355  std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
356  std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
357  std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
358  std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
359  std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
360  std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
361  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
362  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
363 
386  void SetObssPdAlgorithm (std::string type,
387  std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
388  std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
389  std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
390  std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
391  std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
392  std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
393  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
394  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
395 
419  void SetAckPolicySelectorForAc (AcIndex ac, std::string type,
420  std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
421  std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
422  std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
423  std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
424  std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
425  std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
426  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
427  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
428 
430  typedef std::function<std::size_t (Ptr<QueueItem>)> SelectQueueCallback;
431 
447  virtual Install (const WifiPhyHelper &phy,
448  const WifiMacHelper &mac,
450  NodeContainer::Iterator last) const;
458  const WifiMacHelper &mac, NodeContainer c) const;
466  const WifiMacHelper &mac, Ptr<Node> node) const;
474  const WifiMacHelper &mac, std::string nodeName) const;
499  virtual void SetStandard (WifiStandard standard);
500 
504  static void EnableLogComponents (void);
505 
520  int64_t AssignStreams (NetDeviceContainer c, int64_t stream);
521 
522 
523 protected:
529 };
530 
531 } //namespace ns3
532 
533 #endif /* WIFI_HELPER_H */
virtual ~WifiPhyHelper()
Definition: wifi-helper.cc:138
MpduInfo structure.
Definition: wifi-phy.h:123
Base class providing common user-level ascii trace operations for helpers representing net devices...
Definition: trace-helper.h:641
void Set(std::string name, const AttributeValue &v)
Definition: wifi-helper.cc:143
void SetPreambleDetectionModel(std::string name, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
Definition: wifi-helper.cc:195
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
virtual NetDeviceContainer Install(const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer::Iterator first, NodeContainer::Iterator last) const
Definition: wifi-helper.cc:759
void SetObssPdAlgorithm(std::string type, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
Definition: wifi-helper.cc:701
std::vector< Ptr< Node > >::const_iterator Iterator
Node container iterator.
void SetRemoteStationManager(std::string type, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
Definition: wifi-helper.cc:678
Radiotap header implementation.
virtual ~WifiHelper()
Definition: wifi-helper.cc:662
Hold a value for an Attribute.
Definition: attribute.h:68
create PHY objects
Definition: wifi-helper.h:45
PcapHelper::DataLinkType m_pcapDlt
PCAP data link type.
Definition: wifi-helper.h:306
Base class providing common user-level pcap operations for helpers representing net devices...
Definition: trace-helper.h:552
ObjectFactory m_errorRateModel
error rate model
Definition: wifi-helper.h:236
helps to create WifiNetDevice objects
Definition: wifi-helper.h:317
static void GetRadiotapHeader(RadiotapHeader &header, Ptr< Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu)
Get the Radiotap header for a transmitted packet.
Definition: wifi-helper.cc:305
WifiHelper()
Create a Wifi helper in an empty state: all its parameters must be set before calling ns3::WifiHelper...
Definition: wifi-helper.cc:666
virtual void EnableAsciiInternal(Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< NetDevice > nd, bool explicitFilename)
Enable ASCII trace output on the indicated net device.
Definition: wifi-helper.cc:587
phy
Definition: third.py:93
ObjectFactory m_preambleDetectionModel
preamble detection model
Definition: wifi-helper.h:238
static void PcapSniffTxEvent(Ptr< PcapFileWrapper > file, Ptr< const Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu)
Definition: wifi-helper.cc:224
DataLinkType
This enumeration holds the data link types that will be written to the pcap file. ...
Definition: trace-helper.h:50
A class for an empty attribute value.
Definition: attribute.h:232
holds a vector of ns3::NetDevice pointers
mac
Definition: third.py:99
static void PcapSniffRxEvent(Ptr< PcapFileWrapper > file, Ptr< const Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu, SignalNoiseDbm signalNoise)
Definition: wifi-helper.cc:257
void SetFrameCaptureModel(std::string name, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
Definition: wifi-helper.cc:172
int64_t AssignStreams(NetDeviceContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by the PHY and MAC aspects ...
Definition: wifi-helper.cc:952
ObjectFactory m_obssPdAlgorithm
OBSS_PD algorithm.
Definition: wifi-helper.h:528
PcapHelper::DataLinkType GetPcapDataLinkType(void) const
Get the data link type of PCAP traces to be used.
Definition: wifi-helper.cc:545
Include Prism monitor mode information.
Definition: wifi-helper.h:178
double f(double x, void *params)
Definition: 80211b.c:70
Every class exported by the ns3 library is enclosed in the ns3 namespace.
WifiStandard
Identifies the allowed configurations that a Wifi device is configured to use.
keep track of a set of node pointers.
ObjectFactory m_ackPolicySelector[4]
ack policy selector for all ACs
Definition: wifi-helper.h:525
virtual void SetStandard(WifiStandard standard)
Definition: wifi-helper.cc:747
SelectQueueCallback m_selectQueueCallback
select queue callback
Definition: wifi-helper.h:527
ObjectFactory m_stationManager
station manager
Definition: wifi-helper.h:524
create MAC layers for a ns3::WifiNetDevice.
void SetPcapDataLinkType(SupportedPcapDataLinkTypes dlt)
Set the data link type of PCAP traces to be used.
Definition: wifi-helper.cc:526
void SetErrorRateModel(std::string name, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
Definition: wifi-helper.cc:149
virtual void EnablePcapInternal(std::string prefix, Ptr< NetDevice > nd, bool promiscuous, bool explicitFilename)
Enable pcap output the indicated net device.
Definition: wifi-helper.cc:551
ObjectFactory m_phy
PHY object.
Definition: wifi-helper.h:235
Instantiate subclasses of ns3::Object.
static void EnableLogComponents(void)
Helper to enable all WifiNetDevice log components with one statement.
Definition: wifi-helper.cc:890
virtual Ptr< WifiPhy > Create(Ptr< Node > node, Ptr< NetDevice > device) const =0
void SetSelectQueueCallback(SelectQueueCallback f)
Definition: wifi-helper.cc:753
SignalNoiseDbm structure.
Definition: wifi-phy.h:116
IEEE 802.11 Wireless LAN headers on packets.
Definition: wifi-helper.h:177
ObjectFactory m_frameCaptureModel
frame capture model
Definition: wifi-helper.h:237
std::function< std::size_t(Ptr< QueueItem >)> SelectQueueCallback
Callback invoked to determine the MAC queue selected for a given packet.
Definition: wifi-helper.h:430
SupportedPcapDataLinkTypes
An enumeration of the pcap data link types (DLTs) which this helper supports.
Definition: wifi-helper.h:175
void DisablePreambleDetectionModel()
Disable the preamble detection model.
Definition: wifi-helper.cc:218
Definition: first.py:1
WifiStandard m_standard
wifi standard
Definition: wifi-helper.h:526
void SetAckPolicySelectorForAc(AcIndex ac, std::string type, std::string n0="", const AttributeValue &v0=EmptyAttributeValue(), std::string n1="", const AttributeValue &v1=EmptyAttributeValue(), std::string n2="", const AttributeValue &v2=EmptyAttributeValue(), std::string n3="", const AttributeValue &v3=EmptyAttributeValue(), std::string n4="", const AttributeValue &v4=EmptyAttributeValue(), std::string n5="", const AttributeValue &v5=EmptyAttributeValue(), std::string n6="", const AttributeValue &v6=EmptyAttributeValue(), std::string n7="", const AttributeValue &v7=EmptyAttributeValue())
Definition: wifi-helper.cc:724
Include Radiotap link layer information.
Definition: wifi-helper.h:179
AcIndex
This enumeration defines the Access Categories as an enumeration with values corresponding to the AC ...
Definition: qos-utils.h:38