/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2010 The Boeing Company

 *

 * 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: Gary Pei <guangyu.pei@boeing.com>

 */

#ifndef NIST_ERROR_RATE_MODEL_H

#define NIST_ERROR_RATE_MODEL_H

#include <stdint.h>

#include "wifi-mode.h"

#include "error-rate-model.h"

#include "dsss-error-rate-model.h"

namespace ns3 {

/**

 * \ingroup wifi

 *

 * A model for the error rate for different modulations.  For OFDM modulation,

 * the model description and validation can be found in

 * http://www.nsnam.org/~pei/80211ofdm.pdf.  For DSSS modulations (802.11b),

 * the model uses the DsssErrorRateModel.

 */

class NistErrorRateModel : public ErrorRateModel

{

public:

  static TypeId GetTypeId (void);

  NistErrorRateModel ();

  virtual double GetChunkSuccessRate (WifiMode mode, double snr, uint32_t nbits) const;

private:

  double CalculatePe (double p, uint32_t bValue) const;

  /**

   * Return BER of BPSK at the given SNR.

   *

   * \param snr snr value

   * \return BER of BPSK at the given SNR

   */

  double GetBpskBer (double snr) const;

  /**

   * Return BER of QPSK at the given SNR.

   *

   * \param snr snr value

   * \return BER of QPSK at the given SNR

   */

  double GetQpskBer (double snr) const;

  /**

   * Return BER of QAM16 at the given SNR.

   *

   * \param snr snr value

   * \return BER of QAM16 at the given SNR

   */

  double Get16QamBer (double snr) const;

  /**

   * Return BER of QAM64 at the given SNR.

   *

   * \param snr snr value

   * \return BER of QAM64 at the given SNR

   */

  double Get64QamBer (double snr) const;

  /**

   * Return BER of BPSK at the given SNR after applying FEC.

   *

   * \param snr snr value

   * \param nbits the number of bits in the chunk

   * \param bValue

   * \return BER of BPSK at the given SNR after applying FEC

   */

  double GetFecBpskBer (double snr, double nbits,

                        uint32_t bValue) const;

  /**

   * Return BER of QPSK at the given SNR after applying FEC.

   *

   * \param snr snr value

   * \param nbits the number of bits in the chunk

   * \param bValue

   * \return BER of QPSK at the given SNR after applying FEC

   */

  double GetFecQpskBer (double snr, double nbits,

                        uint32_t bValue) const;

  /**

   * Return BER of QAM16 at the given SNR after applying FEC.

   *

   * \param snr snr value

   * \param nbits the number of bits in the chunk

   * \param bValue

   * \return BER of QAM16 at the given SNR after applying FEC

   */

  double GetFec16QamBer (double snr, uint32_t nbits,

                         uint32_t bValue) const;

  /**

   * Return BER of QAM64 at the given SNR after applying FEC.

   *

   * \param snr snr value

   * \param nbits the number of bits in the chunk

   * \param bValue

   * \return BER of QAM64 at the given SNR after applying FEC

   */

  double GetFec64QamBer (double snr, uint32_t nbits,

                         uint32_t bValue) const;

};

} // namespace ns3

#endif /* NIST_ERROR_RATE_MODEL_H */