/usr/include/ns3.27/ns3/yans-wifi-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 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2008 INRIA
*
* 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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
*/
#ifndef YANS_WIFI_HELPER_H
#define YANS_WIFI_HELPER_H
#include "wifi-helper.h"
#include "ns3/yans-wifi-channel.h"
namespace ns3 {
/**
* \brief manage and create wifi channel objects for the yans model.
*
* The intent of this class is to make it easy to create a channel object
* which implements the yans channel model. The yans channel model is described
* in "Yet Another Network Simulator", http://cutebugs.net/files/wns2-yans.pdf
*/
class YansWifiChannelHelper
{
public:
/**
* Create a channel helper without any parameter set. The user must set
* them all to be able to call Create later.
*/
YansWifiChannelHelper ();
/**
* Create a channel helper in a default working state. By default, we create
* a channel model with a propagation delay equal to a constant, the speed of light,
* and a propagation loss based on a log distance model with a reference loss of 46.6777 dB
* at reference distance of 1m.
* \returns YansWifiChannelHelper
*/
static YansWifiChannelHelper Default (void);
/**
* \param name the name of the model to add
* \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
*
* Add a propagation loss model to the set of currently-configured loss models.
* This method is additive to allow you to construct complex propagation loss models
* such as a log distance + jakes model, etc.
*
* The order in which PropagationLossModels are added may be significant. Some
* propagation models are dependent of the "txPower" (eg. Nakagami model), and
* are therefore not commutative. The final receive power (excluding receiver
* gains) are calculated in the order the models are added.
*/
void AddPropagationLoss (std::string name,
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 ());
/**
* \param name the name of the model to set
* \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
*
* Configure a propagation delay for this channel.
*/
void SetPropagationDelay (std::string name,
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 ());
/**
* \returns a new channel
*
* Create a channel based on the configuration parameters set previously.
*/
Ptr<YansWifiChannel> Create (void) const;
/**
* Assign a fixed random variable stream number to the random variables
* used by the channel. Typically this corresponds to random variables
* used in the propagation loss models. Return the number of streams
* (possibly zero) that have been assigned.
*
* \param c NetDeviceContainer of the set of net devices for which the
* WifiNetDevice should be modified to use fixed streams
* \param stream first stream index to use
*
* \return the number of stream indices assigned by this helper
*/
int64_t AssignStreams (Ptr<YansWifiChannel> c, int64_t stream);
private:
std::vector<ObjectFactory> m_propagationLoss; ///< vector of propagation loss models
ObjectFactory m_propagationDelay; ///< propagation delay model
};
/**
* \brief Make it easy to create and manage PHY objects for the yans model.
*
* The yans PHY model is described in "Yet Another Network Simulator",
* http://cutebugs.net/files/wns2-yans.pdf
*
* The Pcap and ascii traces generated by the EnableAscii and EnablePcap methods defined
* in this class correspond to PHY-level traces and come to us via WifiPhyHelper
*
*/
class YansWifiPhyHelper : public WifiPhyHelper
{
public:
/**
* Create a phy helper without any parameter set. The user must set
* them all to be able to call Install later.
*/
YansWifiPhyHelper ();
/**
* Create a phy helper in a default working state.
* \returns a default YansWifiPhyHelper
*/
static YansWifiPhyHelper Default (void);
/**
* \param channel the channel to associate to this helper
*
* Every PHY created by a call to Install is associated to this channel.
*/
void SetChannel (Ptr<YansWifiChannel> channel);
/**
* \param channelName The name of the channel to associate to this helper
*
* Every PHY created by a call to Install is associated to this channel.
*/
void SetChannel (std::string channelName);
private:
/**
* \param node the node on which we wish to create a wifi PHY
* \param device the device within which this PHY will be created
* \returns a newly-created PHY object.
*
* This method implements the pure virtual method defined in \ref ns3::WifiPhyHelper.
*/
virtual Ptr<WifiPhy> Create (Ptr<Node> node, Ptr<NetDevice> device) const;
Ptr<YansWifiChannel> m_channel; ///< yans wifi channel
};
} //namespace ns3
#endif /* YANS_WIFI_HELPER_H */
|