wifi-radio-energy-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 WIFI_RADIO_ENERGY_MODEL_H
#define WIFI_RADIO_ENERGY_MODEL_H

#include "ns3/device-energy-model.h"
#include "ns3/nstime.h"
#include "ns3/event-id.h"
#include "ns3/traced-value.h"
#include "ns3/wifi-phy.h"

namespace ns3 {

class WifiTxCurrentModel;

class WifiRadioEnergyModelPhyListener : public WifiPhyListener
{
public:
  typedef Callback<void, double> UpdateTxCurrentCallback;

  WifiRadioEnergyModelPhyListener ();
  virtual ~WifiRadioEnergyModelPhyListener ();

  void SetChangeStateCallback (DeviceEnergyModel::ChangeStateCallback callback);

  void SetUpdateTxCurrentCallback (UpdateTxCurrentCallback callback);

  virtual void NotifyRxStart (Time duration);

  virtual void NotifyRxEndOk (void);

  virtual void NotifyRxEndError (void);

  virtual void NotifyTxStart (Time duration, double txPowerDbm);

  virtual void NotifyMaybeCcaBusyStart (Time duration);

  virtual void NotifySwitchingStart (Time duration);

  virtual void NotifySleep (void);

  virtual void NotifyWakeup (void);

private:
  void SwitchToIdle (void);

private:
  DeviceEnergyModel::ChangeStateCallback m_changeStateCallback;

  UpdateTxCurrentCallback m_updateTxCurrentCallback;

  EventId m_switchToIdleEvent;
};

// -------------------------------------------------------------------------- //

class WifiRadioEnergyModel : public DeviceEnergyModel
{
public:
  typedef Callback<void> WifiRadioEnergyDepletionCallback;

  typedef Callback<void> WifiRadioEnergyRechargedCallback;

public:
  static TypeId GetTypeId (void);
  WifiRadioEnergyModel ();
  virtual ~WifiRadioEnergyModel ();

  virtual void SetEnergySource (Ptr<EnergySource> source);

  virtual double GetTotalEnergyConsumption (void) const;

  // Setter & getters for state power consumption.
  double GetIdleCurrentA (void) const;
  void SetIdleCurrentA (double idleCurrentA);
  double GetCcaBusyCurrentA (void) const;
  void SetCcaBusyCurrentA (double ccaBusyCurrentA);
  double GetTxCurrentA (void) const;
  void SetTxCurrentA (double txCurrentA);
  double GetRxCurrentA (void) const;
  void SetRxCurrentA (double rxCurrentA);
  double GetSwitchingCurrentA (void) const;
  void SetSwitchingCurrentA (double switchingCurrentA);
  double GetSleepCurrentA (void) const;
  void SetSleepCurrentA (double sleepCurrentA);

  WifiPhy::State GetCurrentState (void) const;

  void SetEnergyDepletionCallback (WifiRadioEnergyDepletionCallback callback);

  void SetEnergyRechargedCallback (WifiRadioEnergyRechargedCallback callback);

  void SetTxCurrentModel (Ptr<WifiTxCurrentModel> model);

  void SetTxCurrentFromModel (double txPowerDbm);

  virtual void ChangeState (int newState);

  virtual void HandleEnergyDepletion (void);

  virtual void HandleEnergyRecharged (void);

  WifiRadioEnergyModelPhyListener * GetPhyListener (void);


private:
  void DoDispose (void);

  virtual double DoGetCurrentA (void) const;

  void SetWifiRadioState (const WifiPhy::State state);

private:
  Ptr<EnergySource> m_source;

  // Member variables for current draw in different radio modes.
  double m_txCurrentA;
  double m_rxCurrentA;
  double m_idleCurrentA;
  double m_ccaBusyCurrentA;
  double m_switchingCurrentA;
  double m_sleepCurrentA;
  Ptr<WifiTxCurrentModel> m_txCurrentModel;

  // This variable keeps track of the total energy consumed by this model.
  TracedValue<double> m_totalEnergyConsumption;

  // State variables.
  WifiPhy::State m_currentState;  // current state the radio is in
  Time m_lastUpdateTime;          // time stamp of previous energy update

  uint8_t m_nPendingChangeState;
  bool m_isSupersededChangeState;

  // Energy depletion callback
  WifiRadioEnergyDepletionCallback m_energyDepletionCallback;

  // Energy recharged callback
  WifiRadioEnergyRechargedCallback m_energyRechargedCallback;

  // WifiPhy listener
  WifiRadioEnergyModelPhyListener *m_listener;
};

} // namespace ns3

#endif /* WIFI_RADIO_ENERGY_MODEL_H */