A Discrete-Event Network Simulator
API
on-off-helper.h
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  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 #ifndef ON_OFF_HELPER_H
21 #define ON_OFF_HELPER_H
22 
23 #include <stdint.h>
24 #include <string>
25 #include "ns3/object-factory.h"
26 #include "ns3/address.h"
27 #include "ns3/attribute.h"
28 #include "ns3/net-device.h"
29 #include "ns3/node-container.h"
30 #include "ns3/application-container.h"
31 #include "ns3/onoff-application.h"
32 
33 namespace ns3 {
34 
35 class DataRate;
36 
43 {
44 public:
55  OnOffHelper (std::string protocol, Address address);
56 
63  void SetAttribute (std::string name, const AttributeValue &value);
64 
73  void SetConstantRate (DataRate dataRate, uint32_t packetSize = 512);
74 
84 
93 
101  ApplicationContainer Install (std::string nodeName) const;
102 
114  int64_t AssignStreams (NodeContainer c, int64_t stream);
115 
116 private:
125 
127 };
128 
129 } // namespace ns3
130 
131 #endif /* ON_OFF_HELPER_H */
132 
holds a vector of ns3::Application pointers.
static const uint32_t packetSize
Hold a value for an Attribute.
Definition: attribute.h:68
ObjectFactory m_factory
Object factory.
Ptr< Application > InstallPriv(Ptr< Node > node) const
Install an ns3::OnOffApplication on the node configured with all the attributes set with SetAttribute...
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
A helper to make it easier to instantiate an ns3::OnOffApplication on a set of nodes.
Definition: on-off-helper.h:42
a polymophic address class
Definition: address.h:90
Class for representing data rates.
Definition: data-rate.h:88
ApplicationContainer Install(NodeContainer c) const
Install an ns3::OnOffApplication on each node of the input container configured with all the attribut...
OnOffHelper(std::string protocol, Address address)
Create an OnOffHelper to make it easier to work with OnOffApplications.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void SetConstantRate(DataRate dataRate, uint32_t packetSize=512)
Helper function to set a constant rate source.
keep track of a set of node pointers.
address
Definition: first.py:37
Instantiate subclasses of ns3::Object.
void SetAttribute(std::string name, const AttributeValue &value)
Helper function used to set the underlying application attributes.