wifi-mode.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2005,2006,2007 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
 *
 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 *          Sébastien Deronne <sebastien.deronne@gmail.com>
 */

#ifndef WIFI_MODE_H
#define WIFI_MODE_H

#include "wifi-phy-common.h"
#include "ns3/attribute-helper.h"
#include "ns3/callback.h"
#include <vector>

namespace ns3 {

#define SU_STA_ID 65535

class WifiTxVector;

class WifiMode
{
public:
  bool IsAllowed (uint16_t channelWidth, uint8_t nss) const;
  uint64_t GetPhyRate (uint16_t channelWidth, uint16_t guardInterval, uint8_t nss) const;
  uint64_t GetPhyRate (const WifiTxVector& txVector, uint16_t staId = SU_STA_ID) const;
  uint64_t GetPhyRate (uint16_t channelWidth) const;
  uint64_t GetDataRate (uint16_t channelWidth, uint16_t guardInterval, uint8_t nss) const;
  uint64_t GetDataRate (const WifiTxVector& txVector, uint16_t staId = SU_STA_ID) const;
  uint64_t GetDataRate (uint16_t channelWidth) const;

  WifiCodeRate GetCodeRate (void) const;
  uint16_t GetConstellationSize (void) const;
  uint8_t GetMcsValue (void) const;
  std::string GetUniqueName (void) const;
  bool IsMandatory (void) const;
  uint32_t GetUid (void) const;
  WifiModulationClass GetModulationClass () const;
  uint64_t GetNonHtReferenceRate (void) const;
  bool IsHigherCodeRate (WifiMode mode) const;
  bool IsHigherDataRate (WifiMode mode) const;

  WifiMode ();
  WifiMode (std::string name);


private:
  friend class WifiModeFactory;
  WifiMode (uint32_t uid);
  uint32_t m_uid; 
};

bool operator == (const WifiMode &a, const WifiMode &b);

bool operator != (const WifiMode &a, const WifiMode &b);

bool operator < (const WifiMode &a, const WifiMode &b);

std::ostream & operator << (std::ostream & os, const WifiMode &mode);
std::istream & operator >> (std::istream &is, WifiMode &mode);

ATTRIBUTE_HELPER_HEADER (WifiMode);

typedef std::vector<WifiMode> WifiModeList;
typedef WifiModeList::const_iterator WifiModeListIterator;

class WifiModeFactory
{
public:
  // Typedefs for callbacks used by WifiModeItem
  typedef Callback<WifiCodeRate> CodeRateCallback;
  typedef Callback<uint16_t> ConstellationSizeCallback;
  typedef Callback<uint64_t, uint16_t /* channelWidth */, uint16_t /* guardInterval */, uint8_t /* nss */> PhyRateCallback;
  typedef Callback<uint64_t, const WifiTxVector& /* txVector */, uint16_t /* staId */> PhyRateFromTxVectorCallback;
  typedef Callback<uint64_t, uint16_t /* channelWidth */, uint16_t /* guardInterval */, uint8_t /* nss */> DataRateCallback;
  typedef Callback<uint64_t, const WifiTxVector& /* txVector */, uint16_t /* staId */> DataRateFromTxVectorCallback;
  typedef Callback<uint64_t> NonHtReferenceRateCallback;
  typedef Callback<bool, uint16_t /* channelWidth */, uint8_t /* nss */> ModeAllowedCallback;

  static WifiMode CreateWifiMode (std::string uniqueName,
                                  WifiModulationClass modClass,
                                  bool isMandatory,
                                  CodeRateCallback codeRateCallback,
                                  ConstellationSizeCallback constellationSizeCallback,
                                  PhyRateCallback phyRateCallback,
                                  PhyRateFromTxVectorCallback phyRateFromTxVectorCallback,
                                  DataRateCallback dataRateCallback,
                                  DataRateFromTxVectorCallback dataRateFromTxVectorCallback,
                                  ModeAllowedCallback isModeAllowedCallback);

  static WifiMode CreateWifiMcs (std::string uniqueName,
                                 uint8_t mcsValue,
                                 WifiModulationClass modClass,
                                 CodeRateCallback codeRateCallback,
                                 ConstellationSizeCallback constellationSizeCallback,
                                 PhyRateCallback phyRateCallback,
                                 PhyRateFromTxVectorCallback phyRateFromTxVectorCallback,
                                 DataRateCallback dataRateCallback,
                                 DataRateFromTxVectorCallback dataRateFromTxVectorCallback,
                                 NonHtReferenceRateCallback nonHtReferenceRateCallback,
                                 ModeAllowedCallback isModeAllowedCallback);


private:
  friend class WifiMode;
  friend std::istream & operator >> (std::istream &is, WifiMode &mode);

  static WifiModeFactory* GetFactory ();
  WifiModeFactory ();

  struct WifiModeItem
  {
    std::string uniqueUid;        
    WifiModulationClass modClass; 
    bool isMandatory;             
    uint8_t mcsValue;             
    CodeRateCallback GetCodeRateCallback;                         
    ConstellationSizeCallback GetConstellationSizeCallback;       
    PhyRateCallback GetPhyRateCallback;                           
    PhyRateFromTxVectorCallback GetPhyRateFromTxVectorCallback;   
    DataRateCallback GetDataRateCallback;                         
    DataRateFromTxVectorCallback GetDataRateFromTxVectorCallback; 
    NonHtReferenceRateCallback GetNonHtReferenceRateCallback;     
    ModeAllowedCallback IsModeAllowedCallback;                    
  };

  WifiMode Search (std::string name) const;
  uint32_t AllocateUid (std::string uniqueUid);
  WifiModeItem* Get (uint32_t uid);

  typedef std::vector<WifiModeItem> WifiModeItemList;
  WifiModeItemList m_itemList; 
};

} //namespace ns3

#endif /* WIFI_MODE_H */