basic-energy-source.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * 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 "ns3/traced-value.h"
#include "ns3/nstime.h"
#include "ns3/event-id.h"
#include "energy-source.h"
 
namespace ns3 {
 
class BasicEnergySource : public EnergySource
{
public:
  static TypeId GetTypeId (void);
  BasicEnergySource ();
  virtual ~BasicEnergySource ();
 
  virtual double GetInitialEnergy (void) const;
 
  virtual double GetSupplyVoltage (void) const;
 
  virtual double GetRemainingEnergy (void);
 
  virtual double GetEnergyFraction (void);
 
  virtual void UpdateEnergySource (void);
 
  void SetInitialEnergy (double initialEnergyJ);
 
  void SetSupplyVoltage (double supplyVoltageV);
 
  void SetEnergyUpdateInterval (Time interval);
 
  Time GetEnergyUpdateInterval (void) const;
 
 
private:
  void DoInitialize (void);
 
  void DoDispose (void);
 
  void HandleEnergyDrainedEvent (void);
 
  void HandleEnergyRechargedEvent (void);
 
  void CalculateRemainingEnergy (void);
 
private:
  double m_initialEnergyJ;                // initial energy, in Joules
  double m_supplyVoltageV;                // supply voltage, in Volts
  double m_lowBatteryTh;                  // low battery threshold, as a fraction of the initial energy
  double m_highBatteryTh;                 // high battery threshold, as a fraction of the initial energy
  bool m_depleted;                        // set to true when the remaining energy goes below the low threshold,
                                          // set to false again when the remaining energy exceeds the high threshold
  TracedValue<double> m_remainingEnergyJ; // remaining energy, in Joules
  EventId m_energyUpdateEvent;            // energy update event
  Time m_lastUpdateTime;                  // last update time
  Time m_energyUpdateInterval;            // energy update interval
 
};
 
} // namespace ns3
 
#endif /* BASIC_ENERGY_SOURCE_H */