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