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
 *
 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 * Author: Mirko Banchi <mk.banchi@gmail.com>
 */
#ifndef WIFI_HELPER_H
#define WIFI_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/wifi-phy-standard.h"
#include "ns3/trace-helper.h"

namespace ns3 {

class WifiPhy;
class WifiMac;
class WifiNetDevice;
class Node;

class WifiPhyHelper
{
public:
  virtual ~WifiPhyHelper ();

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

class WifiMacHelper
{
public:
  virtual ~WifiMacHelper ();
  virtual Ptr<WifiMac> Create (void) const = 0;
};

class WifiHelper
{
public:
  virtual ~WifiHelper ();

  WifiHelper ();

  static WifiHelper Default (void);

  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 ());
  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 (enum WifiPhyStandard standard);

  static void EnableLogComponents (void);

  int64_t AssignStreams (NetDeviceContainer c, int64_t stream);

protected:
  ObjectFactory m_stationManager;
  enum WifiPhyStandard m_standard;
};

} // namespace ns3

#endif /* WIFI_HELPER_H */