acoustic-modem-energy-model.h

Go to the documentation of this file.

/*
 * 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/event-id.h"
#include "ns3/nstime.h"
#include "ns3/traced-value.h"
 
namespace ns3
{
 
class AcousticModemEnergyModel : public DeviceEnergyModel
{
  public:
    typedef Callback<void> AcousticModemEnergyDepletionCallback;
 
    typedef Callback<void> AcousticModemEnergyRechargeCallback;
 
  public:
    static TypeId GetTypeId();
    AcousticModemEnergyModel();
    ~AcousticModemEnergyModel() override;
 
    virtual void SetNode(Ptr<Node> node);
 
    virtual Ptr<Node> GetNode() const;
 
    // Inherited methods.
    void SetEnergySource(Ptr<EnergySource> source) override;
    double GetTotalEnergyConsumption() const override;
 
    double GetTxPowerW() const;
 
    void SetTxPowerW(double txPowerW);
 
    double GetRxPowerW() const;
 
    void SetRxPowerW(double rxPowerW);
 
    double GetIdlePowerW() const;
 
    void SetIdlePowerW(double idlePowerW);
 
    double GetSleepPowerW() const;
 
    void SetSleepPowerW(double sleepPowerW);
 
    int GetCurrentState() const;
 
    void SetEnergyDepletionCallback(AcousticModemEnergyDepletionCallback callback);
 
    void SetEnergyRechargeCallback(AcousticModemEnergyRechargeCallback callback);
 
    void ChangeState(int newState) override;
 
    void HandleEnergyDepletion() override;
 
    void HandleEnergyRecharged() override;
 
    void HandleEnergyChanged() override;
 
  private:
    void DoDispose() override;
 
    double DoGetCurrentA() const override;
 
    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; 
 
    TracedValue<double> m_totalEnergyConsumption;
 
    // State variables.
    int m_currentState;    
    Time m_lastUpdateTime; 
 
    AcousticModemEnergyDepletionCallback m_energyDepletionCallback;
 
    AcousticModemEnergyRechargeCallback m_energyRechargeCallback;
 
}; // class AcousticModemEnergyModel
 
} // namespace ns3
 
#endif /* ACOUSTIC_MODEM_ENERGY_MODEL_H */