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
acoustic-modem-energy-model-helper.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2010 Andrea Sacco
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: Author: Andrea Sacco <andrea.sacco85@gmail.com>
18
*/
19
20
#ifndef ACOUSTIC_MODEM_ENERGY_MODEL_HELPER_H
21
#define ACOUSTIC_MODEM_ENERGY_MODEL_HELPER_H
22
23
#include "ns3/acoustic-modem-energy-model.h"
24
#include "ns3/energy-model-helper.h"
25
26
namespace
ns3
27
{
28
29
/**
30
* \ingroup uan
31
*
32
* Assign AcousticModemEnergyModel to uan devices.
33
*
34
* This installer installs AcousticModemEnergyModel for only
35
* UanNetDevice objects.
36
*/
37
class
AcousticModemEnergyModelHelper
:
public
DeviceEnergyModelHelper
38
{
39
public
:
40
/**
41
* Construct a helper which is used to add a radio energy model to a node.
42
*/
43
AcousticModemEnergyModelHelper
();
44
45
/**
46
* Destroy an AcousticModemEnergy Helper.
47
*/
48
~AcousticModemEnergyModelHelper
()
override
;
49
50
/**
51
* Sets an attribute of the underlying energy model object.
52
*
53
* \param name The name of the attribute to set.
54
* \param v The value of the attribute.
55
*/
56
void
Set
(std::string name,
const
AttributeValue
& v)
override
;
57
58
/**
59
* Sets the callback to be invoked when energy is depleted.
60
*
61
* \param callback Callback function for energy depletion handling.
62
*/
63
void
SetDepletionCallback
(
64
AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback
callback);
65
66
private
:
67
/**
68
* Implements DeviceEnergyModel::Install.
69
*
70
* \param device Pointer to the NetDevice to install DeviceEnergyModel.
71
* \param source Pointer to EnergySource installed on node.
72
* \return The energy model.
73
*/
74
Ptr<energy::DeviceEnergyModel>
DoInstall
(
Ptr<NetDevice>
device,
75
Ptr<energy::EnergySource>
source)
const override
;
76
77
private
:
78
/** Energy model factory. */
79
ObjectFactory
m_modemEnergy
;
80
81
/** Callback for energy depletion. */
82
AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback
m_depletionCallback
;
83
};
84
85
}
// namespace ns3
86
87
#endif
/* ACOUSTIC_MODEM_ENERGY_MODEL_HELPER_H */
ns3::AcousticModemEnergyModelHelper
Assign AcousticModemEnergyModel to uan devices.
Definition:
acoustic-modem-energy-model-helper.h:38
ns3::AcousticModemEnergyModelHelper::m_modemEnergy
ObjectFactory m_modemEnergy
Energy model factory.
Definition:
acoustic-modem-energy-model-helper.h:79
ns3::AcousticModemEnergyModelHelper::m_depletionCallback
AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback m_depletionCallback
Callback for energy depletion.
Definition:
acoustic-modem-energy-model-helper.h:82
ns3::AcousticModemEnergyModelHelper::SetDepletionCallback
void SetDepletionCallback(AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback callback)
Sets the callback to be invoked when energy is depleted.
Definition:
acoustic-modem-energy-model-helper.cc:48
ns3::AcousticModemEnergyModelHelper::DoInstall
Ptr< energy::DeviceEnergyModel > DoInstall(Ptr< NetDevice > device, Ptr< energy::EnergySource > source) const override
Implements DeviceEnergyModel::Install.
Definition:
acoustic-modem-energy-model-helper.cc:59
ns3::AcousticModemEnergyModelHelper::~AcousticModemEnergyModelHelper
~AcousticModemEnergyModelHelper() override
Destroy an AcousticModemEnergy Helper.
Definition:
acoustic-modem-energy-model-helper.cc:37
ns3::AcousticModemEnergyModelHelper::AcousticModemEnergyModelHelper
AcousticModemEnergyModelHelper()
Construct a helper which is used to add a radio energy model to a node.
Definition:
acoustic-modem-energy-model-helper.cc:31
ns3::AcousticModemEnergyModelHelper::Set
void Set(std::string name, const AttributeValue &v) override
Sets an attribute of the underlying energy model object.
Definition:
acoustic-modem-energy-model-helper.cc:42
ns3::AttributeValue
Hold a value for an Attribute.
Definition:
attribute.h:70
ns3::Callback< void >
ns3::DeviceEnergyModelHelper
Creates DeviceEnergyModel objects.
Definition:
energy-model-helper.h:115
ns3::ObjectFactory
Instantiate subclasses of ns3::Object.
Definition:
object-factory.h:48
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:77
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
uan
helper
acoustic-modem-energy-model-helper.h
Generated on Tue May 28 2024 23:39:51 for ns-3 by
1.9.6