/usr/include/ns3.26/ns3/energy-harvester.h is in libns3-dev 3.26+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2014 Wireless Communications and Networking Group (WCNG),
* University of Rochester, Rochester, NY, USA.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Cristiano Tapparello <cristiano.tapparello@rochester.edu>
*/
#ifndef ENERGY_HARVESTER_H
#define ENERGY_HARVESTER_H
#include <iostream>
// include from ns-3
#include "ns3/object.h"
#include "ns3/ptr.h"
#include "ns3/type-id.h"
#include "ns3/node.h"
#include "ns3/energy-source-container.h"
namespace ns3 {
class EnergySource;
/**
* \defgroup energy Energy Models
*
*/
/**
* \ingroup energy
*
* \brief Energy harvester base class.
*
*
*/
class EnergyHarvester : public Object
{
public:
static TypeId GetTypeId (void);
EnergyHarvester ();
virtual ~EnergyHarvester ();
/**
* \brief Sets pointer to node containing this EnergyHarvester.
*
* \param node Pointer to node containing this EnergyHarvester.
*/
void SetNode (Ptr<Node> node);
/**
* \returns Pointer to node containing this EnergyHarvester.
*
* When a subclass needs to get access to the underlying node base class to
* print the nodeId for example, it can invoke this method.
*/
Ptr<Node> GetNode (void) const;
/**
* \param source Pointer to energy source to which this EnergyHarvester is
* installed.
*
* This function sets the pointer to the energy source connected to the energy
* harvester.
*/
void SetEnergySource (Ptr<EnergySource> source);
/**
* \returns source Pointer to energy source connected to the harvester.
*
* When a subclass needs to get access to the connected energy source,
* it can invoke this method.
*/
Ptr<EnergySource> GetEnergySource (void) const;
/**
* \returns power Amount of power currently provided by the harvester.
*
* This method is called by the energy source connected to the harvester in order
* to determine the amount of energy that the harvester provided since last update.
*/
double GetPower (void) const;
private:
/**
*
* Defined in ns3::Object
*/
virtual void DoDispose (void);
/**
* This method is called by the GetPower method and it needs to be implemented by the
* subclasses of the energy harvester. It returns the actual amount of power that is
* currently provided by the energy harvester.
*
* This method should be used to connect the logic behind the particular implementation
* of the energy harvester with the energy source.
*/
virtual double DoGetPower (void) const;
private:
/**
* Pointer to node containing this EnergyHarvester. Used by helper class to make
* sure energy harvesters are installed onto the corresponding node.
*/
Ptr<Node> m_node;
/**
* Pointer to the Energy Source to which this EnergyHarvester is connected. Used
* by helper class to make sure energy harvesters are installed onto the
* corresponding energy source.
*/
Ptr<EnergySource> m_energySource;
protected:
};
} // namespace ns3
#endif /* defined(ENERGY_HARVESTER_H) */
|