/usr/include/ns3.17/ns3/simple-device-energy-model.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 | /* -*- 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 SIMPLE_DEVICE_ENERGY_MODEL_H
#define SIMPLE_DEVICE_ENERGY_MODEL_H
#include "ns3/device-energy-model.h"
#include "ns3/nstime.h"
#include "ns3/traced-value.h"
namespace ns3 {
/**
* \ingroup energy
*
* A simple device energy model where current drain can be set by the user.
*
* It is supposed to be used as a testing model for energy sources.
*
*/
class SimpleDeviceEnergyModel : public DeviceEnergyModel
{
public:
static TypeId GetTypeId (void);
SimpleDeviceEnergyModel ();
virtual ~SimpleDeviceEnergyModel ();
/**
* \brief Sets pointer to node.
*
* \param node Pointer to node.
*
* Implements DeviceEnergyModel::SetNode.
*/
virtual void SetNode (Ptr<Node> node);
/**
* \brief Gets pointer to node.
*
* \returns Pointer to node.
*
* Implements DeviceEnergyModel::GetNode.
*/
virtual Ptr<Node> GetNode (void) const;
/**
* \brief Sets pointer to EnergySouce installed on node.
*
* \param source Pointer to EnergySource installed on node.
*
* Implements DeviceEnergyModel::SetEnergySource.
*/
virtual void SetEnergySource (Ptr<EnergySource> source);
/**
* \returns Total energy consumption of the vehicle.
*
* Implements DeviceEnergyModel::GetTotalEnergyConsumption.
*/
virtual double GetTotalEnergyConsumption (void) const;
/**
* \param newState New state the device is in.
*
* Not implemented
*/
virtual void ChangeState (int newState)
{
}
/**
* \brief Handles energy depletion.
*
* Not implemented
*/
virtual void HandleEnergyDepletion (void)
{
}
/**
* \param current the current draw of device.
*
* Set the actual current draw of the device.
*/
void SetCurrentA (double current);
private:
void DoDispose (void);
/**
* \returns Current draw of device, at current state.
*
* Implements DeviceEnergyModel::GetCurrentA.
*/
virtual double DoGetCurrentA (void) const;
Time m_lastUpdateTime;
double m_actualCurrentA;
Ptr<EnergySource> m_source;
Ptr<Node> m_node;
TracedValue<double> m_totalEnergyConsumption;
};
} // namespace ns3
#endif /* SIMPLE_DEVICE_ENERGY_MODEL_H */
|