basic-energy-harvester-helper.h

Go to the documentation of this file.

/*
 * 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 BASIC_ENERGY_HARVESTER_HELPER_H
#define BASIC_ENERGY_HARVESTER_HELPER_H
 
#include "energy-harvester-helper.h"
 
#include "ns3/energy-source.h"
#include "ns3/node.h"
 
namespace ns3
{
 
/**
 * \ingroup energy
 * \brief Creates a BasicEnergyHarvester object.
 */
class BasicEnergyHarvesterHelper : public EnergyHarvesterHelper
{
  public:
    BasicEnergyHarvesterHelper();
    ~BasicEnergyHarvesterHelper() override;
 
    void Set(std::string name, const AttributeValue& v) override;
 
  private:
    Ptr<EnergyHarvester> DoInstall(Ptr<EnergySource> source) const override;
 
  private:
    ObjectFactory m_basicEnergyHarvester; //!< Energy source factory
};
 
} // namespace ns3
 
#endif /* defined(BASIC_ENERGY_HARVESTER_HELPER_H) */