src/helper/nqos-wifi-mac-helper.h
author Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
Fri, 03 Jul 2009 09:08:01 +0200
changeset 4648 e72d6bc8b814
parent 4529 68d6cf654acb
permissions -rw-r--r--
tweak doxygen
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4406
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
     1
/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
     2
/*
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
     3
 * Copyright (c) 2009 MIRKO BANCHI
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
     4
 *
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as 
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
     8
 *
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    12
 * GNU General Public License for more details.
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    13
 *
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    17
 *
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    18
 * Author: Mirko Banchi <mk.banchi@gmail.com>
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    19
 */
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    20
#ifndef NQOS_WIFI_MAC_HELPER_H
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    21
#define NQOS_WIFI_MAC_HELPER_H
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    22
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    23
#include "wifi-helper.h"
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    24
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    25
namespace ns3 {
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    26
4648
e72d6bc8b814 tweak doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4529
diff changeset
    27
/**
e72d6bc8b814 tweak doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4529
diff changeset
    28
 * \brief create non-qos MAC layers for a ns3::WifiNetDevice. 
e72d6bc8b814 tweak doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4529
diff changeset
    29
 * This class can create MACs of type ns3::NqapWifiMac, ns3::NqstaWifiMac, and, ns3::AdhocWifiMac
e72d6bc8b814 tweak doxygen
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4529
diff changeset
    30
 */
4406
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    31
class NqosWifiMacHelper : public WifiMacHelper
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    32
{
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    33
public:
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    34
  NqosWifiMacHelper ();
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    35
  virtual ~NqosWifiMacHelper ();
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    36
  /**
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    37
   * Create a mac helper in a default working state.
4529
68d6cf654acb document default
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents: 4406
diff changeset
    38
   * i.e., this is an adhoc mac by default.
4406
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    39
   */
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    40
  static NqosWifiMacHelper Default (void);
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    41
  /**
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    42
   * \param type the type of ns3::WifiMac to create.
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    43
   * \param n0 the name of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    44
   * \param v0 the value of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    45
   * \param n1 the name of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    46
   * \param v1 the value of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    47
   * \param n2 the name of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    48
   * \param v2 the value of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    49
   * \param n3 the name of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    50
   * \param v3 the value of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    51
   * \param n4 the name of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    52
   * \param v4 the value of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    53
   * \param n5 the name of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    54
   * \param v5 the value of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    55
   * \param n6 the name of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    56
   * \param v6 the value of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    57
   * \param n7 the name of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    58
   * \param v7 the value of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    59
   *
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    60
   * All the attributes specified in this method should exist
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    61
   * in the requested mac.
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    62
   */
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    63
  void SetType (std::string type,
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    64
                std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    65
                std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    66
                std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    67
                std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue (),
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    68
                std::string n4 = "", const AttributeValue &v4 = EmptyAttributeValue (),
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    69
                std::string n5 = "", const AttributeValue &v5 = EmptyAttributeValue (),
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    70
                std::string n6 = "", const AttributeValue &v6 = EmptyAttributeValue (),
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    71
                std::string n7 = "", const AttributeValue &v7 = EmptyAttributeValue ());
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    72
  /**
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    73
   * \param type the type of ns3::WifiMac to create.
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    74
   * \param n0 the name of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    75
   * \param v0 the value of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    76
   * \param n1 the name of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    77
   * \param v1 the value of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    78
   * \param n2 the name of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    79
   * \param v2 the value of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    80
   * \param n3 the name of the attribute to set
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    81
   */
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    82
  void SetDcaParameters (std::string n0 = "", const AttributeValue &v0 = EmptyAttributeValue (),
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    83
                         std::string n1 = "", const AttributeValue &v1 = EmptyAttributeValue (),
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    84
                         std::string n2 = "", const AttributeValue &v2 = EmptyAttributeValue (),
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    85
                         std::string n3 = "", const AttributeValue &v3 = EmptyAttributeValue ());
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    86
private:
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    87
  /**
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    88
   * \returns a newly-created MAC object.
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    89
   *
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    90
   * This method implements the pure virtual method defined in \ref ns3::WifiMacHelper.
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    91
   */
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    92
  virtual Ptr<WifiMac> Create (void) const;
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    93
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    94
  ObjectFactory m_mac;
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    95
  ObjectFactory m_queue;
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    96
};
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    97
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    98
} //namespace ns3
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
    99
39f119de91ef Add WifiMacHelper
Mirko Banchi <mk.banchi@gmail.com>
parents:
diff changeset
   100
#endif /* NQOS_WIFI_MAC_HELPER_H */