A Discrete-Event Network Simulator
API
simple-net-device-helper.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014 Universita' di Firenze
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
18  */
19 
21 
22 #include "trace-helper.h"
23 
24 #include "ns3/abort.h"
25 #include "ns3/boolean.h"
26 #include "ns3/config.h"
27 #include "ns3/log.h"
28 #include "ns3/names.h"
29 #include "ns3/net-device-queue-interface.h"
30 #include "ns3/object-factory.h"
31 #include "ns3/packet.h"
32 #include "ns3/simple-channel.h"
33 #include "ns3/simple-net-device.h"
34 #include "ns3/simulator.h"
35 
36 #include <string>
37 
38 namespace ns3
39 {
40 
41 NS_LOG_COMPONENT_DEFINE("SimpleNetDeviceHelper");
42 
44 {
45  m_queueFactory.SetTypeId("ns3::DropTailQueue<Packet>");
46  m_deviceFactory.SetTypeId("ns3::SimpleNetDevice");
47  m_channelFactory.SetTypeId("ns3::SimpleChannel");
48  m_pointToPointMode = false;
49  m_enableFlowControl = true;
50 }
51 
52 void
54 {
55  m_deviceFactory.Set(n1, v1);
56 }
57 
58 void
60 {
61  m_channelFactory.Set(n1, v1);
62 }
63 
64 void
66 {
67  m_pointToPointMode = pointToPointMode;
68 }
69 
70 void
72 {
73  m_enableFlowControl = false;
74 }
75 
78 {
80  return Install(node, channel);
81 }
82 
85 {
86  return NetDeviceContainer(InstallPriv(node, channel));
87 }
88 
91 {
93 
94  return Install(c, channel);
95 }
96 
99 {
100  NetDeviceContainer devs;
101 
102  for (auto i = c.Begin(); i != c.End(); i++)
103  {
104  devs.Add(InstallPriv(*i, channel));
105  }
106 
107  return devs;
108 }
109 
112 {
114  device->SetAttribute("PointToPointMode", BooleanValue(m_pointToPointMode));
115  device->SetAddress(Mac48Address::Allocate());
116  node->AddDevice(device);
117  device->SetChannel(channel);
119  device->SetQueue(queue);
120  NS_ASSERT_MSG(!m_pointToPointMode || (channel->GetNDevices() <= 2),
121  "Device set to PointToPoint and more than 2 devices on the channel.");
123  {
124  // Aggregate a NetDeviceQueueInterface object
125  Ptr<NetDeviceQueueInterface> ndqi = CreateObject<NetDeviceQueueInterface>();
126  ndqi->GetTxQueue(0)->ConnectQueueTraces(queue);
127  device->AggregateObject(ndqi);
128  }
129  return device;
130 }
131 
132 } // namespace ns3
Hold a value for an Attribute.
Definition: attribute.h:70
static Mac48Address Allocate()
Allocate a new Mac48Address.
holds a vector of ns3::NetDevice pointers
void Add(NetDeviceContainer other)
Append the contents of another NetDeviceContainer to the end of this container.
keep track of a set of node pointers.
Iterator End() const
Get an iterator which indicates past-the-last Node in the container.
Iterator Begin() const
Get an iterator which refers to the first Node in the container.
uint32_t AddDevice(Ptr< NetDevice > device)
Associate a NetDevice to this node.
Definition: node.cc:138
Ptr< Object > Create() const
Create an Object instance of the configured TypeId.
void Set(const std::string &name, const AttributeValue &value, Args &&... args)
Set an attribute to be set during construction.
void SetTypeId(TypeId tid)
Set the TypeId of the Objects to be created by this factory.
Template class for packet Queues.
Definition: queue.h:268
A simple channel, for simple things and testing.
bool m_enableFlowControl
whether to enable flow control
Ptr< NetDevice > InstallPriv(Ptr< Node > node, Ptr< SimpleChannel > channel) const
This method creates an ns3::SimpleNetDevice with the attributes configured by SimpleNetDeviceHelper::...
ObjectFactory m_deviceFactory
NetDevice factory.
void SetChannelAttribute(std::string n1, const AttributeValue &v1)
ObjectFactory m_channelFactory
Channel factory.
ObjectFactory m_queueFactory
Queue factory.
void SetNetDevicePointToPointMode(bool pointToPointMode)
SimpleNetDevice is Broadcast capable and ARP needing.
void SetDeviceAttribute(std::string n1, const AttributeValue &v1)
SimpleNetDeviceHelper()
Construct a SimpleNetDeviceHelper.
void DisableFlowControl()
Disable flow control only if you know what you are doing.
NetDeviceContainer Install(Ptr< Node > node) const
This method creates an ns3::SimpleChannel with the attributes configured by SimpleNetDeviceHelper::Se...
bool m_pointToPointMode
Install PointToPoint SimpleNetDevice or Broadcast ones.
This device assumes 48-bit mac addressing; there is also the possibility to add an ErrorModel if you ...
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Definition: assert.h:86
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
Every class exported by the ns3 library is enclosed in the ns3 namespace.
channel
Definition: third.py:88