A Discrete-Event Network Simulator
API
fd-net-device-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2012 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  * Author: Alina Quereilhac <alina.quereilhac@inria.fr>
19  *
20  */
21 
22 #ifndef FD_NET_DEVICE_HELPER_H
23 #define FD_NET_DEVICE_HELPER_H
24 
25 #include <string>
26 
27 #include "ns3/attribute.h"
28 #include "ns3/fd-net-device.h"
29 #include "ns3/object-factory.h"
30 #include "ns3/net-device-container.h"
31 #include "ns3/node-container.h"
32 #include "ns3/trace-helper.h"
33 
34 namespace ns3 {
35 
47 {
48 public:
53  virtual ~FdNetDeviceHelper ()
54  {
55  }
56 
62  void SetTypeId (std::string type);
63 
71  void SetAttribute (std::string n1, const AttributeValue &v1);
72 
79  virtual NetDeviceContainer Install (Ptr<Node> node) const;
80 
87  virtual NetDeviceContainer Install (std::string name) const;
88 
98  virtual NetDeviceContainer Install (const NodeContainer &c) const;
99 
100 protected:
101 
108  virtual Ptr<NetDevice> InstallPriv (Ptr<Node> node) const;
109 
110 private:
122  virtual void EnablePcapInternal (std::string prefix, Ptr<NetDevice> nd, bool promiscuous, bool explicitFilename);
123 
135  virtual void EnableAsciiInternal (Ptr<OutputStreamWrapper> stream,
136  std::string prefix,
137  Ptr<NetDevice> nd,
138  bool explicitFilename);
139 
141 };
142 
143 } // namespace ns3
144 
145 #endif /* FD_NET_DEVICE_HELPER_H */
ns3::NetDeviceContainer
holds a vector of ns3::NetDevice pointers
Definition: net-device-container.h:42
ns3::FdNetDeviceHelper::Install
virtual NetDeviceContainer Install(Ptr< Node > node) const
This method creates a FdNetDevice and associates it to a node.
Definition: fd-net-device-helper.cc:176
ns3::FdNetDeviceHelper::~FdNetDeviceHelper
virtual ~FdNetDeviceHelper()
Definition: fd-net-device-helper.h:53
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::AttributeValue
Hold a value for an Attribute.
Definition: attribute.h:69
ns3::Ptr< Node >
ns3::ObjectFactory
Instantiate subclasses of ns3::Object.
Definition: object-factory.h:48
ns3::FdNetDeviceHelper::m_deviceFactory
ObjectFactory m_deviceFactory
factory for the NetDevices
Definition: fd-net-device-helper.h:140
ns3::FdNetDeviceHelper
build a set of FdNetDevice objects Normally we eschew multiple inheritance, however,...
Definition: fd-net-device-helper.h:47
ns3::FdNetDeviceHelper::FdNetDeviceHelper
FdNetDeviceHelper()
Construct a FdNetDeviceHelper.
Definition: fd-net-device-helper.cc:40
ns3::NodeContainer
keep track of a set of node pointers.
Definition: node-container.h:39
ns3::FdNetDeviceHelper::EnablePcapInternal
virtual void EnablePcapInternal(std::string prefix, Ptr< NetDevice > nd, bool promiscuous, bool explicitFilename)
Enable pcap output on the indicated net device.
Definition: fd-net-device-helper.cc:59
ns3::FdNetDeviceHelper::SetAttribute
void SetAttribute(std::string n1, const AttributeValue &v1)
Definition: fd-net-device-helper.cc:52
ns3::PcapHelperForDevice
Base class providing common user-level pcap operations for helpers representing net devices.
Definition: trace-helper.h:554
ns3::FdNetDeviceHelper::EnableAsciiInternal
virtual void EnableAsciiInternal(Ptr< OutputStreamWrapper > stream, std::string prefix, Ptr< NetDevice > nd, bool explicitFilename)
Enable ascii trace output on the indicated net device.
Definition: fd-net-device-helper.cc:97
ns3::AsciiTraceHelperForDevice
Base class providing common user-level ascii trace operations for helpers representing net devices.
Definition: trace-helper.h:643
ns3::FdNetDeviceHelper::SetTypeId
void SetTypeId(std::string type)
Set the TypeId of the Objects to be created by this helper.
Definition: fd-net-device-helper.cc:46
ns3::FdNetDeviceHelper::InstallPriv
virtual Ptr< NetDevice > InstallPriv(Ptr< Node > node) const
This method creates an ns3::FdNetDevice and associates it to a node.
Definition: fd-net-device-helper.cc:202