device-energy-model.h

Go to the documentation of this file.

/*
 * 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 DEVICE_ENERGY_MODEL_H
#define DEVICE_ENERGY_MODEL_H
 
#include "ns3/node.h"
#include "ns3/object.h"
#include "ns3/ptr.h"
#include "ns3/type-id.h"
 
namespace ns3
{
 
class EnergySource;
 
class DeviceEnergyModel : public Object
{
  public:
    typedef Callback<void, int> ChangeStateCallback;
 
  public:
    static TypeId GetTypeId();
    DeviceEnergyModel();
    ~DeviceEnergyModel() override;
 
    virtual void SetEnergySource(Ptr<EnergySource> source) = 0;
 
    virtual double GetTotalEnergyConsumption() const = 0;
 
    virtual void ChangeState(int newState) = 0;
 
    double GetCurrentA() const;
 
    virtual void HandleEnergyDepletion() = 0;
 
    virtual void HandleEnergyRecharged() = 0;
 
    virtual void HandleEnergyChanged() = 0;
 
  private:
    virtual double DoGetCurrentA() const;
};
 
} // namespace ns3
 
#endif /* DEVICE_ENERGY_MODEL_H */