/usr/include/ns3.17/ns3/energy-source-container.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 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2008 INRIA
* 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
* Sidharth Nabar <snabar@uw.edu>, He Wu <mdzz@u.washington.edu>
*/
#ifndef ENERGY_SOURCE_CONTAINER_H
#define ENERGY_SOURCE_CONTAINER_H
#include "ns3/energy-source.h"
#include "ns3/object.h"
#include <vector>
#include <stdint.h>
namespace ns3 {
/**
* \ingroup energy
* \brief Holds a vector of ns3::EnergySource pointers.
*
* EnergySourceHelper returns a list of EnergySource pointers installed onto a
* node. Users can use this list to access EnergySource objects to obtain total
* energy consumption on a node easily.
*
* \see NetDeviceContainer
*
*/
class EnergySourceContainer : public Object
{
public:
typedef std::vector< Ptr<EnergySource> >::const_iterator Iterator;
public:
static TypeId GetTypeId (void);
/**
* Creates an empty EnergySourceContainer.
*/
EnergySourceContainer ();
~EnergySourceContainer ();
/**
* \param source Pointer to an EnergySource.
*
* Creates an EnergySourceContianer with exactly one EnergySource previously
* instantiated.
*/
EnergySourceContainer (Ptr<EnergySource> source);
/**
* \param sourceName Name of EnergySource.
*
* Creates an EnergySourceContainer with exactly one EnergySource previously
* instantiated and assigned a name using the Object name service. This
* EnergySource is specified by its assigned name.
*/
EnergySourceContainer (std::string sourceName);
/**
* \param a A EnergySourceContainer.
* \param b Another EnergySourceContainer.
*
* Creates an EnergySourceContainer by concatenating EnergySourceContainer b
* to EnergySourceContainer a.
*
* \note Can be used to concatenate 2 Ptr<EnergySource> directly. C++ will be
* calling EnergySourceContainer constructor with Ptr<EnergySource> first.
*/
EnergySourceContainer (const EnergySourceContainer &a,
const EnergySourceContainer &b);
/**
* \brief Get an iterator which refers to the first EnergySource pointer in
* the container.
*
* \returns An iterator which refers to the first EnergySource in container.
*
* EnergySources can be retrieved from the container in two ways. First,
* directly by an index into the container, and second, using an iterator.
* This method is used in the iterator method and is typically used in a
* for-loop to run through the EnergySources.
*
* \code
* EnergySourceContainer::Iterator i;
* for (i = container.Begin (); i != container.End (); ++i)
* {
* (*i)->method (); // some EnergySource method
* }
* \endcode
*/
Iterator Begin (void) const;
/**
* \brief Get an iterator which refers to the last EnergySource pointer in
* the container.
*
* \returns An iterator which refers to the last EnergySource in container.
*
* EnergySources can be retrieved from the container in two ways. First,
* directly by an index into the container, and second, using an iterator.
* This method is used in the iterator method and is typically used in a
* for-loop to run through the EnergySources.
*
* \code
* EnergySourceContainer::Iterator i;
* for (i = container.Begin (); i != container.End (); ++i)
* {
* (*i)->method (); // some EnergySource method
* }
* \endcode
*/
Iterator End (void) const;
/**
* \brief Get the number of Ptr<EnergySource> stored in this container.
*
* \returns The number of Ptr<EnergySource> stored in this container.
*/
uint32_t GetN (void) const;
/**
* \brief Get the i-th Ptr<EnergySource> stored in this container.
*
* \param i Index of the requested Ptr<EnergySource>.
* \returns The requested Ptr<EnergySource>.
*/
Ptr<EnergySource> Get (uint32_t i) const;
/**
* \param container Another EnergySourceContainer to append.
*
* Appends the contents of another EnergySourceContainer to the end of this
* EnergySourceContainer.
*/
void Add (EnergySourceContainer container);
/**
* \brief Append a single Ptr<EnergySource> to the end of this container.
*
* \param source Pointer to an EnergySource.
*/
void Add (Ptr<EnergySource> source);
/**
* \brief Append a single Ptr<EnergySource> referred to by its object name to
* the end of this container.
*
* \param sourceName Name of EnergySource object.
*/
void Add (std::string sourceName);
private:
virtual void DoDispose (void);
/**
* \brief Calls Object::Start () for all EnergySource objects.
*/
virtual void DoInitialize (void);
private:
std::vector< Ptr<EnergySource> > m_sources;
};
} // namespace ns3
#endif /* ENERGY_SOURCE_CONTAINER_H */
|