acoustic-modem-energy-model.h

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2010 Andrea Sacco
 *
 * 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: Andrea Sacco <andrea.sacco85@gmail.com>
 */

#ifndef ACOUSTIC_MODEM_ENERGY_MODEL_H
#define ACOUSTIC_MODEM_ENERGY_MODEL_H

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

namespace ns3 {

class AcousticModemEnergyModel : public DeviceEnergyModel
{
public:
  typedef Callback<void> AcousticModemEnergyDepletionCallback;

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

  virtual void SetNode (Ptr<Node> node);

  virtual Ptr<Node> GetNode (void) const;

  virtual void SetEnergySource (Ptr<EnergySource> source);

  virtual double GetTotalEnergyConsumption (void) const;

  double GetTxPowerW (void) const;

  void SetTxPowerW (double txPowerW);

  double GetRxPowerW (void) const;

  void SetRxPowerW (double rxPowerW);

  double GetIdlePowerW (void) const;

  void SetIdlePowerW (double idlePowerW);

  double GetSleepPowerW (void) const;

  void SetSleepPowerW (double sleepPowerW);

  int GetCurrentState (void) const;

  void SetEnergyDepletionCallback (AcousticModemEnergyDepletionCallback callback);

  virtual void ChangeState (int newState);

  virtual void HandleEnergyDepletion (void);


private:
  void DoDispose (void);

  virtual double DoGetCurrentA (void) const;

  bool IsStateTransitionValid (const int destState);

  void SetMicroModemState (const int state);

private:
  Ptr<Node> m_node;
  Ptr<EnergySource> m_source;

  // Member variables for power consumption in different modem states.
  double m_txPowerW;
  double m_rxPowerW;
  double m_idlePowerW;
  double m_sleepPowerW;

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

  // State variables.
  int m_currentState;  // current state the modem is in
  Time m_lastUpdateTime;          // time stamp of previous energy update

  // energy depletion callback
  AcousticModemEnergyDepletionCallback m_energyDepletionCallback;
};

} // namespace ns3

#endif /* ACOUSTIC_MODEM_ENERGY_MODEL_H */