wifi-tx-vector.h

Go to the documentation of this file.

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2010 CTTC
 *
 * 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: Nicola Baldo <nbaldo@cttc.es>
 *          Ghada Badawy <gbadawy@gmail.com>
 */

#ifndef WIFI_TX_VECTOR_H
#define WIFI_TX_VECTOR_H

#include <list>
#include "wifi-mode.h"
#include "wifi-phy-common.h"
#include "ns3/he-ru.h"

namespace ns3 {

struct HeMuUserInfo
{
  HeRu::RuSpec ru; 
  WifiMode mcs;    
  uint8_t nss;     
};

class WifiTxVector
{
public:
  typedef std::map <uint16_t /* staId */, HeMuUserInfo /* HE MU specific user info */> HeMuUserInfoMap;

  WifiTxVector ();
  ~WifiTxVector ();
  WifiTxVector (WifiMode mode,
                uint8_t powerLevel,
                WifiPreamble preamble,
                uint16_t guardInterval,
                uint8_t nTx,
                uint8_t nss,
                uint8_t ness,
                uint16_t channelWidth,
                bool aggregation,
                bool stbc = false,
                bool ldpc = false,
                uint8_t bssColor = 0,
                uint16_t length = 0);
  WifiTxVector (const WifiTxVector& txVector);

  bool GetModeInitialized (void) const;
  WifiMode GetMode (uint16_t staId = SU_STA_ID) const;
  void SetMode (WifiMode mode);
  void SetMode (WifiMode mode, uint16_t staId);

  WifiModulationClass GetModulationClass (void) const;

  uint8_t GetTxPowerLevel (void) const;
  void SetTxPowerLevel (uint8_t powerlevel);
  WifiPreamble GetPreambleType (void) const;
  void SetPreambleType (WifiPreamble preamble);
  uint16_t GetChannelWidth (void) const;
  void SetChannelWidth (uint16_t channelWidth);
  uint16_t GetGuardInterval (void) const;
  void SetGuardInterval (uint16_t guardInterval);
  uint8_t GetNTx (void) const;
  void SetNTx (uint8_t nTx);
  uint8_t GetNss (uint16_t staId = SU_STA_ID) const;
  uint8_t GetNssMax (void) const;
  void SetNss (uint8_t nss);
  void SetNss (uint8_t nss, uint16_t staId);
  uint8_t GetNess (void) const;
  void SetNess (uint8_t ness);
  bool IsAggregation (void) const;
  void SetAggregation (bool aggregation);
  bool IsStbc (void) const;
  void SetStbc (bool stbc);
  bool IsLdpc (void) const;
  void SetLdpc (bool ldpc);
  void SetBssColor (uint8_t color);
  uint8_t GetBssColor (void) const;
  void SetLength (uint16_t length);
  uint16_t GetLength (void) const;
  bool IsValid (void) const;
  bool IsMu (void) const;
  bool IsDlMu (void) const;
  bool IsUlMu (void) const;
   HeRu::RuSpec GetRu (uint16_t staId) const;
   void SetRu (HeRu::RuSpec ru, uint16_t staId);
   HeMuUserInfo GetHeMuUserInfo (uint16_t staId) const;
   void SetHeMuUserInfo (uint16_t staId, HeMuUserInfo userInfo);
   const HeMuUserInfoMap& GetHeMuUserInfoMap (void) const;
   HeMuUserInfoMap& GetHeMuUserInfoMap (void);
   std::pair<std::size_t, std::size_t> GetNumRusPerHeSigBContentChannel (void) const;


private:
  WifiMode m_mode;               
  uint8_t  m_txPowerLevel;       
  WifiPreamble m_preamble;       
  uint16_t m_channelWidth;       
  uint16_t m_guardInterval;      
  uint8_t  m_nTx;                
  uint8_t  m_nss;                
  uint8_t  m_ness;               
  bool     m_aggregation;        
  bool     m_stbc;               
  bool     m_ldpc;               
  uint8_t  m_bssColor;           
  uint16_t m_length;             
  bool     m_modeInitialized;         
  //MU information
  HeMuUserInfoMap m_muUserInfos; 
};

std::ostream & operator << (std::ostream & os,const WifiTxVector &v);

} //namespace ns3

#endif /* WIFI_TX_VECTOR_H */