wifi-helper.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2008 INRIA
 * Copyright (c) 2009 MIRKO BANCHI
 *
 * 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>
 *          Mirko Banchi <mk.banchi@gmail.com>
 */

#ifndef WIFI_HELPER_H
#define WIFI_HELPER_H

#include "ns3/trace-helper.h"
#include "ns3/wifi-phy.h"
#include "ns3/qos-utils.h"
#include "wifi-mac-helper.h"
#include <functional>

namespace ns3 {

class WifiNetDevice;
class Node;
class RadiotapHeader;
class QueueItem;

class WifiPhyHelper : public PcapHelperForDevice,
                      public AsciiTraceHelperForDevice
{
public:
  WifiPhyHelper ();
  virtual ~WifiPhyHelper ();

  virtual Ptr<WifiPhy> Create (Ptr<Node> node, Ptr<NetDevice> device) const = 0;

  void Set (std::string name, const AttributeValue &v);
  void SetErrorRateModel (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 ());
  void SetFrameCaptureModel (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 ());
  void SetPreambleDetectionModel (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 ());

  void DisablePreambleDetectionModel ();

  enum SupportedPcapDataLinkTypes
  {
    DLT_IEEE802_11       = PcapHelper::DLT_IEEE802_11,       
    DLT_PRISM_HEADER     = PcapHelper::DLT_PRISM_HEADER,     
    DLT_IEEE802_11_RADIO = PcapHelper::DLT_IEEE802_11_RADIO  
  };

  void SetPcapDataLinkType (SupportedPcapDataLinkTypes dlt);

  PcapHelper::DataLinkType GetPcapDataLinkType (void) const;


protected:
  static void PcapSniffTxEvent (Ptr<PcapFileWrapper> file,
                                Ptr<const Packet> packet,
                                uint16_t channelFreqMhz,
                                WifiTxVector txVector,
                                MpduInfo aMpdu);
  static void PcapSniffRxEvent (Ptr<PcapFileWrapper> file,
                                Ptr<const Packet> packet,
                                uint16_t channelFreqMhz,
                                WifiTxVector txVector,
                                MpduInfo aMpdu,
                                SignalNoiseDbm signalNoise);

  ObjectFactory m_phy; 
  ObjectFactory m_errorRateModel; 
  ObjectFactory m_frameCaptureModel; 
  ObjectFactory m_preambleDetectionModel; 


private:
  static RadiotapHeader GetRadiotapHeader (Ptr<Packet> packet,
                                           uint16_t channelFreqMhz,
                                           WifiTxVector txVector,
                                           MpduInfo aMpdu);

  virtual void EnablePcapInternal (std::string prefix,
                                   Ptr<NetDevice> nd,
                                   bool promiscuous,
                                   bool explicitFilename);

  virtual void EnableAsciiInternal (Ptr<OutputStreamWrapper> stream,
                                    std::string prefix,
                                    Ptr<NetDevice> nd,
                                    bool explicitFilename);

  PcapHelper::DataLinkType m_pcapDlt; 
};


class WifiHelper
{
public:
  virtual ~WifiHelper ();

  WifiHelper ();

  void SetRemoteStationManager (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 ());

  void SetObssPdAlgorithm (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 ());

  void SetAckPolicySelectorForAc (AcIndex ac, 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 ());

  typedef std::function<std::size_t (Ptr<QueueItem>)> SelectQueueCallback;

  void SetSelectQueueCallback (SelectQueueCallback f);
  NetDeviceContainer
  virtual Install (const WifiPhyHelper &phy,
                   const WifiMacHelper &mac,
                   NodeContainer::Iterator first,
                   NodeContainer::Iterator last) const;
  virtual NetDeviceContainer Install (const WifiPhyHelper &phy,
                                      const WifiMacHelper &mac, NodeContainer c) const;
  virtual NetDeviceContainer Install (const WifiPhyHelper &phy,
                                      const WifiMacHelper &mac, Ptr<Node> node) const;
  virtual NetDeviceContainer Install (const WifiPhyHelper &phy,
                                      const WifiMacHelper &mac, std::string nodeName) const;
  virtual void SetStandard (WifiPhyStandard standard);

  static void EnableLogComponents (void);

  int64_t AssignStreams (NetDeviceContainer c, int64_t stream);


protected:
  ObjectFactory m_stationManager;            
  ObjectFactory m_ackPolicySelector[4];      
  WifiPhyStandard m_standard;                
  SelectQueueCallback m_selectQueueCallback; 
  ObjectFactory m_obssPdAlgorithm;           
};

} //namespace ns3

#endif /* WIFI_HELPER_H */