A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Portuguese
Docs ▼
Wiki
Manual
Models
Develop ▼
API
Bugs
API
src
uan
helper
acoustic-modem-energy-model-helper.h
Go to the documentation of this file.
1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2
/*
3
* Copyright (c) 2010 Andrea Sacco
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: Author: Andrea Sacco <andrea.sacco85@gmail.com>
19
*/
20
21
#ifndef ACOUSTIC_MODEM_ENERGY_MODEL_HELPER_H
22
#define ACOUSTIC_MODEM_ENERGY_MODEL_HELPER_H
23
24
#include "ns3/energy-model-helper.h"
25
#include "ns3/acoustic-modem-energy-model.h"
26
27
namespace
ns3
{
28
37
class
AcousticModemEnergyModelHelper
:
public
DeviceEnergyModelHelper
38
{
39
public
:
43
AcousticModemEnergyModelHelper
();
44
48
~AcousticModemEnergyModelHelper
();
49
56
void
Set
(std::string name,
const
AttributeValue
&v);
57
63
void
SetDepletionCallback
(
64
AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback
callback);
65
66
67
private
:
75
virtual
Ptr<DeviceEnergyModel>
DoInstall
(
Ptr<NetDevice>
device,
76
Ptr<EnergySource>
source)
const
;
77
78
private
:
80
ObjectFactory
m_modemEnergy
;
81
83
AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback
m_depletionCallback
;
84
85
};
86
87
}
// namespace ns3
88
89
#endif
/* ACOUSTIC_MODEM_ENERGY_MODEL_HELPER_H */
ns3::DeviceEnergyModelHelper
Creates DeviceEnergyModel objects.
Definition:
energy-model-helper.h:116
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:73
ns3::Callback< void >
ns3::AttributeValue
Hold a value for an Attribute.
Definition:
attribute.h:68
ns3::AcousticModemEnergyModelHelper::DoInstall
virtual Ptr< DeviceEnergyModel > DoInstall(Ptr< NetDevice > device, Ptr< EnergySource > source) const
Implements DeviceEnergyModel::Install.
Definition:
acoustic-modem-energy-model-helper.cc:58
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:30
ns3::AcousticModemEnergyModelHelper
Assign AcousticModemEnergyModel to uan devices.
Definition:
acoustic-modem-energy-model-helper.h:37
ns3::AcousticModemEnergyModelHelper::m_modemEnergy
ObjectFactory m_modemEnergy
Energy model factory.
Definition:
acoustic-modem-energy-model-helper.h:80
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::AcousticModemEnergyModelHelper::m_depletionCallback
AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback m_depletionCallback
Callback for energy depletion.
Definition:
acoustic-modem-energy-model-helper.h:83
ns3::ObjectFactory
Instantiate subclasses of ns3::Object.
Definition:
object-factory.h:47
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:47
ns3::AcousticModemEnergyModelHelper::Set
void Set(std::string name, const AttributeValue &v)
Sets an attribute of the underlying energy model object.
Definition:
acoustic-modem-energy-model-helper.cc:41
ns3::AcousticModemEnergyModelHelper::~AcousticModemEnergyModelHelper
~AcousticModemEnergyModelHelper()
Destroy an AcousticModemEnergy Helper.
Definition:
acoustic-modem-energy-model-helper.cc:36
Generated on Wed Nov 7 2018 10:02:11 for ns-3 by
1.8.14