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/log.h"
23 #include "ns3/names.h"
24 #include "ns3/propagation-loss-model.h"
25 #include "ns3/propagation-delay-model.h"
26 #include "ns3/error-rate-model.h"
27 #include "ns3/frame-capture-model.h"
28 #include "ns3/preamble-detection-model.h"
29 #include "ns3/yans-wifi-phy.h"
30 #include "yans-wifi-helper.h"
31 
32 namespace ns3 {
33 
34 NS_LOG_COMPONENT_DEFINE ("YansWifiHelper");
35 
37 {
38 }
39 
42 {
43  YansWifiChannelHelper helper;
44  helper.SetPropagationDelay ("ns3::ConstantSpeedPropagationDelayModel");
45  helper.AddPropagationLoss ("ns3::LogDistancePropagationLossModel");
46  return helper;
47 }
48 
49 void
51  std::string n0, const AttributeValue &v0,
52  std::string n1, const AttributeValue &v1,
53  std::string n2, const AttributeValue &v2,
54  std::string n3, const AttributeValue &v3,
55  std::string n4, const AttributeValue &v4,
56  std::string n5, const AttributeValue &v5,
57  std::string n6, const AttributeValue &v6,
58  std::string n7, const AttributeValue &v7)
59 {
60  ObjectFactory factory;
61  factory.SetTypeId (type);
62  factory.Set (n0, v0);
63  factory.Set (n1, v1);
64  factory.Set (n2, v2);
65  factory.Set (n3, v3);
66  factory.Set (n4, v4);
67  factory.Set (n5, v5);
68  factory.Set (n6, v6);
69  factory.Set (n7, v7);
70  m_propagationLoss.push_back (factory);
71 }
72 
73 void
75  std::string n0, const AttributeValue &v0,
76  std::string n1, const AttributeValue &v1,
77  std::string n2, const AttributeValue &v2,
78  std::string n3, const AttributeValue &v3,
79  std::string n4, const AttributeValue &v4,
80  std::string n5, const AttributeValue &v5,
81  std::string n6, const AttributeValue &v6,
82  std::string n7, const AttributeValue &v7)
83 {
84  ObjectFactory factory;
85  factory.SetTypeId (type);
86  factory.Set (n0, v0);
87  factory.Set (n1, v1);
88  factory.Set (n2, v2);
89  factory.Set (n3, v3);
90  factory.Set (n4, v4);
91  factory.Set (n5, v5);
92  factory.Set (n6, v6);
93  factory.Set (n7, v7);
94  m_propagationDelay = factory;
95 }
96 
99 {
100  Ptr<YansWifiChannel> channel = CreateObject<YansWifiChannel> ();
101  Ptr<PropagationLossModel> prev = 0;
102  for (std::vector<ObjectFactory>::const_iterator i = m_propagationLoss.begin (); i != m_propagationLoss.end (); ++i)
103  {
104  Ptr<PropagationLossModel> cur = (*i).Create<PropagationLossModel> ();
105  if (prev != 0)
106  {
107  prev->SetNext (cur);
108  }
109  if (m_propagationLoss.begin () == i)
110  {
111  channel->SetPropagationLossModel (cur);
112  }
113  prev = cur;
114  }
116  channel->SetPropagationDelayModel (delay);
117  return channel;
118 }
119 
120 int64_t
122 {
123  return c->AssignStreams (stream);
124 }
125 
127  : m_channel (0)
128 {
129  m_phy.SetTypeId ("ns3::YansWifiPhy");
130 }
131 
134 {
135  YansWifiPhyHelper helper;
136  helper.SetErrorRateModel ("ns3::NistErrorRateModel");
137  return helper;
138 }
139 
140 void
142 {
143  m_channel = channel;
144 }
145 
146 void
147 YansWifiPhyHelper::SetChannel (std::string channelName)
148 {
149  Ptr<YansWifiChannel> channel = Names::Find<YansWifiChannel> (channelName);
150  m_channel = channel;
151 }
152 
155 {
158  phy->SetErrorRateModel (error);
160  {
162  phy->SetFrameCaptureModel (capture);
163  }
165  {
167  phy->SetPreambleDetectionModel (capture);
168  }
169  phy->SetChannel (m_channel);
170  phy->SetDevice (device);
171  return phy;
172 }
173 
174 } //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())
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.
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:204
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
error rate model
Definition: wifi-helper.h:236
YansWifiChannelHelper()
Create a channel helper without any parameter set.
the interface for Wifi&#39;s frame capture models
the interface for Wifi&#39;s error models
Ptr< YansWifiChannel > Create(void) const
channel
Definition: third.py:92
phy
Definition: third.py:93
ObjectFactory m_preambleDetectionModel
preamble detection model
Definition: wifi-helper.h:238
void SetChannel(Ptr< YansWifiChannel > channel)
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.
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:48
Ptr< YansWifiChannel > m_channel
yans wifi channel
the interface for Wifi&#39;s preamble detection models
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:149
bool IsTypeIdSet(void) const
Check if the ObjectFactory has been configured with a TypeId.
ObjectFactory m_propagationDelay
propagation delay model
ObjectFactory m_phy
PHY object.
Definition: wifi-helper.h:235
virtual Ptr< WifiPhy > Create(Ptr< Node > node, Ptr< NetDevice > device) const
Instantiate subclasses of ns3::Object.
Models the propagation loss through a transmission medium.
ObjectFactory m_frameCaptureModel
frame capture model
Definition: wifi-helper.h:237
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
vector of propagation loss models
int64_t AssignStreams(Ptr< YansWifiChannel > c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by the channel.