snr-to-block-error-rate-manager.cc

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 *  Copyright (c) 2007,2008, 2009 INRIA, UDcast
 *
 * 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: Mohamed Amine Ismail <amine.ismail@sophia.inria.fr>
 *                              <amine.ismail@udcast.com>
 */

#include <cstring>
#include "ns3/snr-to-block-error-rate-manager.h"
#include "ns3/snr-to-block-error-rate-record.h"
#include "default-traces.h"
#include "ns3/log.h"
#include "ns3/assert.h"
#include <fstream>

namespace ns3 {

NS_LOG_COMPONENT_DEFINE ("SNRToBlockErrorRateManager");

SNRToBlockErrorRateManager::SNRToBlockErrorRateManager (void)
{

  for (int i = 0; i < 7; i++)
    {
      m_recordModulation[i] = new std::vector<SNRToBlockErrorRateRecord*> ();
    }
  m_activateLoss = false;
  std::strcpy (m_traceFilePath,"DefaultTraces");
}

SNRToBlockErrorRateManager::~SNRToBlockErrorRateManager (void)
{
  ClearRecords ();
  for (int i = 0; i < 7; i++)
    {
      delete m_recordModulation[i];
    }
}

void
SNRToBlockErrorRateManager::ClearRecords (void)
{
  for (int i = 0; i < 7; i++)
    {

      for (std::vector<SNRToBlockErrorRateRecord*>::iterator iter = m_recordModulation[i]->begin (); iter
           != m_recordModulation[i]->end (); ++iter)
        {
          if (*iter)
            {
              delete (*iter);
              (*iter) = 0;
            }
        }
      m_recordModulation[i]->clear ();
    }
}

void
SNRToBlockErrorRateManager::ActivateLoss (bool loss)
{
  m_activateLoss = loss;
}

void
SNRToBlockErrorRateManager::LoadTraces (void)
{
  std::ifstream m_ifTraceFile;
  ClearRecords ();
  double snrValue, bitErrorRate, burstErrorRate, sigma2, I1, I2;

  for (int i = 0; i < 7; i++)
    {
      char traceFile[1024];
      sprintf (traceFile, "%s/modulation%d.txt", m_traceFilePath, i);

      m_ifTraceFile.open (traceFile, std::ifstream::in);
      if (m_ifTraceFile.good () == false)
        {
          NS_LOG_INFO ("Unable to load " << traceFile << "!! Loading default traces...");
          LoadDefaultTraces ();
          return;
        }
      while (m_ifTraceFile.good ())
        {
          m_ifTraceFile >> snrValue >> bitErrorRate >> burstErrorRate >> sigma2 >> I1 >> I2;
          SNRToBlockErrorRateRecord *record = new SNRToBlockErrorRateRecord (snrValue,
                                                                             bitErrorRate,
                                                                             burstErrorRate,
                                                                             sigma2,
                                                                             I1,
                                                                             I2);
          m_recordModulation[i]->push_back (record);

        }
      m_ifTraceFile.close ();
    }
  m_activateLoss = true;
}

void
SNRToBlockErrorRateManager::LoadDefaultTraces (void)
{
  double snrValue, bitErrorRate, burstErrorRate, sigma2, I1, I2;
  ClearRecords ();
  for (unsigned int j = 0; j < sizeof(modulation0[0]) / sizeof(double); j++)
    {
      snrValue = modulation0[0][j];
      bitErrorRate = modulation0[1][j];
      burstErrorRate = modulation0[2][j];
      sigma2 = modulation0[3][j];
      I1 = modulation0[4][j];
      I2 = modulation0[5][j];
      SNRToBlockErrorRateRecord *record = new SNRToBlockErrorRateRecord (snrValue,
                                                                         bitErrorRate,
                                                                         burstErrorRate,
                                                                         sigma2,
                                                                         I1,
                                                                         I2);
      m_recordModulation[0]->push_back (record);
    }
  for (unsigned int j = 0; j < sizeof(modulation1[0]) / sizeof(double); j++)
    {
      snrValue = modulation1[0][j];
      bitErrorRate = modulation1[1][j];
      burstErrorRate = modulation1[2][j];
      sigma2 = modulation1[3][j];
      I1 = modulation1[4][j];
      I2 = modulation1[5][j];
      SNRToBlockErrorRateRecord *record = new SNRToBlockErrorRateRecord (snrValue,
                                                                         bitErrorRate,
                                                                         burstErrorRate,
                                                                         sigma2,
                                                                         I1,
                                                                         I2);
      m_recordModulation[1]->push_back (record);
    }
  for (unsigned int j = 0; j < sizeof(modulation2[0]) / sizeof(double); j++)
    {
      snrValue = modulation2[0][j];
      bitErrorRate = modulation2[1][j];
      burstErrorRate = modulation2[2][j];
      sigma2 = modulation2[3][j];
      I1 = modulation2[4][j];
      I2 = modulation2[5][j];
      SNRToBlockErrorRateRecord *record = new SNRToBlockErrorRateRecord (snrValue,
                                                                         bitErrorRate,
                                                                         burstErrorRate,
                                                                         sigma2,
                                                                         I1,
                                                                         I2);
      m_recordModulation[2]->push_back (record);
    }
  for (unsigned int j = 0; j < sizeof(modulation3[0]) / sizeof(double); j++)
    {
      snrValue = modulation3[0][j];
      bitErrorRate = modulation3[1][j];
      burstErrorRate = modulation3[2][j];
      sigma2 = modulation3[3][j];
      I1 = modulation3[4][j];
      I2 = modulation3[5][j];
      SNRToBlockErrorRateRecord *record = new SNRToBlockErrorRateRecord (snrValue,
                                                                         bitErrorRate,
                                                                         burstErrorRate,
                                                                         sigma2,
                                                                         I1,
                                                                         I2);
      m_recordModulation[3]->push_back (record);
    }
  for (unsigned int j = 0; j < sizeof(modulation4[0]) / sizeof(double); j++)
    {
      snrValue = modulation4[0][j];
      bitErrorRate = modulation4[1][j];
      burstErrorRate = modulation4[2][j];
      sigma2 = modulation4[3][j];
      I1 = modulation4[4][j];
      I2 = modulation4[5][j];
      SNRToBlockErrorRateRecord *record = new SNRToBlockErrorRateRecord (snrValue,
                                                                         bitErrorRate,
                                                                         burstErrorRate,
                                                                         sigma2,
                                                                         I1,
                                                                         I2);
      m_recordModulation[4]->push_back (record);
    }
  for (unsigned int j = 0; j < sizeof(modulation5[0]) / sizeof(double); j++)
    {
      snrValue = modulation5[0][j];
      bitErrorRate = modulation5[1][j];
      burstErrorRate = modulation5[2][j];
      sigma2 = modulation5[3][j];
      I1 = modulation5[4][j];
      I2 = modulation5[5][j];
      SNRToBlockErrorRateRecord *record = new SNRToBlockErrorRateRecord (snrValue,
                                                                         bitErrorRate,
                                                                         burstErrorRate,
                                                                         sigma2,
                                                                         I1,
                                                                         I2);
      m_recordModulation[5]->push_back (record);
    }
  for (unsigned int j = 0; j < sizeof(modulation6[0]) / sizeof(double); j++)
    {
      snrValue = modulation6[0][j];
      bitErrorRate = modulation6[1][j];
      burstErrorRate = modulation6[2][j];
      sigma2 = modulation6[3][j];
      I1 = modulation6[4][j];
      I2 = modulation6[5][j];
      SNRToBlockErrorRateRecord *record = new SNRToBlockErrorRateRecord (snrValue,
                                                                         bitErrorRate,
                                                                         burstErrorRate,
                                                                         sigma2,
                                                                         I1,
                                                                         I2);
      m_recordModulation[6]->push_back (record);
    }
  m_activateLoss = true;
}

void
SNRToBlockErrorRateManager::ReLoadTraces (void)
{
  double snrValue, bitErrorRate, burstErrorRate, sigma2, I1, I2;

  ClearRecords ();

  std::ifstream m_ifTraceFile;

  for (int i = 0; i < 7; i++)
    {
      char traceFile[1024];
      sprintf (traceFile, "%s/Modulation%d.txt", m_traceFilePath, i);

      m_ifTraceFile.open (traceFile, std::ifstream::in);
      if (m_ifTraceFile.good () == false)
        {
          NS_LOG_INFO ("Unable to load " << traceFile << "!!Loading default traces...");
          LoadDefaultTraces ();
          return;
        }
      while (m_ifTraceFile.good ())
        {
          m_ifTraceFile >> snrValue >> bitErrorRate >> burstErrorRate >> sigma2 >> I1 >> I2;
          SNRToBlockErrorRateRecord *record = new SNRToBlockErrorRateRecord (snrValue,
                                                                             bitErrorRate,
                                                                             burstErrorRate,
                                                                             sigma2,
                                                                             I1,
                                                                             I2);

          m_recordModulation[i]->push_back (record);

        }
      m_ifTraceFile.close ();
    }
  m_activateLoss = true;
}

void
SNRToBlockErrorRateManager::SetTraceFilePath (char *traceFilePath)
{
  NS_ASSERT_MSG (std::strlen (traceFilePath) < TRACE_FILE_PATH_SIZE,
                 "char * traceFilePath too long");
  std::strcpy (m_traceFilePath, traceFilePath);
}

std::string
SNRToBlockErrorRateManager::GetTraceFilePath (void)
{
  return (std::string (m_traceFilePath));
}

double
SNRToBlockErrorRateManager::GetBlockErrorRate (double SNR, uint8_t modulation)
{

  if (m_activateLoss == false)
    {
      return 0;
    }

  std::vector<SNRToBlockErrorRateRecord *> *record = 0;

  record = m_recordModulation[modulation];

  if (SNR <= (record->at (0)->GetSNRValue ()))
    {
      return 1;
    }
  if (SNR >= (record->at (record->size () - 1)->GetSNRValue ()))
    {
      return 0;
    }

  std::vector<SNRToBlockErrorRateRecord*>::const_iterator iter;
  unsigned int i;
  for (i = 0; i < record->size (); i++)
    {
      if (SNR < record->at (i)->GetSNRValue ())
        {
          break;
        }
    }
  double intervalSize = (record->at (i)->GetSNRValue () - record->at (i - 1)->GetSNRValue ());
  double coeff1 = (SNR - record->at (i - 1)->GetSNRValue ()) / intervalSize;
  double coeff2 = -1 * (SNR - record->at (i)->GetSNRValue ()) / intervalSize;
  double BlockErrorRate = coeff2 * (record->at (i - 1)->GetBlockErrorRate ()) + coeff1 * (record->at (i)->GetBlockErrorRate ());
  return BlockErrorRate;
}

SNRToBlockErrorRateRecord *
SNRToBlockErrorRateManager::GetSNRToBlockErrorRateRecord (double SNR,
                                                          uint8_t modulation)
{

  if (m_activateLoss == false)
    {
      return new SNRToBlockErrorRateRecord (SNR, 0, 0, 0, 0, 0);
    }

  std::vector<SNRToBlockErrorRateRecord *> *record = 0;
  record = m_recordModulation[modulation];

  if (SNR <= (record->at (0)->GetSNRValue ()))
    {
      return
        record->at (0)->Copy ();
    }
  if (SNR >= (record->at (record->size () - 1)->GetSNRValue ()))
    {
      return
        record->at (record->size () - 1)->Copy ();
    }

  std::vector<SNRToBlockErrorRateRecord*>::const_iterator iter;
  unsigned int i;
  for (i = 0; i < record->size (); i++)
    {
      if (SNR < record->at (i)->GetSNRValue ())
        {
          break;
        }
    }
  double intervalSize = (record->at (i)->GetSNRValue ()
                         - record->at (i - 1)->GetSNRValue ());
  double coeff1 = (SNR - record->at (i - 1)->GetSNRValue ()) / intervalSize;
  double coeff2 = -1 * (SNR - record->at (i)->GetSNRValue ()) / intervalSize;
  double BER = coeff2 * (record->at (i - 1)->GetBitErrorRate ()) + coeff1 * (record->at (i)->GetBitErrorRate ());
  double BlcER = coeff2 * (record->at (i - 1)->GetBlockErrorRate ()) + coeff1 * (record->at (i)->GetBlockErrorRate ());
  double sigma2 = coeff2 * (record->at (i - 1)->GetSigma2 ()) + coeff1 * (record->at (i)->GetSigma2 ());
  double I1 = coeff2 * (record->at (i - 1)->GetI1 ()) + coeff1 * (record->at (i)->GetI1 ());
  double I2 = coeff2 * (record->at (i - 1)->GetI2 ()) + coeff1 * (record->at (i)->GetI2 ());

  SNRToBlockErrorRateRecord * SNRToBlockErrorRate = new SNRToBlockErrorRateRecord (SNR, BER, BlcER, sigma2, I1,I2);
  return SNRToBlockErrorRate;
}

}