/usr/include/ns3.17/ns3/basic-energy-source.h is in libns3-dev 3.17+dfsg-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 | /* -*- 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 BASIC_ENERGY_SOURCE_H
#define BASIC_ENERGY_SOURCE_H
#include "ns3/traced-value.h"
#include "ns3/nstime.h"
#include "ns3/event-id.h"
#include "energy-source.h"
namespace ns3 {
/**
* \ingroup energy
* BasicEnergySource decreases/increases remaining energy stored in itself in
* linearly.
*
*/
class BasicEnergySource : public EnergySource
{
public:
static TypeId GetTypeId (void);
BasicEnergySource ();
virtual ~BasicEnergySource ();
/**
* \return Initial energy stored in energy source, in Joules.
*
* Implements GetInitialEnergy.
*/
virtual double GetInitialEnergy (void) const;
/**
* \returns Supply voltage at the energy source.
*
* Implements GetSupplyVoltage.
*/
virtual double GetSupplyVoltage (void) const;
/**
* \return Remaining energy in energy source, in Joules
*
* Implements GetRemainingEnergy.
*/
virtual double GetRemainingEnergy (void);
/**
* \returns Energy fraction.
*
* Implements GetEnergyFraction.
*/
virtual double GetEnergyFraction (void);
/**
* Implements UpdateEnergySource.
*/
virtual void UpdateEnergySource (void);
/**
* \param initialEnergyJ Initial energy, in Joules
*
* Sets initial energy stored in the energy source. Note that initial energy
* is assumed to be set before simulation starts and is set only once per
* simulation.
*/
void SetInitialEnergy (double initialEnergyJ);
/**
* \param supplyVoltageV Supply voltage at the energy source, in Volts.
*
* Sets supply voltage of the energy source.
*/
void SetSupplyVoltage (double supplyVoltageV);
/**
* \param interval Energy update interval.
*
* This function sets the interval between each energy update.
*/
void SetEnergyUpdateInterval (Time interval);
/**
* \returns The interval between each energy update.
*/
Time GetEnergyUpdateInterval (void) const;
private:
/// Defined in ns3::Object
void DoInitialize (void);
/// Defined in ns3::Object
void DoDispose (void);
/**
* Handles the remaining energy going to zero event. This function notifies
* all the energy models aggregated to the node about the energy being
* depleted. Each energy model is then responsible for its own handler.
*/
void HandleEnergyDrainedEvent (void);
/**
* Calculates remaining energy. This function uses the total current from all
* device models to calculate the amount of energy to decrease. The energy to
* decrease is given by:
* energy to decrease = total current * supply voltage * time duration
* This function subtracts the calculated energy to decrease from remaining
* energy.
*/
void CalculateRemainingEnergy (void);
private:
double m_initialEnergyJ; // initial energy, in Joules
double m_supplyVoltageV; // supply voltage, in Volts
TracedValue<double> m_remainingEnergyJ; // remaining energy, in Joules
EventId m_energyUpdateEvent; // energy update event
Time m_lastUpdateTime; // last update time
Time m_energyUpdateInterval; // energy update interval
};
} // namespace ns3
#endif /* BASIC_ENERGY_SOURCE_H */
|