A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
forwarder-helper.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2017 University of Padova
3
*
4
* SPDX-License-Identifier: GPL-2.0-only
5
*
6
* Author: Davide Magrin <magrinda@dei.unipd.it>
7
*/
8
9
#ifndef FORWARDER_HELPER_H
10
#define FORWARDER_HELPER_H
11
12
#include "ns3/address.h"
13
#include "ns3/application-container.h"
14
#include "ns3/attribute.h"
15
#include "ns3/forwarder.h"
16
#include "ns3/net-device.h"
17
#include "ns3/node-container.h"
18
#include "ns3/object-factory.h"
19
20
#include <stdint.h>
21
#include <string>
22
23
namespace
ns3
24
{
25
namespace
lorawan
26
{
27
28
/**
29
* \ingroup lorawan
30
*
31
* This class can be used to install Forwarder applications on a set of gateways.
32
*/
33
class
ForwarderHelper
34
{
35
public
:
36
ForwarderHelper
();
//!< Default constructor
37
~ForwarderHelper
();
//!< Destructor
38
39
/**
40
* Helper function used to set the underlying application attributes.
41
*
42
* \param name The name of the application attribute to set.
43
* \param value The value of the application attribute to set.
44
*/
45
void
SetAttribute
(std::string name,
const
AttributeValue
& value);
46
47
/**
48
* Install a Forwarder application on each node of the input container configured with
49
* all the attributes set with SetAttribute or other functions of this class.
50
*
51
* \param c NodeContainer of the set of nodes on which an Forwarder will be installed.
52
* \return Container of Ptr to the applications installed.
53
*/
54
ApplicationContainer
Install
(
NodeContainer
c)
const
;
55
56
/**
57
* Install a Forwarder application on the input Node configured with all the attributes
58
* set with SetAttribute or other functions of this class.
59
*
60
* \param node The node on which a Forwarder will be installed.
61
* \return Container of the Ptr to the application installed.
62
*/
63
ApplicationContainer
Install
(
Ptr<Node>
node)
const
;
64
65
private
:
66
/**
67
* Install a Forwarder application on the input Node configured with all the attributes
68
* set with SetAttribute or other functions of this class.
69
*
70
* \param node The node on which a Forwarder will be installed.
71
* \return A pointer to the applications installed.
72
*/
73
Ptr<Application>
InstallPriv
(
Ptr<Node>
node)
const
;
74
75
ObjectFactory
m_factory
;
//!< The object factory
76
};
77
78
}
// namespace lorawan
79
80
}
// namespace ns3
81
#endif
/* FORWARDER_HELPER_H */
ns3::ApplicationContainer
holds a vector of ns3::Application pointers.
Definition
application-container.h:33
ns3::AttributeValue
Hold a value for an Attribute.
Definition
attribute.h:59
ns3::NodeContainer
keep track of a set of node pointers.
Definition
node-container.h:29
ns3::ObjectFactory
Instantiate subclasses of ns3::Object.
Definition
object-factory.h:37
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition
mpi-test-fixtures.h:37
ns3::lorawan::ForwarderHelper
This class can be used to install Forwarder applications on a set of gateways.
Definition
forwarder-helper.h:34
ns3::lorawan::ForwarderHelper::SetAttribute
void SetAttribute(std::string name, const AttributeValue &value)
Helper function used to set the underlying application attributes.
Definition
forwarder-helper.cc:39
ns3::lorawan::ForwarderHelper::m_factory
ObjectFactory m_factory
The object factory.
Definition
forwarder-helper.h:75
ns3::lorawan::ForwarderHelper::Install
ApplicationContainer Install(NodeContainer c) const
Install a Forwarder application on each node of the input container configured with all the attribute...
Definition
forwarder-helper.cc:51
ns3::lorawan::ForwarderHelper::ForwarderHelper
ForwarderHelper()
Default constructor.
Definition
forwarder-helper.cc:29
ns3::lorawan::ForwarderHelper::~ForwarderHelper
~ForwarderHelper()
Destructor.
Definition
forwarder-helper.cc:34
ns3::lorawan::ForwarderHelper::InstallPriv
Ptr< Application > InstallPriv(Ptr< Node > node) const
Install a Forwarder application on the input Node configured with all the attributes set with SetAttr...
Definition
forwarder-helper.cc:63
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
lorawan
helper
forwarder-helper.h
Generated on Fri Nov 8 2024 13:59:02 for ns-3 by
1.11.0