energy-source.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>
 *
 * Copyright (c) 2014 Wireless Communications and Networking Group (WCNG),
 * University of Rochester, Rochester, NY, USA.
 *
 * Modifications made by: Cristiano Tapparello <cristiano.tapparello@rochester.edu>
 */


#ifndef ENERGY_SOURCE_H
#define ENERGY_SOURCE_H

#include "ns3/object.h"
#include "ns3/ptr.h"
#include "ns3/type-id.h"
#include "ns3/node.h"
#include "device-energy-model-container.h"  // #include "device-energy-model.h"
#include "ns3/energy-harvester.h"

namespace ns3 {
  
class EnergyHarvester;
  
class EnergySource : public Object
{
public:
  static TypeId GetTypeId (void);
  EnergySource ();
  virtual ~EnergySource ();

  virtual double GetSupplyVoltage (void) const = 0;

  virtual double GetInitialEnergy (void) const = 0;

  virtual double GetRemainingEnergy (void) = 0;

  virtual double GetEnergyFraction (void) = 0;

  virtual void UpdateEnergySource (void) = 0;

  void SetNode (Ptr<Node> node);

  Ptr<Node> GetNode (void) const;

  void AppendDeviceEnergyModel (Ptr<DeviceEnergyModel> deviceEnergyModelPtr);

  DeviceEnergyModelContainer FindDeviceEnergyModels (TypeId tid);

  DeviceEnergyModelContainer FindDeviceEnergyModels (std::string name);

  void InitializeDeviceModels (void);

  void DisposeDeviceModels (void);
  
  void ConnectEnergyHarvester (Ptr<EnergyHarvester> energyHarvesterPtr);


private:
  virtual void DoDispose (void);

private:
  DeviceEnergyModelContainer m_models;

  Ptr<Node> m_node;
    
  std::vector< Ptr<EnergyHarvester> > m_harvesters;


protected:
  double CalculateTotalCurrent (void);

  void NotifyEnergyDrained (void);

  void NotifyEnergyRecharged (void);

  void NotifyEnergyChanged (void);

  void BreakDeviceEnergyModelRefCycle (void);

};

} // namespace ns3

#endif /* ENERGY_SOURCE_H */