/usr/include/ns3.26/ns3/wifi-mac-helper.h is in libns3-dev 3.26+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 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2016
*
* 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: Sébastien Deronne <sebastien.deronne@gmail.com>
*/
#ifndef WIFI_MAC_HELPER_H
#define WIFI_MAC_HELPER_H
#include <string>
#include "ns3/attribute.h"
#include "ns3/object-factory.h"
namespace ns3 {
class WifiMac;
/**
* \brief create MAC layers for a ns3::WifiNetDevice.
*
* This class can create MACs of type ns3::ApWifiMac, ns3::StaWifiMac and ns3::AdhocWifiMac.
* Its purpose is to allow a WifiHelper to configure and install WifiMac objects on a collection
* of nodes. The WifiMac objects themselves are mainly composed of TxMiddle, RxMiddle, DcfManager,
* MacLow, WifiRemoteStationManager, MpduAggregator and MsduAggregartor objects, so this helper
* offers the opportunity to configure attribute values away from their default values, on a
* per-NodeContainer basis. By default, it creates an Adhoc MAC layer without QoS. Typically,
* it is used to set type and attribute values, then hand this object over to the WifiHelper that
* finishes the job of installing.
*
* This class is a merge of two previous helpers (ns3::NqosWifiMacHelper and ns::3 QosWifiMacHelper)
* that Mirko Banchi (mk.banchi@gmail.com) originally contributed.
* It should now be used instead of those two deprecated helpers.
*
* This class may be further subclassed (WaveMacHelper is an example of this).
*
*/
class WifiMacHelper
{
public:
/**
* Create a WifiMacHelper to make life easier for people who want to
* work with Wifi MAC layers.
*/
WifiMacHelper ();
/**
* Destroy a WifiMacHelper.
*/
virtual ~WifiMacHelper ();
/**
* \param type the type of ns3::WifiMac to create.
* Valid values of the type field must be a type subclassed from WifiMac.
*
* \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
* \param n8 the name of the attribute to set
* \param v8 the value of the attribute to set
* \param n9 the name of the attribute to set
* \param v9 the value of the attribute to set
* \param n10 the name of the attribute to set
* \param v10 the value of the attribute to set
*
* All the attributes specified in this method should exist
* in the requested mac.
*/
virtual void SetType (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 (),
std::string n8 = "", const AttributeValue &v8 = EmptyAttributeValue (),
std::string n9 = "", const AttributeValue &v9 = EmptyAttributeValue (),
std::string n10 = "", const AttributeValue &v10 = EmptyAttributeValue ());
/**
* \returns a new MAC object.
*
* This allows the ns3::WifiHelper class to create MAC objects from ns3::WifiHelper::Install.
*/
virtual Ptr<WifiMac> Create (void) const;
protected:
ObjectFactory m_mac;
};
} // namespace ns3
#endif /* WIFI_MAC_HELPER_H */
|