basic-energy-harvester.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
#define BASIC_ENERGY_HARVESTER
 
#include <iostream>
 
// include from ns-3
#include "energy-harvester.h"
 
#include "ns3/device-energy-model.h"
#include "ns3/event-id.h"
#include "ns3/nstime.h"
#include "ns3/random-variable-stream.h"
#include "ns3/traced-value.h"
 
namespace ns3
{
 
class BasicEnergyHarvester : public EnergyHarvester
{
  public:
    static TypeId GetTypeId();
 
    BasicEnergyHarvester();
 
    BasicEnergyHarvester(Time updateInterval);
 
    ~BasicEnergyHarvester() override;
 
    void SetHarvestedPowerUpdateInterval(Time updateInterval);
 
    Time GetHarvestedPowerUpdateInterval() const;
 
    int64_t AssignStreams(int64_t stream);
 
  private:
    void DoInitialize() override;
 
    void DoDispose() override;
 
    void CalculateHarvestedPower();
 
    double DoGetPower() const override;
 
    void UpdateHarvestedPower();
 
  private:
    Ptr<RandomVariableStream> m_harvestablePower; 
 
    TracedValue<double> m_harvestedPower;        
    TracedValue<double> m_totalEnergyHarvestedJ; 
 
    EventId m_energyHarvestingUpdateEvent; 
    Time m_lastHarvestingUpdateTime;       
    Time m_harvestedPowerUpdateInterval;   
};
 
} // namespace ns3
 
#endif /* defined(BASIC_ENERGY_HARVESTER) */