/usr/include/ns3.27/ns3/simple-net-device-helper.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2014 Universita' di Firenze
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
*/
#ifndef SIMPLE_NETDEVICE_HELPER_H
#define SIMPLE_NETDEVICE_HELPER_H
#include <string>
#include "ns3/attribute.h"
#include "ns3/object-factory.h"
#include "ns3/net-device-container.h"
#include "ns3/node-container.h"
#include "ns3/simple-channel.h"
namespace ns3 {
/**
* \brief build a set of SimpleNetDevice objects
*/
class SimpleNetDeviceHelper
{
public:
/**
* Construct a SimpleNetDeviceHelper.
*/
SimpleNetDeviceHelper ();
virtual ~SimpleNetDeviceHelper () {}
/**
* Each net device must have a queue to pass packets through.
* This method allows one to set the type of the queue that is automatically
* created when the device is created and attached to a node.
*
* \param type the type of queue
* \param n1 the name of the attribute to set on the queue
* \param v1 the value of the attribute to set on the queue
* \param n2 the name of the attribute to set on the queue
* \param v2 the value of the attribute to set on the queue
* \param n3 the name of the attribute to set on the queue
* \param v3 the value of the attribute to set on the queue
* \param n4 the name of the attribute to set on the queue
* \param v4 the value of the attribute to set on the queue
*
* Set the type of queue to create and associated to each
* SimpleNetDevice created through SimpleNetDeviceHelper::Install.
*/
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 channel to pass packets through.
* This method allows one to set the type of the channel that is automatically
* created when the device is created and attached to a node.
*
* \param type the type of queue
* \param n1 the name of the attribute to set on the queue
* \param v1 the value of the attribute to set on the queue
* \param n2 the name of the attribute to set on the queue
* \param v2 the value of the attribute to set on the queue
* \param n3 the name of the attribute to set on the queue
* \param v3 the value of the attribute to set on the queue
* \param n4 the name of the attribute to set on the queue
* \param v4 the value of the attribute to set on the queue
*
* Set the type of channel to create and associated to each
* SimpleNetDevice created through SimpleNetDeviceHelper::Install.
*/
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 ());
/**
* \param n1 the name of the attribute to set
* \param v1 the value of the attribute to set
*
* Set these attributes on each ns3::SimpleNetDevice created
* by SimpleNetDeviceHelper::Install
*/
void SetDeviceAttribute (std::string n1, const AttributeValue &v1);
/**
* \param n1 the name of the attribute to set
* \param v1 the value of the attribute to set
*
* Set these attributes on each ns3::CsmaChannel created
* by SimpleNetDeviceHelper::Install
*/
void SetChannelAttribute (std::string n1, const AttributeValue &v1);
/**
* SimpleNetDevice is Broadcast capable and ARP needing. This function
* limits the number of SimpleNetDevices on one channel to two, disables
* Broadcast and ARP and enables PointToPoint mode.
*
* \warning It must be used before installing a NetDevice on a node.
*
* \param pointToPointMode True for PointToPoint SimpleNetDevice
*/
void SetNetDevicePointToPointMode (bool pointToPointMode);
/**
* This method creates an ns3::SimpleChannel with the attributes configured by
* SimpleNetDeviceHelper::SetChannelAttribute, an ns3::SimpleNetDevice with the attributes
* configured by SimpleNetDeviceHelper::SetDeviceAttribute and then adds the device
* to the node and attaches the channel to the device.
*
* \param node The node to install the device in
* \returns A container holding the added net device.
*/
NetDeviceContainer Install (Ptr<Node> node) const;
/**
* This method creates an ns3::SimpleNetDevice with the attributes configured by
* SimpleNetDeviceHelper::SetDeviceAttribute and then adds the device to the node and
* attaches the provided channel to the device.
*
* \param node The node to install the device in
* \param channel The channel to attach to the device.
* \returns A container holding the added net device.
*/
NetDeviceContainer Install (Ptr<Node> node, Ptr<SimpleChannel> channel) const;
/**
* This method creates an ns3::SimpleChannel with the attributes configured by
* SimpleNetDeviceHelper::SetChannelAttribute. For each Ptr<node> in the provided
* container: it creates an ns3::SimpleNetDevice (with the attributes
* configured by SimpleNetDeviceHelper::SetDeviceAttribute); adds the device to the
* node; and attaches the channel to the device.
*
* \param c The NodeContainer holding the nodes to be changed.
* \returns A container holding the added net devices.
*/
NetDeviceContainer Install (const NodeContainer &c) const;
/**
* For each Ptr<node> in the provided container, this method creates an
* ns3::SimpleNetDevice (with the attributes configured by
* SimpleNetDeviceHelper::SetDeviceAttribute); adds the device to the node; and attaches
* the provided channel to the device.
*
* \param c The NodeContainer holding the nodes to be changed.
* \param channel The channel to attach to the devices.
* \returns A container holding the added net devices.
*/
NetDeviceContainer Install (const NodeContainer &c, Ptr<SimpleChannel> channel) const;
private:
/**
* This method creates an ns3::SimpleNetDevice with the attributes configured by
* SimpleNetDeviceHelper::SetDeviceAttribute and then adds the device to the node and
* attaches the provided channel to the device.
*
* \param node The node to install the device in
* \param channel The channel to attach to the device.
* \returns The new net device.
*/
Ptr<NetDevice> InstallPriv (Ptr<Node> node, Ptr<SimpleChannel> channel) const;
ObjectFactory m_queueFactory; //!< Queue factory
ObjectFactory m_deviceFactory; //!< NetDevice factory
ObjectFactory m_channelFactory; //!< Channel factory
bool m_pointToPointMode; //!< Install PointToPoint SimpleNetDevice or Broadcast ones
};
} // namespace ns3
#endif /* SIMPLE_NETDEVICE_HELPER_H */
|