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 "wifi-mac-helper.h"
29 #include <functional>
30 
31 namespace ns3 {
32 
33 class WifiNetDevice;
34 class Node;
35 class RadiotapHeader;
36 class QueueItem;
37 
46 {
47 public:
48  WifiPhyHelper ();
49  virtual ~WifiPhyHelper ();
50 
64  virtual Ptr<WifiPhy> Create (Ptr<Node> node, Ptr<NetDevice> device) const = 0;
65 
72  void Set (std::string name, const AttributeValue &v);
94  void SetErrorRateModel (std::string name,
95  std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
96  std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
97  std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
98  std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
99  std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
100  std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
101  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
102  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
124  void SetFrameCaptureModel (std::string name,
125  std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
126  std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
127  std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
128  std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
129  std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
130  std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
131  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
132  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
154  void SetPreambleDetectionModel (std::string name,
155  std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
156  std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
157  std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
158  std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
159  std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
160  std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
161  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
162  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
163 
168 
175  {
179  };
180 
191 
200 
201 
202 protected:
213  Ptr<const Packet> packet,
214  uint16_t channelFreqMhz,
215  WifiTxVector txVector,
216  MpduInfo aMpdu);
228  Ptr<const Packet> packet,
229  uint16_t channelFreqMhz,
230  WifiTxVector txVector,
231  MpduInfo aMpdu,
232  SignalNoiseDbm signalNoise);
233 
238 
239 
240 private:
252  uint16_t channelFreqMhz,
253  WifiTxVector txVector,
254  MpduInfo aMpdu);
255 
267  virtual void EnablePcapInternal (std::string prefix,
268  Ptr<NetDevice> nd,
269  bool promiscuous,
270  bool explicitFilename);
271 
283  virtual void EnableAsciiInternal (Ptr<OutputStreamWrapper> stream,
284  std::string prefix,
285  Ptr<NetDevice> nd,
286  bool explicitFilename);
287 
289 };
290 
291 
300 {
301 public:
302  virtual ~WifiHelper ();
303 
312  WifiHelper ();
313 
336  void SetRemoteStationManager (std::string type,
337  std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
338  std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
339  std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
340  std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
341  std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
342  std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
343  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
344  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
345 
368  void SetObssPdAlgorithm (std::string type,
369  std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
370  std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
371  std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
372  std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
373  std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
374  std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
375  std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
376  std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
377 
379  typedef std::function<std::size_t (Ptr<QueueItem>)> SelectQueueCallback;
380 
396  virtual Install (const WifiPhyHelper &phy,
397  const WifiMacHelper &mac,
399  NodeContainer::Iterator last) const;
407  const WifiMacHelper &mac, NodeContainer c) const;
415  const WifiMacHelper &mac, Ptr<Node> node) const;
423  const WifiMacHelper &mac, std::string nodeName) const;
448  virtual void SetStandard (WifiPhyStandard standard);
449 
453  static void EnableLogComponents (void);
454 
469  int64_t AssignStreams (NetDeviceContainer c, int64_t stream);
470 
471 
472 protected:
477 };
478 
479 } //namespace ns3
480 
481 #endif /* WIFI_HELPER_H */
virtual ~WifiPhyHelper()
Definition: wifi-helper.cc:137
MpduInfo structure.
Definition: wifi-phy.h:71
Base class providing common user-level ascii trace operations for helpers representing net devices...
Definition: trace-helper.h:641
WifiPhyStandard m_standard
wifi standard
Definition: wifi-helper.h:474
void Set(std::string name, const AttributeValue &v)
Definition: wifi-helper.cc:142
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:194
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:719
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:684
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:661
Radiotap header implementation.
virtual ~WifiHelper()
Definition: wifi-helper.cc:649
Hold a value for an Attribute.
Definition: attribute.h:68
create PHY objects
Definition: wifi-helper.h:44
PcapHelper::DataLinkType m_pcapDlt
PCAP data link type.
Definition: wifi-helper.h:288
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:235
helps to create WifiNetDevice objects
Definition: wifi-helper.h:299
WifiHelper()
Create a Wifi helper in an empty state: all its parameters must be set before calling ns3::WifiHelper...
Definition: wifi-helper.cc:653
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:574
phy
Definition: third.py:93
ObjectFactory m_preambleDetectionModel
preamble detection model
Definition: wifi-helper.h:237
static void PcapSniffTxEvent(Ptr< PcapFileWrapper > file, Ptr< const Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu)
Definition: wifi-helper.cc:223
DataLinkType
This enumeration holds the data link types that will be written to the pcap file. ...
Definition: trace-helper.h:50
virtual void SetStandard(WifiPhyStandard standard)
Definition: wifi-helper.cc:707
WifiPhyStandard
Identifies the PHY specification that a Wifi device is configured to use.
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:255
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:171
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:891
ObjectFactory m_obssPdAlgorithm
OBSS PD algorithm.
Definition: wifi-helper.h:476
PcapHelper::DataLinkType GetPcapDataLinkType(void) const
Get the data link type of PCAP traces to be used.
Definition: wifi-helper.cc:532
Include Prism monitor mode information.
Definition: wifi-helper.h:177
double f(double x, void *params)
Definition: 80211b.c:70
static RadiotapHeader GetRadiotapHeader(Ptr< Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu)
Get the radiotap header.
Definition: wifi-helper.cc:290
Every class exported by the ns3 library is enclosed in the ns3 namespace.
keep track of a set of node pointers.
SelectQueueCallback m_selectQueueCallback
select queue callback
Definition: wifi-helper.h:475
ObjectFactory m_stationManager
station manager
Definition: wifi-helper.h:473
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:513
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:148
virtual void EnablePcapInternal(std::string prefix, Ptr< NetDevice > nd, bool promiscuous, bool explicitFilename)
Enable pcap output the indicated net device.
Definition: wifi-helper.cc:538
ObjectFactory m_phy
PHY object.
Definition: wifi-helper.h:234
Instantiate subclasses of ns3::Object.
static void EnableLogComponents(void)
Helper to enable all WifiNetDevice log components with one statement.
Definition: wifi-helper.cc:831
virtual Ptr< WifiPhy > Create(Ptr< Node > node, Ptr< NetDevice > device) const =0
void SetSelectQueueCallback(SelectQueueCallback f)
Definition: wifi-helper.cc:713
SignalNoiseDbm structure.
Definition: wifi-phy.h:64
IEEE 802.11 Wireless LAN headers on packets.
Definition: wifi-helper.h:176
ObjectFactory m_frameCaptureModel
frame capture model
Definition: wifi-helper.h:236
std::function< std::size_t(Ptr< QueueItem >)> SelectQueueCallback
Callback invoked to determine the MAC queue selected for a given packet.
Definition: wifi-helper.h:379
SupportedPcapDataLinkTypes
An enumeration of the pcap data link types (DLTs) which this helper supports.
Definition: wifi-helper.h:174
void DisablePreambleDetectionModel()
Disable the preamble detection model.
Definition: wifi-helper.cc:217
Definition: first.py:1
Include Radiotap link layer information.
Definition: wifi-helper.h:178