rv-battery-model.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 RV_BATTERY_MODEL_H
#define RV_BATTERY_MODEL_H

#include "ns3/traced-value.h"
#include "ns3/nstime.h"
#include "ns3/event-id.h"
#include "energy-source.h"

namespace ns3 {

class RvBatteryModel : public EnergySource
{
public:
  static TypeId GetTypeId (void);
  RvBatteryModel ();
  virtual ~RvBatteryModel ();

  virtual double GetInitialEnergy (void) const;

  virtual double GetSupplyVoltage (void) const;

  virtual double GetRemainingEnergy (void);

  virtual double GetEnergyFraction (void);

  virtual void UpdateEnergySource (void);

  void SetSamplingInterval (Time interval);

  Time GetSamplingInterval (void) const;

  void SetOpenCircuitVoltage (double voltage);

  double GetOpenCircuitVoltage (void) const;

  void SetCutoffVoltage (double voltage);

  double GetCutoffVoltage (void) const;

  void SetAlpha (double alpha);

  double GetAlpha (void) const;

  void SetBeta (double beta);

  double GetBeta (void) const;

  double GetBatteryLevel (void);

  Time GetLifetime (void) const;

  void SetNumOfTerms (int num);

  int GetNumOfTerms (void) const;

private:
  virtual void DoInitialize (void);

  virtual void DoDispose (void);

  void HandleEnergyDrainedEvent (void);

  double Discharge (double load, Time t);

  double RvModelAFunction (Time t, Time sk, Time sk_1, double beta);

private:
  double m_openCircuitVoltage;
  double m_cutoffVoltage;
  double m_alpha; // alpha value of RV model, in Coulomb
  double m_beta;  // beta value of RV model, in second^-1

  double m_previousLoad;  // load value (total current) of previous sampling
  std::vector<double> m_load;     // load profile
  std::vector<Time> m_timeStamps; // time stamps of load profile
  Time m_lastSampleTime;

  int m_numOfTerms; // # of terms for infinite sum in battery level estimation

  TracedValue<double> m_batteryLevel;

  double m_lowBatteryTh;           // low battery threshold, as a fraction of the initial energy

  Time m_samplingInterval;
  EventId m_currentSampleEvent;

  TracedValue<Time> m_lifetime;   // time of death of the battery
};

} // namespace ns3

#endif  /* RV_BATTERY_MODEL_H */