A Discrete-Event Network Simulator
API
simple-net-device-helper.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014 Universita' di Firenze
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  * Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
19  */
20 
21 #include "ns3/abort.h"
22 #include "ns3/log.h"
23 #include "ns3/simulator.h"
24 #include "ns3/object-factory.h"
25 #include "ns3/queue.h"
26 #include "ns3/net-device-queue-interface.h"
27 #include "ns3/simple-net-device.h"
28 #include "ns3/simple-channel.h"
29 #include "ns3/config.h"
30 #include "ns3/packet.h"
31 #include "ns3/names.h"
32 #include "ns3/boolean.h"
33 
34 #include "ns3/trace-helper.h"
36 
37 #include <string>
38 
39 namespace ns3 {
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 }
50 
51 void
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 {
59 
61  m_queueFactory.Set (n1, v1);
62  m_queueFactory.Set (n2, v2);
63  m_queueFactory.Set (n3, v3);
64  m_queueFactory.Set (n4, v4);
65 }
66 
67 void
69  std::string n1, const AttributeValue &v1,
70  std::string n2, const AttributeValue &v2,
71  std::string n3, const AttributeValue &v3,
72  std::string n4, const AttributeValue &v4)
73 {
75  m_channelFactory.Set (n1, v1);
76  m_channelFactory.Set (n2, v2);
77  m_channelFactory.Set (n3, v3);
78  m_channelFactory.Set (n4, v4);
79 }
80 
81 void
83 {
84  m_deviceFactory.Set (n1, v1);
85 }
86 
87 void
89 {
90  m_channelFactory.Set (n1, v1);
91 }
92 
93 void
95 {
96  m_pointToPointMode = pointToPointMode;
97 }
98 
101 {
103  return Install (node, channel);
104 }
105 
108 {
109  return NetDeviceContainer (InstallPriv (node, channel));
110 }
111 
114 {
116 
117  return Install (c, channel);
118 }
119 
122 {
123  NetDeviceContainer devs;
124 
125  for (NodeContainer::Iterator i = c.Begin (); i != c.End (); i++)
126  {
127  devs.Add (InstallPriv (*i, channel));
128  }
129 
130  return devs;
131 }
132 
135 {
137  device->SetAttribute ("PointToPointMode", BooleanValue (m_pointToPointMode));
138  device->SetAddress (Mac48Address::Allocate ());
139  node->AddDevice (device);
140  device->SetChannel (channel);
142  device->SetQueue (queue);
143  NS_ASSERT_MSG (!m_pointToPointMode || (channel->GetNDevices () <= 2), "Device set to PointToPoint and more than 2 devices on the channel.");
144  // Aggregate a NetDeviceQueueInterface object
145  Ptr<NetDeviceQueueInterface> ndqi = CreateObject<NetDeviceQueueInterface> ();
146  ndqi->GetTxQueue (0)->ConnectQueueTraces (queue);
147  device->AggregateObject (ndqi);
148  return device;
149 }
150 
151 } // namespace ns3
ObjectFactory m_deviceFactory
NetDevice factory.
AttributeValue implementation for Boolean.
Definition: boolean.h:36
std::vector< Ptr< Node > >::const_iterator Iterator
Node container iterator.
NS_ASSERT_MSG(false, "Ipv4AddressGenerator::MaskToIndex(): Impossible")
Hold a value for an Attribute.
Definition: attribute.h:68
void SetChannelAttribute(std::string n1, const AttributeValue &v1)
#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.
Iterator End(void) const
Get an iterator which indicates past-the-last Node in the container.
static void AppendItemTypeIfNotPresent(std::string &typeId, const std::string &itemType)
Append the item type to the provided type ID if the latter does not end with &#39;>&#39;. ...
Definition: queue.cc:78
channel
Definition: third.py:92
static Mac48Address Allocate(void)
Allocate a new Mac48Address.
Ptr< Object > Create(void) const
Create an Object instance of the configured TypeId.
void Add(NetDeviceContainer other)
Append the contents of another NetDeviceContainer to the end of this container.
This device assumes 48-bit mac addressing; there is also the possibility to add an ErrorModel if you ...
holds a vector of ns3::NetDevice pointers
void SetDeviceAttribute(std::string n1, const AttributeValue &v1)
ObjectFactory m_channelFactory
Channel factory.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
keep track of a set of node pointers.
SimpleNetDeviceHelper()
Construct a SimpleNetDeviceHelper.
ObjectFactory m_queueFactory
Queue factory.
bool m_pointToPointMode
Install PointToPoint SimpleNetDevice or Broadcast ones.
void SetNetDevicePointToPointMode(bool pointToPointMode)
SimpleNetDevice is Broadcast capable and ARP needing.
void Set(std::string name, const AttributeValue &value)
Set an attribute to be set during construction.
Ptr< NetDevice > InstallPriv(Ptr< Node > node, Ptr< SimpleChannel > channel) const
This method creates an ns3::SimpleNetDevice with the attributes configured by SimpleNetDeviceHelper::...
void SetQueue(std::string type, 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())
Each net device must have a queue to pass packets through.
uint32_t AddDevice(Ptr< NetDevice > device)
Associate a NetDevice to this node.
Definition: node.cc:128
A simple channel, for simple things and testing.
void SetChannel(std::string type, 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())
Each net device must have a channel to pass packets through.
NetDeviceContainer Install(Ptr< Node > node) const
This method creates an ns3::SimpleChannel with the attributes configured by SimpleNetDeviceHelper::Se...
Iterator Begin(void) const
Get an iterator which refers to the first Node in the container.