A Discrete-Event Network Simulator
API
wifi-radio-energy-model-helper.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010 Network Security Lab, University of Washington, Seattle.
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: Sidharth Nabar <snabar@uw.edu>, He Wu <mdzz@u.washington.edu>
18  */
19 
20 #ifndef WIFI_RADIO_ENERGY_MODEL_HELPER_H
21 #define WIFI_RADIO_ENERGY_MODEL_HELPER_H
22 
23 #include "ns3/energy-model-helper.h"
24 #include "ns3/wifi-radio-energy-model.h"
25 
26 namespace ns3
27 {
28 
37 {
38  public:
43 
47  ~WifiRadioEnergyModelHelper() override;
48 
55  void Set(std::string name, const AttributeValue& v) override;
56 
63 
70 
78  template <typename... Ts>
79  void SetTxCurrentModel(std::string name, Ts&&... args);
80 
81  private:
90  Ptr<EnergySource> source) const override;
91 
92  private:
99 };
100 
101 /***************************************************************
102  * Implementation of the templates declared above.
103  ***************************************************************/
104 
105 template <typename... Ts>
106 void
108 {
109  m_txCurrentModel = ObjectFactory(name, std::forward<Ts>(args)...);
110 }
111 
112 } // namespace ns3
113 
114 #endif /* WIFI_RADIO_ENERGY_MODEL_HELPER_H */
Hold a value for an Attribute.
Definition: attribute.h:70
Creates DeviceEnergyModel objects.
Instantiate subclasses of ns3::Object.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
Assign WifiRadioEnergyModel to wifi devices.
~WifiRadioEnergyModelHelper() override
Destroy a RadioEnergy Helper.
void SetRechargedCallback(WifiRadioEnergyModel::WifiRadioEnergyRechargedCallback callback)
void SetDepletionCallback(WifiRadioEnergyModel::WifiRadioEnergyDepletionCallback callback)
WifiRadioEnergyModel::WifiRadioEnergyRechargedCallback m_rechargedCallback
radio energy recharged callback
WifiRadioEnergyModelHelper()
Construct a helper which is used to add a radio energy model to a node.
WifiRadioEnergyModel::WifiRadioEnergyDepletionCallback m_depletionCallback
radio energy depletion callback
void Set(std::string name, const AttributeValue &v) override
Ptr< DeviceEnergyModel > DoInstall(Ptr< NetDevice > device, Ptr< EnergySource > source) const override
ObjectFactory m_txCurrentModel
transmit current model
void SetTxCurrentModel(std::string name, Ts &&... args)
Every class exported by the ns3 library is enclosed in the ns3 namespace.