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

/*

 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)

 *

 * 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: Marco Miozzo <marco.miozzo@cttc.es>

 */

#include "ns3/simulator.h"

#include "ns3/log.h"

#include "ns3/spectrum-test.h"

#include "ns3/lte-phy-tag.h"

#include "ns3/lte-test-ue-phy.h"

#include "ns3/lte-sinr-chunk-processor.h"

#include "ns3/lte-test-pathloss-model.h"

NS_LOG_COMPONENT_DEFINE ("LtePathlossModelTest");

using namespace ns3;

/**

 * Test 1.1 SINR calculation in downlink

 */

/**

 * TestSuite

 */

LtePathlossModelTestSuite::LtePathlossModelTestSuite ()

  : TestSuite ("lte-pathloss-model", SYSTEM)

{

  // LogLevel logLevel = (LogLevel)(LOG_PREFIX_FUNC | LOG_PREFIX_TIME | LOG_LEVEL_ALL);

  // LogComponentEnable ("LteTestUePhy", logLevel);

  // LogComponentEnable ("LteDownlinkSinrTest", logLevel);

  // NS_LOG_INFO ("Creating LteDownlinkSinrTestSuite");

  /**

   * Build Spectrum Model values for the TX signal

   */

  Ptr<SpectrumModel> sm;

  Bands bands;

  BandInfo bi;

  bi.fl = 2.400e9;

  bi.fc = 2.410e9;

  bi.fh = 2.420e9;

  bands.push_back (bi);

  bi.fl = 2.420e9;

  bi.fc = 2.431e9;

  bi.fh = 2.442e9;

  bands.push_back (bi);

  sm = Create<SpectrumModel> (bands);

  /**

   * TX signal #1: Power Spectral Density (W/Hz) of the signal of interest = [-46 -48] dBm and BW = [20 22] MHz

   */

  Ptr<SpectrumValue> rxPsd1 = Create<SpectrumValue> (sm);

  (*rxPsd1)[0] = 1.255943215755e-15;

  (*rxPsd1)[1] = 7.204059965732e-16;

  Ptr<SpectrumValue> theoreticalSinr1 = Create<SpectrumValue> (sm);

  (*theoreticalSinr1)[0] = 3.72589167251055;

  (*theoreticalSinr1)[1] = 3.72255684126076;

  AddTestCase (new LtePathlossModelTestCase (rxPsd1, theoreticalSinr1, "sdBm = [-46 -48]"));

  /**

   * TX signal #2: Power Spectral Density (W/Hz) of the signal of interest = [-63 -61] dBm and BW = [20 22] MHz

   */

  Ptr<SpectrumValue> rxPsd2 = Create<SpectrumValue> (sm);

  (*rxPsd2)[0] = 2.505936168136e-17;

  (*rxPsd2)[1] = 3.610582885110e-17;

  Ptr<SpectrumValue> theoreticalSinr2 = Create<SpectrumValue> (sm);

  (*theoreticalSinr2)[0] = 0.0743413124381667;

  (*theoreticalSinr2)[1] = 0.1865697965291756;

  AddTestCase (new LtePathlossModelTestCase (rxPsd2, theoreticalSinr2, "sdBm = [-63 -61]"));

}

static LtePathlossModelTestSuite ltePathlossModelTestSuite;

/**

 * TestCase

 */

LtePathlossModelTestCase::LtePathlossModelTestCase (Ptr<SpectrumValue> sv, Ptr<SpectrumValue> sinr, std::string name)

  : TestCase ("SINR calculation in downlink: " + name),

    m_sv (sv),

    m_sm (sv->GetSpectrumModel ()),

    m_sinr (sinr)

{

  NS_LOG_INFO ("Creating LtePathlossModelTestCase");

}

LtePathlossModelTestCase::~LtePathlossModelTestCase ()

{

}

void

LtePathlossModelTestCase::DoRun (void)

{

  LogLevel logLevel = (LogLevel)(LOG_PREFIX_FUNC | LOG_PREFIX_TIME | LOG_LEVEL_ALL);

  LogComponentEnable ("LteEnbRrc", logLevel);

  LogComponentEnable ("LteUeRrc", logLevel);

  LogComponentEnable ("LteEnbMac", logLevel);

  LogComponentEnable ("LteUeMac", logLevel);

  LogComponentEnable ("LteRlc", logLevel);

  LogComponentEnable ("RrPacketScheduler", logLevel);

  LogComponentEnable ("LtePhy", logLevel);

  LogComponentEnable ("LteEnbPhy", logLevel);

  LogComponentEnable ("LteUePhy", logLevel);

  LogComponentEnable ("LteSpectrumPhy", logLevel);

  LogComponentEnable ("LteInterference", logLevel);

  LogComponentEnable ("LteSinrChunkProcessor", logLevel);

  LogComponentEnable ("LtePropagationLossModel", logLevel);

  LogComponentEnable ("LossModel", logLevel);

  LogComponentEnable ("ShadowingLossModel", logLevel);

  LogComponentEnable ("PenetrationLossModel", logLevel);

  LogComponentEnable ("MultipathLossModel", logLevel);

  LogComponentEnable ("PathLossModel", logLevel);

  LogComponentEnable ("LteNetDevice", logLevel);

  LogComponentEnable ("LteUeNetDevice", logLevel);

  LogComponentEnable ("LteEnbNetDevice", logLevel);

  /**

   * Instantiate a single receiving LteSpectrumPhy

   */

  Ptr<LteSpectrumPhy> dlPhy = CreateObject<LteSpectrumPhy> ();

  Ptr<LteSpectrumPhy> ulPhy = CreateObject<LteSpectrumPhy> ();

  Ptr<LteTestUePhy> uePhy = CreateObject<LteTestUePhy> (dlPhy, ulPhy);

  dlPhy->SetCellId (100);

  Ptr<LteCqiSinrChunkProcessor> chunkProcessor = Create<LteCqiSinrChunkProcessor> (uePhy->GetObject<LtePhy> ());

  dlPhy->AddSinrChunkProcessor (chunkProcessor);

  /**

   * Generate several calls to LteSpectrumPhy::StartRx corresponding to several signals.

   * One will be the signal of interest, i.e., the PhyTag of the first Packet in the Packet burst

   * will have the same CellId of the receiving PHY;

   * the others will have a different CellId and hence will be the interfering signals

   */

  // Number of packet bursts (1 data + 4 interferences)

  int numOfPbs = 5;

  // Number of packets in the packet bursts

  int numOfPkts = 10;

  // Packet bursts

  Ptr<PacketBurst> packetBursts[numOfPbs];

  // Packets

  Ptr<Packet> pkt[numOfPbs][numOfPkts];

  // Phy tags

  LtePhyTag pktTag[numOfPbs];

  /**

   * Build packet burst

   */

  for ( int pb = 0 ; pb < numOfPbs ; pb++ )

    {

      // Create packet burst

      packetBursts[pb] = CreateObject<PacketBurst> ();

      // Create packets and add them to the burst

      for ( int i = 0 ; i < numOfPkts ; i++ )

        {

          pkt[pb][i] = Create<Packet> (1000);

          if ( i == 0 )

            {

              // Create phy tag (different for each packet burst)

              // and add to the first packet

              pktTag[pb] = LtePhyTag (100 * (pb + 1));

              pkt[pb][i]->AddPacketTag ( pktTag[pb] );

            }

          packetBursts[pb]->AddPacket ( pkt[pb][i] );

        }

    }

  Ptr<SpectrumValue> noisePsd = Create<SpectrumValue> (m_sm);

  Ptr<SpectrumValue> i1 = Create<SpectrumValue> (m_sm);

  Ptr<SpectrumValue> i2 = Create<SpectrumValue> (m_sm);

  Ptr<SpectrumValue> i3 = Create<SpectrumValue> (m_sm);

  Ptr<SpectrumValue> i4 = Create<SpectrumValue> (m_sm);

  (*noisePsd)[0] = 5.000000000000e-19;

  (*noisePsd)[1] = 4.545454545455e-19;

  (*i1)[0] = 5.000000000000e-18;

  (*i2)[0] = 5.000000000000e-16;

  (*i3)[0] = 1.581138830084e-16;

  (*i4)[0] = 7.924465962306e-17;

  (*i1)[1] = 1.437398936440e-18;

  (*i2)[1] = 5.722388235428e-16;

  (*i3)[1] = 7.204059965732e-17;

  (*i4)[1] = 5.722388235428e-17;

  Time ts  = Seconds (1);

  Time ds  = Seconds (1);

  Time ti1 = Seconds (0);

  Time di1 = Seconds (3);

  Time ti2 = Seconds (0.7);

  Time di2 = Seconds (1);

  Time ti3 = Seconds (1.2);

  Time di3 = Seconds (1);

  Time ti4 = Seconds (1.5);

  Time di4 = Seconds (0.1);

  dlPhy->SetNoisePowerSpectralDensity (noisePsd);

  /**

   * Schedule the reception of the data signal plus the interference signals

   */

  // eNB sends data to 2 UEs through 2 subcarriers

  Simulator::Schedule (ts, &LteSpectrumPhy::StartRx, dlPhy, packetBursts[0], m_sv, dlPhy->GetSpectrumType (), ds);

  Simulator::Schedule (ti1, &LteSpectrumPhy::StartRx, dlPhy, packetBursts[1], i1, dlPhy->GetSpectrumType (), di1);

  Simulator::Schedule (ti2, &LteSpectrumPhy::StartRx, dlPhy, packetBursts[2], i2, dlPhy->GetSpectrumType (), di2);

  Simulator::Schedule (ti3, &LteSpectrumPhy::StartRx, dlPhy, packetBursts[3], i3, dlPhy->GetSpectrumType (), di3);

  Simulator::Schedule (ti4, &LteSpectrumPhy::StartRx, dlPhy, packetBursts[4], i4, dlPhy->GetSpectrumType (), di4);

  Simulator::Stop (Seconds (5.0));

  Simulator::Run ();

  Simulator::Destroy ();

  /**

   * Check that the values passed to LteSinrChunkProcessor::EvaluateSinrChunk () correspond

   * to known values which have been calculated offline (with octave) for the generated signals

   */

  SpectrumValue calculatedSinr = uePhy->GetSinr ();

  NS_LOG_INFO ("Theoretical SINR: " << *m_sinr);

  NS_LOG_INFO ("Calculated SINR: " << calculatedSinr);

  NS_TEST_ASSERT_MSG_SPECTRUM_VALUE_EQ_TOL(calculatedSinr, *m_sinr, 0.0000001, "Wrong SINR !");

}