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 <string>
27 #include "ns3/attribute.h"
28 #include "ns3/object-factory.h"
29 #include "ns3/node-container.h"
30 #include "ns3/net-device-container.h"
31 #include "ns3/wifi-phy-standard.h"
32 #include "ns3/trace-helper.h"
33 #include "ns3/wifi-mac-helper.h"
34 
35 namespace ns3 {
36 
37 class WifiPhy;
38 class WifiNetDevice;
39 class Node;
40 
48 {
49 public:
50  virtual ~WifiPhyHelper ();
51 
65  virtual Ptr<WifiPhy> Create (Ptr<Node> node, Ptr<NetDevice> device) const = 0;
66 };
67 
68 
77 {
78 public:
79  virtual ~WifiHelper ();
80 
89  WifiHelper ();
90 
101  static WifiHelper Default (void) NS_DEPRECATED;
102 
125  void SetRemoteStationManager (std::string type,
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 ());
141  const WifiMacHelper &mac, NodeContainer c) const;
148  virtual NetDeviceContainer Install (const WifiPhyHelper &phy,
149  const WifiMacHelper &mac, Ptr<Node> node) const;
156  virtual NetDeviceContainer Install (const WifiPhyHelper &phy,
157  const WifiMacHelper &mac, std::string nodeName) const;
182  virtual void SetStandard (enum WifiPhyStandard standard);
183 
187  static void EnableLogComponents (void);
188 
203  int64_t AssignStreams (NetDeviceContainer c, int64_t stream);
204 
205 
206 protected:
209 };
210 
211 } //namespace ns3
212 
213 #endif /* WIFI_HELPER_H */
virtual ~WifiPhyHelper()
Definition: wifi-helper.cc:48
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:71
virtual ~WifiHelper()
Definition: wifi-helper.cc:52
Hold a value for an Attribute.
Definition: attribute.h:68
create PHY objects
Definition: wifi-helper.h:47
static WifiHelper Default(void) NS_DEPRECATED
Definition: wifi-helper.cc:63
helps to create WifiNetDevice objects
Definition: wifi-helper.h:76
WifiHelper()
Create a Wifi helper in an empty state: all its parameters must be set before calling ns3::WifiHelper...
Definition: wifi-helper.cc:56
virtual NetDeviceContainer Install(const WifiPhyHelper &phy, const WifiMacHelper &mac, NodeContainer c) const
Definition: wifi-helper.cc:100
WifiPhyStandard
Identifies the PHY specification that a Wifi device is configured to use.
tuple phy
Definition: third.py:86
A class for an empty attribute value.
Definition: attribute.h:234
holds a vector of ns3::NetDevice pointers
virtual void SetStandard(enum WifiPhyStandard standard)
Definition: wifi-helper.cc:94
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:175
tuple mac
Definition: third.py:92
Every class exported by the ns3 library is enclosed in the ns3 namespace.
keep track of a set of node pointers.
ObjectFactory m_stationManager
Definition: wifi-helper.h:207
create MAC layers for a ns3::WifiNetDevice.
Instantiate subclasses of ns3::Object.
#define NS_DEPRECATED
Mark a function as deprecated.
Definition: deprecated.h:47
static void EnableLogComponents(void)
Helper to enable all WifiNetDevice log components with one statement.
Definition: wifi-helper.cc:140
virtual Ptr< WifiPhy > Create(Ptr< Node > node, Ptr< NetDevice > device) const =0
enum WifiPhyStandard m_standard
Definition: wifi-helper.h:208