edca-parameter-set.h

Go to the documentation of this file.

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

#ifndef EDCA_PARAMETER_SET_H
#define EDCA_PARAMETER_SET_H

#include <stdint.h>
#include <ostream>
#include "ns3/buffer.h"
#include "ns3/wifi-information-element.h"

namespace ns3 {

class EdcaParameterSet : public WifiInformationElement
{
public:
  EdcaParameterSet ();
  void SetQosSupported (uint8_t qosSupported);
  
  void SetQosInfo (uint8_t qosInfo);
  void SetBeAifsn (uint8_t aifsn);
  void SetBeAcm (uint8_t acm);
  void SetBeAci (uint8_t aci);
  void SetBeCWmin (uint8_t cwMin);
  void SetBeCWmax (uint8_t cwMax);
  void SetBeTXOPLimit (uint16_t txop);
  void SetBkAifsn (uint8_t aifsn);
  void SetBkAcm (uint8_t acm);
  void SetBkAci (uint8_t aci);
  void SetBkCWmin (uint8_t cwMin);
  void SetBkCWmax (uint8_t cwMax);
  void SetBkTXOPLimit (uint16_t txop);
  void SetViAifsn (uint8_t aifsn);
  void SetViAcm (uint8_t acm);
  void SetViAci (uint8_t aci);
  void SetViCWmin (uint8_t cwMin);
  void SetViCWmax (uint8_t cwMax);
  void SetViTXOPLimit (uint16_t txop);
  void SetVoAifsn (uint8_t aifsn);
  void SetVoAcm (uint8_t acm);
  void SetVoAci (uint8_t aci);
  void SetVoCWmin (uint8_t cwMin);
  void SetVoCWmax (uint8_t cwMax);
  void SetVoTXOPLimit (uint16_t txop);
  
  /*
   * Return the QoS Info field in the EdcaParameterSet information element.
   *
   * \return the QoS Info field in the EdcaParameterSet information element
   */
  uint8_t GetQosInfo (void) const;
  /*
   * Return the AC_BE AIFSN field in the EdcaParameterSet information element.
   *
   * \return the AC_BE AIFSN field in the EdcaParameterSet information element
   */
  uint8_t GetBeAifsn (void) const;
  /*
   * Return the AC_BE ACM field in the EdcaParameterSet information element.
   *
   * \return the AC_BE ACM field in the EdcaParameterSet information element
   */
  uint8_t GetBeAcm (void) const;
  /*
   * Return the AC_BE ACI field in the EdcaParameterSet information element.
   *
   * \return the AC_BE ACI field in the EdcaParameterSet information element
   */
  uint8_t GetBeAci (void) const;
  /*
   * Return the AC_BE CWmin field in the EdcaParameterSet information element.
   *
   * \return the AC_BE CWmin field in the EdcaParameterSet information element
   */
  uint8_t GetBeCWmin (void) const;
  /*
   * Return the AC_BE CWmax field in the EdcaParameterSet information element.
   *
   * \return the AC_BE CWmax field in the EdcaParameterSet information element
   */
  uint8_t GetBeCWmax (void) const;
  /*
   * Return the AC_BE TXOP Limit field in the EdcaParameterSet information element.
   *
   * \return the AC_BE TXOP Limit field in the EdcaParameterSet information element
   */
  uint16_t GetBeTXOPLimit (void) const;
  /*
   * Return the AC_BK AIFSN field in the EdcaParameterSet information element.
   *
   * \return the AC_BK AIFSN field in the EdcaParameterSet information element
   */
  uint8_t GetBkAifsn (void) const;
  /*
   * Return the AC_BK ACM field in the EdcaParameterSet information element.
   *
   * \return the AC_BK ACM field in the EdcaParameterSet information element
   */
  uint8_t GetBkAcm (void) const;
  /*
   * Return the AC_BK ACI field in the EdcaParameterSet information element.
   *
   * \return the AC_BK ACI field in the EdcaParameterSet information element
   */
  uint8_t GetBkAci (void) const;
  /*
   * Return the AC_BK CWmin field in the EdcaParameterSet information element.
   *
   * \return the AC_BK CWmin field in the EdcaParameterSet information element
   */
  uint8_t GetBkCWmin (void) const;
  /*
   * Return the AC_BK CWmax field in the EdcaParameterSet information element.
   *
   * \return the AC_BK CWmax field in the EdcaParameterSet information element
   */
  uint8_t GetBkCWmax (void) const;
  /*
   * Return the AC_BK TXOP Limit field in the EdcaParameterSet information element.
   *
   * \return the AC_BK TXOP Limit field in the EdcaParameterSet information element
   */
  uint16_t GetBkTXOPLimit (void) const;
  /*
   * Return the AC_VI AIFSN field in the EdcaParameterSet information element.
   *
   * \return the AC_VI AIFSN field in the EdcaParameterSet information element
   */
  uint8_t GetViAifsn (void) const;
  /*
   * Return the AC_VI ACM field in the EdcaParameterSet information element.
   *
   * \return the AC_VI ACM field in the EdcaParameterSet information element
   */
  uint8_t GetViAcm (void) const;
  /*
   * Return the AC_VI ACI field in the EdcaParameterSet information element.
   *
   * \return the AC_VI ACI field in the EdcaParameterSet information element
   */
  uint8_t GetViAci (void) const;
  /*
   * Return the AC_VI CWmin field in the EdcaParameterSet information element.
   *
   * \return the AC_VI CWmin field in the EdcaParameterSet information element
   */
  uint8_t GetViCWmin (void) const;
  /*
   * Return the AC_VI CWmax field in the EdcaParameterSet information element.
   *
   * \return the AC_VI CWmax field in the EdcaParameterSet information element
   */
  uint8_t GetViCWmax (void) const;
  /*
   * Return the AC_VI TXOP Limit field in the EdcaParameterSet information element.
   *
   * \return the AC_VI TXOP Limit field in the EdcaParameterSet information element
   */
  uint16_t GetViTXOPLimit (void) const;
  /*
   * Return the AC_VO AIFSN field in the EdcaParameterSet information element.
   *
   * \return the AC_VO AIFSN field in the EdcaParameterSet information element
   */
  uint8_t GetVoAifsn (void) const;
  /*
   * Return the AC_VO ACM field in the EdcaParameterSet information element.
   *
   * \return the AC_VO ACM field in the EdcaParameterSet information element
   */
  uint8_t GetVoAcm (void) const;
  /*
   * Return the AC_VO ACI field in the EdcaParameterSet information element.
   *
   * \return the AC_VO ACI field in the EdcaParameterSet information element
   */
  uint8_t GetVoAci (void) const;
  /*
   * Return the AC_VO CWmin field in the EdcaParameterSet information element.
   *
   * \return the AC_VO CWmin field in the EdcaParameterSet information element
   */
  uint8_t GetVoCWmin (void) const;
  /*
   * Return the AC_VO CWmax field in the EdcaParameterSet information element.
   *
   * \return the AC_VO CWmax field in the EdcaParameterSet information element
   */
  uint8_t GetVoCWmax (void) const;
  /*
   * Return the AC_VO TXOP Limit field in the EdcaParameterSet information element.
   *
   * \return the AC_VO TXOP Limit field in the EdcaParameterSet information element
   */
  uint16_t GetVoTXOPLimit (void) const;
  
  WifiInformationElementId ElementId () const;
  uint8_t GetInformationFieldSize () const;
  void SerializeInformationField (Buffer::Iterator start) const;
  uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length);
    
  Buffer::Iterator Serialize (Buffer::Iterator start) const;
  uint16_t GetSerializedSize () const;

private:
  uint8_t m_qosInfo;
  uint8_t m_reserved;
  uint32_t m_acBE;
  uint32_t m_acBK;
  uint32_t m_acVI;
  uint32_t m_acVO;

  //This is used to decide whether this element should be added to the frame or not
  bool m_qosSupported;
};

std::ostream &operator << (std::ostream &os, const EdcaParameterSet &edcaParameterSet);
std::istream &operator >> (std::istream &is, EdcaParameterSet &edcaParameterSet);

ATTRIBUTE_HELPER_HEADER (EdcaParameterSet);

} //namespace ns3

#endif /* EDCA_PARAMETER_SET_H */