libns3-dev 3.27+dfsg-1 / usr / include / ns3.27 / ns3 / uan-helper.h

This file is indexed.

/usr/include/ns3.27/ns3/uan-helper.h is in libns3-dev 3.27+dfsg-1.

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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2008 University of Washington
 *
 * 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: Leonard Tracy <lentracy@u.washington.edu>
 */

#ifndef UAN_HELPER_H
#define UAN_HELPER_H

#include <string>
#include "ns3/attribute.h"
#include "ns3/object-factory.h"
#include "ns3/node-container.h"
#include "ns3/net-device-container.h"
#include "ns3/uan-net-device.h"

namespace ns3 {

class UanChannel;

/**
 * \ingroup uan
 *
 * UAN configuration helper.
 */
class UanHelper
{
public:
  UanHelper ();           //!< Defalt constructor.
  virtual ~UanHelper ();  //!< Destructor.

  /**
   * Set MAC attributes.
   *
   * \param type The type of ns3::UanMac to create.
   * \param n0 The name of the attribute to set.
   * \param v0 The value of the attribute to set.
   * \param n1 The name of the attribute to set.
   * \param v1 The value of the attribute to set.
   * \param n2 The name of the attribute to set.
   * \param v2 The value of the attribute to set.
   * \param n3 The name of the attribute to set.
   * \param v3 The value of the attribute to set.
   * \param n4 The name of the attribute to set.
   * \param v4 The value of the attribute to set.
   * \param n5 The name of the attribute to set.
   * \param v5 The value of the attribute to set.
   * \param n6 The name of the attribute to set.
   * \param v6 The value of the attribute to set.
   * \param n7 The name of the attribute to set.
   * \param v7 The value of the attribute to set.
   *
   * All the attributes specified in this method should exist
   * in the requested mac.
   */
  void SetMac (std::string type,
               std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
               std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
               std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
               std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
               std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
               std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
               std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
               std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());


  /**
   * Set PHY attributes.
   *
   * \param phyType The type of ns3::UanPhy to create.
   * \param n0 The name of the attribute to set.
   * \param v0 The value of the attribute to set.
   * \param n1 The name of the attribute to set.
   * \param v1 The value of the attribute to set.
   * \param n2 The name of the attribute to set.
   * \param v2 The value of the attribute to set.
   * \param n3 The name of the attribute to set.
   * \param v3 The value of the attribute to set.
   * \param n4 The name of the attribute to set.
   * \param v4 The value of the attribute to set.
   * \param n5 The name of the attribute to set.
   * \param v5 The value of the attribute to set.
   * \param n6 The name of the attribute to set.
   * \param v6 The value of the attribute to set.
   * \param n7 The name of the attribute to set.
   * \param v7 The value of the attribute to set.
   *
   * All the attributes specified in this method should exist
   * in the requested Phy.
   */
  void SetPhy (std::string phyType,
               std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
               std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
               std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
               std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
               std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
               std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
               std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
               std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());


  /**
   * Set the transducer attributes.
   *
   * \param type The type of ns3::Transducer to create.
   * \param n0 The name of the attribute to set.
   * \param v0 The value of the attribute to set.
   * \param n1 The name of the attribute to set.
   * \param v1 The value of the attribute to set.
   * \param n2 The name of the attribute to set.
   * \param v2 The value of the attribute to set.
   * \param n3 The name of the attribute to set.
   * \param v3 The value of the attribute to set.
   * \param n4 The name of the attribute to set.
   * \param v4 The value of the attribute to set.
   * \param n5 The name of the attribute to set.
   * \param v5 The value of the attribute to set.
   * \param n6 The name of the attribute to set.
   * \param v6 The value of the attribute to set.
   * \param n7 The name of the attribute to set.
   * \param v7 The value of the attribute to set.
   *
   * All the attributes specified in this method should exist
   * in the requested transducer.
   */
  void SetTransducer (std::string type,
                      std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
                      std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
                      std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
                      std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
                      std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
                      std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
                      std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
                      std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
  /**
   * Enable ascii output on the specified deviceid within the
   * specified nodeid if it is of type ns3::UanNetDevice and dump
   * that to the specified stdc++ output stream.
   *
   * \param os Output stream.
   * \param nodeid The id of the node to generate ascii output for.
   * \param deviceid The id of the device to generate ascii output for.
   */
  static void EnableAscii (std::ostream &os, uint32_t nodeid, uint32_t deviceid);
  /**
   * Enable ascii output on each device which is of the
   * ns3::UanNetDevice type and which is located in the input
   * device container and dump that to the specified
   * stdc++ output stream.
   *
   * \param os Output stream.
   * \param d Device container.
   */
  static void EnableAscii (std::ostream &os, NetDeviceContainer d);
  /**
   * Enable ascii output on each device which is of the
   * ns3::UanNetDevice type and which is located in one
   * of the input node and dump that to the specified
   * stdc++ output stream.
   *
   * \param os Output stream.
   * \param n Node container.
   */
  static void EnableAscii (std::ostream &os, NodeContainer n);
  /**
   * Enable ascii output on each device which is of the
   * ns3::UanNetDevice type and dump that to the specified
   * stdc++ output stream.
   *
   * \param os Output stream.
   */
  static void EnableAsciiAll (std::ostream &os);

  /**
   * This method creates a simple ns3::UanChannel (with a default
   * ns3::UanNoiseModelDefault and ns3::UanPropModelIdeal) and
   * creates, for each of the input nodes, a new ns3::UanNetDevice
   * attached to this shared channel. Each ns3::UanNetDevice is also
   * configured with an ns3::UanTransducerHd, ns3::UanMac, and,
   * ns3::UanPhy, all of which are created based on the user-specified
   * attributes specified in UanHelper::SetTransducer,
   * UanHelper::SetMac, and, UanHelper::SetPhy.
   *
   * \param c A set of nodes.
   * \return The installed netdevices.
   */
  NetDeviceContainer Install (NodeContainer c) const;
  
  /**
   * For each of the input nodes, a new ns3::UanNetDevice is attached
   * to the shared input channel. Each ns3::UanNetDevice is also
   * configured with an ns3::UanTransducerHd, a ns3::UanMac, and ns3::UanPhy,
   * all of which are created based on the user-specified attributes
   * specified in UanHelper::SetTransducer, UanHelper::SetMac, and
   * UanHelper::SetPhy.
   *
   * \param c A set of nodes.
   * \param channel A channel to use.
   * \return The installed netdevices.
   */
  NetDeviceContainer Install (NodeContainer c, Ptr<UanChannel> channel) const;

  /**
   * Create a default an stack.
   *
   * The stack includes:
   * - default channel, ideal propagation and default noise model.
   * - default physical layer, with UanPhyGen.
   * - default transducer, half duplex acoustic modem with UanTransducerHd.
   * - default MAC layer, with UanMacAloha.
   *
   * Channel, physical layer, transducer and mac layer are added to the
   * UanNetDevice and then added to the node.
   *
   * \param node A node where to install the uan components.
   * \param channel A channel to use.
   * \return The installed UanNetDevice.
   */
  Ptr<UanNetDevice> Install (Ptr<Node> node, Ptr<UanChannel> channel) const;

  /**
  * Assign a fixed random variable stream number to the random variables
  * used by this model. Return the number of streams (possibly zero) that
  * have been assigned. The Install() method should have previously been
  * called by the user.
  *
  * \param c NetDeviceContainer of the set of net devices for which the 
  *          UanNetDevice should be modified to use a fixed stream.
  * \param stream First stream index to use.
  * \return The number of stream indices assigned by this helper.
  */
  int64_t AssignStreams (NetDeviceContainer c, int64_t stream);

private:
  ObjectFactory m_device;      //!< The device.
  ObjectFactory m_mac;         //!< The MAC layer.
  ObjectFactory m_phy;         //!< The PHY layer.
  ObjectFactory m_transducer;  //!< The transducer.

};


} // end namespace ns3

#endif /* UAN_HELPER_H */

APT Browse - Built by Thomas Orozco.