A Discrete-Event Network Simulator
API
yans-wifi-helper.cc
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  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  * S├ębastien Deronne <sebastien.deronne@gmail.com>
20  */
21 
22 #include "ns3/trace-helper.h"
23 #include "yans-wifi-helper.h"
24 #include "ns3/error-rate-model.h"
25 #include "ns3/propagation-loss-model.h"
26 #include "ns3/propagation-delay-model.h"
27 #include "ns3/yans-wifi-channel.h"
28 #include "ns3/yans-wifi-phy.h"
29 #include "ns3/wifi-net-device.h"
30 #include "ns3/names.h"
31 #include "ns3/log.h"
32 
33 namespace ns3 {
34 
35 NS_LOG_COMPONENT_DEFINE ("YansWifiHelper");
36 
38 {
39 }
40 
43 {
44  YansWifiChannelHelper helper;
45  helper.SetPropagationDelay ("ns3::ConstantSpeedPropagationDelayModel");
46  helper.AddPropagationLoss ("ns3::LogDistancePropagationLossModel");
47  return helper;
48 }
49 
50 void
52  std::string n0, const AttributeValue &v0,
53  std::string n1, const AttributeValue &v1,
54  std::string n2, const AttributeValue &v2,
55  std::string n3, const AttributeValue &v3,
56  std::string n4, const AttributeValue &v4,
57  std::string n5, const AttributeValue &v5,
58  std::string n6, const AttributeValue &v6,
59  std::string n7, const AttributeValue &v7)
60 {
61  ObjectFactory factory;
62  factory.SetTypeId (type);
63  factory.Set (n0, v0);
64  factory.Set (n1, v1);
65  factory.Set (n2, v2);
66  factory.Set (n3, v3);
67  factory.Set (n4, v4);
68  factory.Set (n5, v5);
69  factory.Set (n6, v6);
70  factory.Set (n7, v7);
71  m_propagationLoss.push_back (factory);
72 }
73 
74 void
76  std::string n0, const AttributeValue &v0,
77  std::string n1, const AttributeValue &v1,
78  std::string n2, const AttributeValue &v2,
79  std::string n3, const AttributeValue &v3,
80  std::string n4, const AttributeValue &v4,
81  std::string n5, const AttributeValue &v5,
82  std::string n6, const AttributeValue &v6,
83  std::string n7, const AttributeValue &v7)
84 {
85  ObjectFactory factory;
86  factory.SetTypeId (type);
87  factory.Set (n0, v0);
88  factory.Set (n1, v1);
89  factory.Set (n2, v2);
90  factory.Set (n3, v3);
91  factory.Set (n4, v4);
92  factory.Set (n5, v5);
93  factory.Set (n6, v6);
94  factory.Set (n7, v7);
95  m_propagationDelay = factory;
96 }
97 
100 {
101  Ptr<YansWifiChannel> channel = CreateObject<YansWifiChannel> ();
102  Ptr<PropagationLossModel> prev = 0;
103  for (std::vector<ObjectFactory>::const_iterator i = m_propagationLoss.begin (); i != m_propagationLoss.end (); ++i)
104  {
105  Ptr<PropagationLossModel> cur = (*i).Create<PropagationLossModel> ();
106  if (prev != 0)
107  {
108  prev->SetNext (cur);
109  }
110  if (m_propagationLoss.begin () == i)
111  {
112  channel->SetPropagationLossModel (cur);
113  }
114  prev = cur;
115  }
117  channel->SetPropagationDelayModel (delay);
118  return channel;
119 }
120 
121 int64_t
123 {
124  return c->AssignStreams (stream);
125 }
126 
128  : m_channel (0)
129 {
130  m_phy.SetTypeId ("ns3::YansWifiPhy");
131 }
132 
135 {
136  YansWifiPhyHelper helper;
137  helper.SetErrorRateModel ("ns3::NistErrorRateModel");
138  return helper;
139 }
140 
141 void
143 {
144  m_channel = channel;
145 }
146 
147 void
148 YansWifiPhyHelper::SetChannel (std::string channelName)
149 {
150  Ptr<YansWifiChannel> channel = Names::Find<YansWifiChannel> (channelName);
151  m_channel = channel;
152 }
153 
156 {
159  phy->SetErrorRateModel (error);
160  phy->SetChannel (m_channel);
161  phy->SetDevice (device);
162  return phy;
163 }
164 
165 } //namespace ns3
void AddPropagationLoss(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())
tuple channel
Definition: third.py:85
void SetDevice(Ptr< NetDevice > device)
Sets the device this PHY is associated with.
Definition: wifi-phy.cc:598
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
void SetNext(Ptr< PropagationLossModel > next)
Enables a chain of loss models to act on the signal.
Ptr< YansWifiChannel > Create(void) const
Make it easy to create and manage PHY objects for the yans model.
static YansWifiChannelHelper Default(void)
Create a channel helper in a default working state.
Hold a value for an Attribute.
Definition: attribute.h:68
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
void SetTypeId(TypeId tid)
Set the TypeId of the Objects to be created by this factory.
static YansWifiPhyHelper Default(void)
Create a phy helper in a default working state.
ObjectFactory m_errorRateModel
Definition: wifi-helper.h:185
YansWifiChannelHelper()
Create a channel helper without any parameter set.
the interface for Wifi's error models
void SetChannel(Ptr< YansWifiChannel > channel)
tuple phy
Definition: third.py:86
Ptr< Object > Create(void) const
Create an Object instance of the configured TypeId.
calculate a propagation delay.
YansWifiPhyHelper()
Create a phy helper without any parameter set.
void SetChannel(Ptr< YansWifiChannel > channel)
Set the YansWifiChannel this YansWifiPhy is to be connected to.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
802.11 PHY layer modelThis PHY implements a model of 802.11a.
Definition: yans-wifi-phy.h:47
Ptr< YansWifiChannel > m_channel
void Set(std::string name, const AttributeValue &value)
Set an attribute to be set during construction.
manage and create wifi channel objects for the yans model.
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:118
ObjectFactory m_phy
Definition: wifi-helper.h:184
Instantiate subclasses of ns3::Object.
Models the propagation loss through a transmission medium.
virtual Ptr< WifiPhy > Create(Ptr< Node > node, Ptr< NetDevice > device) const
void SetPropagationDelay(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())
std::vector< ObjectFactory > m_propagationLoss
int64_t AssignStreams(Ptr< YansWifiChannel > c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by the channel.
void SetErrorRateModel(Ptr< ErrorRateModel > rate)
Sets the error rate model.
Definition: wifi-phy.cc:629