cf-parameter-set.h

Go to the documentation of this file.

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

#ifndef CF_PARAMETER_SET_H
#define CF_PARAMETER_SET_H

#include "ns3/wifi-information-element.h"

namespace ns3 {

class CfParameterSet : public WifiInformationElement
{
public:
  CfParameterSet ();

  // Implementations of pure virtual methods of WifiInformationElement
  WifiInformationElementId ElementId () const;
  uint8_t GetInformationFieldSize () const;
  void SerializeInformationField (Buffer::Iterator start) const;
  uint8_t DeserializeInformationField (Buffer::Iterator start, uint8_t length);
  /* This information element is a bit special in that it is only
     included if the STA is a QoS STA. To support this we
     override the Serialize and GetSerializedSize methods of
     WifiInformationElement. */
  Buffer::Iterator Serialize (Buffer::Iterator start) const;
  uint16_t GetSerializedSize () const;

  void SetPcfSupported (uint8_t pcfSupported);

  uint8_t GetCFPCount (void) const;
  uint8_t GetCFPPeriod (void) const;
  uint64_t GetCFPMaxDurationUs (void) const;
  uint64_t GetCFPDurRemainingUs (void) const;

  void SetCFPCount (uint8_t count);
  void SetCFPPeriod (uint8_t period);
  void SetCFPMaxDurationUs (uint64_t maxDuration);
  void SetCFPDurRemainingUs (uint64_t durRemaining);


private:
  uint8_t m_CFPCount;                 
  uint8_t m_CFPPeriod;                
  uint64_t m_CFPMaxDuration;          
  uint64_t m_CFPDurRemaining;         

  uint8_t m_pcfSupported;
};

std::ostream &operator << (std::ostream &os, const CfParameterSet &cfParameterSet);

} //namespace ns3

#endif /* CF_PARAMETER_SET_H */