A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
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
42
class
OnOffHelper
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
83
ApplicationContainer
Install
(
NodeContainer
c)
const
;
84
92
ApplicationContainer
Install
(
Ptr<Node>
node)
const
;
93
101
ApplicationContainer
Install
(std::string nodeName)
const
;
102
114
int64_t
AssignStreams
(
NodeContainer
c, int64_t stream);
115
116
private
:
124
Ptr<Application>
InstallPriv
(
Ptr<Node>
node)
const
;
125
126
ObjectFactory
m_factory
;
127
};
128
129
}
// namespace ns3
130
131
#endif
/* ON_OFF_HELPER_H */
132
ns3::Address
a polymophic address class
Definition:
address.h:91
ns3::ApplicationContainer
holds a vector of ns3::Application pointers.
Definition:
application-container.h:43
ns3::AttributeValue
Hold a value for an Attribute.
Definition:
attribute.h:69
ns3::DataRate
Class for representing data rates.
Definition:
data-rate.h:89
ns3::NodeContainer
keep track of a set of node pointers.
Definition:
node-container.h:39
ns3::ObjectFactory
Instantiate subclasses of ns3::Object.
Definition:
object-factory.h:48
ns3::OnOffHelper
A helper to make it easier to instantiate an ns3::OnOffApplication on a set of nodes.
Definition:
on-off-helper.h:43
ns3::OnOffHelper::OnOffHelper
OnOffHelper(std::string protocol, Address address)
Create an OnOffHelper to make it easier to work with OnOffApplications.
Definition:
on-off-helper.cc:32
ns3::OnOffHelper::SetConstantRate
void SetConstantRate(DataRate dataRate, uint32_t packetSize=512)
Helper function to set a constant rate source.
Definition:
on-off-helper.cc:100
ns3::OnOffHelper::m_factory
ObjectFactory m_factory
Object factory.
Definition:
on-off-helper.h:126
ns3::OnOffHelper::AssignStreams
int64_t AssignStreams(NodeContainer c, int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
Definition:
on-off-helper.cc:80
ns3::OnOffHelper::Install
ApplicationContainer Install(NodeContainer c) const
Install an ns3::OnOffApplication on each node of the input container configured with all the attribut...
Definition:
on-off-helper.cc:59
ns3::OnOffHelper::SetAttribute
void SetAttribute(std::string name, const AttributeValue &value)
Helper function used to set the underlying application attributes.
Definition:
on-off-helper.cc:40
ns3::OnOffHelper::InstallPriv
Ptr< Application > InstallPriv(Ptr< Node > node) const
Install an ns3::OnOffApplication on the node configured with all the attributes set with SetAttribute...
Definition:
on-off-helper.cc:71
ns3::Ptr< Node >
ns3::TracedValueCallback::DataRate
void(* DataRate)(DataRate oldValue, DataRate newValue)
TracedValue callback signature for DataRate.
Definition:
data-rate.h:329
first.address
address
Definition:
first.py:44
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
packetSize
static const uint32_t packetSize
Definition:
wifi-power-adaptation-distance.cc:113
src
applications
helper
on-off-helper.h
Generated on Tue Feb 6 2024 19:21:14 for ns-3 by
1.9.1