/usr/include/ns3.27/ns3/energy-harvester-helper.h is in libns3-dev 3.27+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 | /* -*- 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_HELPER_H
#define ENERGY_HARVESTER_HELPER_H
#include "ns3/attribute.h"
#include "ns3/object-factory.h"
#include "ns3/node-container.h"
#include "ns3/ptr.h"
#include "ns3/energy-harvester.h"
#include "ns3/energy-harvester-container.h"
#include "ns3/energy-source.h"
#include "ns3/energy-source-container.h"
namespace ns3 {
/**
* \ingroup energy
* \brief Creates EnergyHarvester objects.
*
* This class creates and installs energy harvesters onto network nodes.
*
*/
class EnergyHarvesterHelper
{
public:
virtual ~EnergyHarvesterHelper ();
/**
* \param name Name of attribute to set.
* \param v Value of the attribute.
*
* Sets one of the attributes of underlying EnergyHarvester.
*/
virtual void Set (std::string name, const AttributeValue &v) = 0;
/**
* \param source Pointer to the energy source where EnergyHarvester will be installed.
* \returns An EnergyHarvesterContainer which contains all the EnergyHarvesters.
*
* This function installs an EnergyHarvester onto an energy source.
*/
EnergyHarvesterContainer Install (Ptr<EnergySource> source) const;
/**
* \param sourceContainer List of nodes where EnergyHarvester will be installed.
* \returns An EnergyHarvesterContainer which contains all the EnergyHarvester.
*
* This function installs an EnergyHarvester onto a list of energy sources.
*/
EnergyHarvesterContainer Install (EnergySourceContainer sourceContainer) const;
/**
* \param nodeName Name of node where EnergyHarvester will be installed.
* \returns An EnergyHarvesterContainer which contains all the EnergyHarvesters.
*
* This function installs an EnergyHarvester onto a node.
*/
EnergyHarvesterContainer Install (std::string sourceName) const;
private:
/**
* \param node Pointer to node where the energy harvester is to be installed.
* \returns Pointer to the created EnergyHarvester.
*
* Child classes of EnergyHarvesterHelper only have to implement this function,
* to create and aggregate an EnergyHarvester object onto a single node. Rest of
* the installation process (eg. installing EnergyHarvester on set of nodes) is
* implemented in the EnergyHarvesterHelper base class.
*/
virtual Ptr<EnergyHarvester> DoInstall (Ptr<EnergySource> source) const = 0;
};
} // namespace ns3
#endif /* defined(ENERGY_HARVESTER_HELPER_H) */
|