basic-energy-source.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010 Network Security Lab, University of Washington, Seattle.
 *
 * 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
 *
 * Authors: Sidharth Nabar <snabar@uw.edu>, He Wu <mdzz@u.washington.edu>
 */
 
#ifndef BASIC_ENERGY_SOURCE_H
#define BASIC_ENERGY_SOURCE_H
 
#include "energy-source.h"
 
#include "ns3/event-id.h"
#include "ns3/nstime.h"
#include "ns3/traced-value.h"
 
namespace ns3
{
 
class BasicEnergySource : public EnergySource
{
  public:
    static TypeId GetTypeId();
    BasicEnergySource();
    ~BasicEnergySource() override;
 
    double GetInitialEnergy() const override;
 
    double GetSupplyVoltage() const override;
 
    double GetRemainingEnergy() override;
 
    double GetEnergyFraction() override;
 
    void UpdateEnergySource() override;
 
    void SetInitialEnergy(double initialEnergyJ);
 
    void SetSupplyVoltage(double supplyVoltageV);
 
    void SetEnergyUpdateInterval(Time interval);
 
    Time GetEnergyUpdateInterval() const;
 
  private:
    void DoInitialize() override;
 
    void DoDispose() override;
 
    void HandleEnergyDrainedEvent();
 
    void HandleEnergyRechargedEvent();
 
    void CalculateRemainingEnergy();
 
  private:
    double m_initialEnergyJ; 
    double m_supplyVoltageV; 
    double m_lowBatteryTh;   
    double m_highBatteryTh;  
    bool m_depleted;
    TracedValue<double> m_remainingEnergyJ; 
    EventId m_energyUpdateEvent;            
    Time m_lastUpdateTime;                  
    Time m_energyUpdateInterval;            
};
 
} // namespace ns3
 
#endif /* BASIC_ENERGY_SOURCE_H */