wifi-phy-operating-channel.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2021
 *
 * 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: Stefano Avallone <stavallo@unina.it>
 *          Sébastien Deronne <sebastien.deronne@gmail.com>
 */

#ifndef WIFI_PHY_OPERATING_CHANNEL_H
#define WIFI_PHY_OPERATING_CHANNEL_H

#include "wifi-phy-band.h"
#include "wifi-standards.h"
#include <tuple>
#include <set>

namespace ns3 {

typedef std::tuple<uint8_t, uint16_t, uint16_t, FrequencyChannelType, WifiPhyBand> FrequencyChannelInfo;


class WifiPhyOperatingChannel
{
public:
  WifiPhyOperatingChannel ();

  virtual ~WifiPhyOperatingChannel ();

  bool IsSet (void) const;
  void Set (uint8_t number, uint16_t frequency, uint16_t width,
            WifiPhyStandard standard, WifiPhyBand band);
  void SetDefault (uint16_t width, WifiPhyStandard standard, WifiPhyBand band);

  uint8_t GetNumber (void) const;
  uint16_t GetFrequency (void) const;
  uint16_t GetWidth (void) const;

  uint8_t GetPrimaryChannelIndex (uint16_t primaryChannelWidth) const;
  void SetPrimary20Index (uint8_t index);
  uint16_t GetPrimaryChannelCenterFrequency (uint16_t primaryChannelWidth) const;

private:
  typedef std::set<FrequencyChannelInfo>::const_iterator ConstIterator;

  ConstIterator FindFirst (uint8_t number, uint16_t frequency, uint16_t width,
                           WifiPhyStandard standard, WifiPhyBand band,
                           ConstIterator start) const;

  ConstIterator m_channelIt;   
  uint8_t m_primary20Index;    
};

} //namespace ns3

#endif /* WIFI_PHY_OPERATING_CHANNEL_H */