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.cc
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2010 Andrea Sacco
3
*
4
* SPDX-License-Identifier: GPL-2.0-only
5
*
6
* Author: Author: Andrea Sacco <andrea.sacco85@gmail.com>
7
*/
8
9
#include "
acoustic-modem-energy-model-helper.h
"
10
11
#include "ns3/basic-energy-source-helper.h"
12
#include "ns3/config.h"
13
#include "ns3/names.h"
14
#include "ns3/uan-net-device.h"
15
#include "ns3/uan-phy.h"
16
17
namespace
ns3
18
{
19
20
AcousticModemEnergyModelHelper::AcousticModemEnergyModelHelper
()
21
{
22
m_modemEnergy
.SetTypeId(
"ns3::AcousticModemEnergyModel"
);
23
m_depletionCallback
.Nullify();
24
}
25
26
AcousticModemEnergyModelHelper::~AcousticModemEnergyModelHelper
()
27
{
28
}
29
30
void
31
AcousticModemEnergyModelHelper::Set
(std::string name,
const
AttributeValue
& v)
32
{
33
m_modemEnergy
.Set(name, v);
34
}
35
36
void
37
AcousticModemEnergyModelHelper::SetDepletionCallback
(
38
AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback
callback)
39
{
40
m_depletionCallback
= callback;
41
}
42
43
/*
44
* Private function starts here.
45
*/
46
47
Ptr<energy::DeviceEnergyModel>
48
AcousticModemEnergyModelHelper::DoInstall
(
Ptr<NetDevice>
device,
49
Ptr<energy::EnergySource>
source)
const
50
{
51
NS_ASSERT
(device);
52
NS_ASSERT
(source);
53
// check if device is UanNetDevice
54
std::string deviceName = device->GetInstanceTypeId().GetName();
55
if
(deviceName !=
"ns3::UanNetDevice"
)
56
{
57
NS_FATAL_ERROR
(
"NetDevice type is not UanNetDevice!"
);
58
}
59
Ptr<Node>
node = device->GetNode();
60
Ptr<AcousticModemEnergyModel>
model =
m_modemEnergy
.Create<
AcousticModemEnergyModel
>();
61
NS_ASSERT
(model);
62
// set node pointer
63
model->SetNode(node);
64
// set energy source pointer
65
model->SetEnergySource(source);
66
// get phy layer
67
Ptr<UanNetDevice>
uanDevice =
DynamicCast<UanNetDevice>
(device);
68
Ptr<UanPhy>
uanPhy = uanDevice->GetPhy();
69
// set energy depletion callback
70
model->SetEnergyDepletionCallback(
m_depletionCallback
);
71
// add model to device model list in energy source
72
source->AppendDeviceEnergyModel(model);
73
// set node pointer
74
source->SetNode(node);
75
// create and install energy model callback
76
energy::DeviceEnergyModel::ChangeStateCallback
cb;
77
cb =
MakeCallback
(&
energy::DeviceEnergyModel::ChangeState
, model);
78
uanPhy->SetEnergyModelCallback(cb);
79
80
return
model;
81
}
82
83
}
// namespace ns3
acoustic-modem-energy-model-helper.h
ns3::AcousticModemEnergyModelHelper::m_modemEnergy
ObjectFactory m_modemEnergy
Energy model factory.
Definition
acoustic-modem-energy-model-helper.h:68
ns3::AcousticModemEnergyModelHelper::m_depletionCallback
AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback m_depletionCallback
Callback for energy depletion.
Definition
acoustic-modem-energy-model-helper.h:71
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:37
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:48
ns3::AcousticModemEnergyModelHelper::~AcousticModemEnergyModelHelper
~AcousticModemEnergyModelHelper() override
Destroy an AcousticModemEnergy Helper.
Definition
acoustic-modem-energy-model-helper.cc:26
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:20
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:31
ns3::AcousticModemEnergyModel
WHOI micro-modem energy model.
Definition
acoustic-modem-energy-model.h:45
ns3::AcousticModemEnergyModel::AcousticModemEnergyDepletionCallback
Callback< void > AcousticModemEnergyDepletionCallback
Callback type for energy depletion handling.
Definition
acoustic-modem-energy-model.h:48
ns3::AttributeValue
Hold a value for an Attribute.
Definition
attribute.h:59
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition
ptr.h:66
ns3::energy::DeviceEnergyModel::ChangeState
virtual void ChangeState(int newState)=0
ns3::energy::DeviceEnergyModel::ChangeStateCallback
Callback< void, int > ChangeStateCallback
Callback type for ChangeState function.
Definition
device-energy-model.h:41
NS_ASSERT
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file,...
Definition
assert.h:55
NS_FATAL_ERROR
#define NS_FATAL_ERROR(msg)
Report a fatal error with a message and terminate.
Definition
fatal-error.h:168
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::MakeCallback
Callback< R, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition
callback.h:684
ns3::DynamicCast
Ptr< T1 > DynamicCast(const Ptr< T2 > &p)
Cast a Ptr.
Definition
ptr.h:580
src
uan
helper
acoustic-modem-energy-model-helper.cc
Generated on Wed Jun 11 2025 13:15:39 for ns-3 by
1.13.2