A Discrete-Event Network Simulator
API
energy-harvester-helper.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014 Wireless Communications and Networking Group (WCNG),
4  * University of Rochester, Rochester, NY, USA.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation;
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Author: Cristiano Tapparello <cristiano.tapparello@rochester.edu>
20  */
21 
22 #ifndef ENERGY_HARVESTER_HELPER_H
23 #define ENERGY_HARVESTER_HELPER_H
24 
25 #include "ns3/attribute.h"
26 #include "ns3/object-factory.h"
27 #include "ns3/node-container.h"
28 #include "ns3/ptr.h"
29 #include "ns3/energy-harvester.h"
30 #include "ns3/energy-harvester-container.h"
31 
32 #include "ns3/energy-source.h"
33 #include "ns3/energy-source-container.h"
34 
35 
36 namespace ns3 {
37 
46 {
47 public:
48  virtual ~EnergyHarvesterHelper ();
49 
56  virtual void Set (std::string name, const AttributeValue &v) = 0;
57 
65 
73 
80  EnergyHarvesterContainer Install (std::string sourceName) const;
81 
82 private:
92  virtual Ptr<EnergyHarvester> DoInstall (Ptr<EnergySource> source) const = 0;
93 
94 };
95 
96 } // namespace ns3
97 
98 #endif /* defined(ENERGY_HARVESTER_HELPER_H) */
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
Holds a vector of ns3::EnergySource pointers.
virtual void Set(std::string name, const AttributeValue &v)=0
virtual Ptr< EnergyHarvester > DoInstall(Ptr< EnergySource > source) const =0
Hold a value for an Attribute.
Definition: attribute.h:68
Creates EnergyHarvester objects.
EnergyHarvesterContainer Install(Ptr< EnergySource > source) const
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Holds a vector of ns3::EnergyHarvester pointers.