satellite-loo-model.cc

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd.
 *
 * 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: Frans Laakso <frans.laakso@magister.fi>
 */
 
#include "satellite-loo-model.h"
 
#include "satellite-utils.h"
 
#include "ns3/log.h"
 
#include <cmath>
#include <complex>
#include <vector>
 
NS_LOG_COMPONENT_DEFINE("SatLooModel");
 
namespace ns3
{
 
NS_OBJECT_ENSURE_REGISTERED(SatLooModel);
 
TypeId
SatLooModel::GetTypeId(void)
{
    static TypeId tid =
        TypeId("ns3::SatLooModel").SetParent<SatBaseFader>().AddConstructor<SatLooModel>();
    return tid;
}
 
SatLooModel::SatLooModel()
    : m_numOfStates(0),
      m_currentSet(0),
      m_currentState(0),
      m_looConf(nullptr),
      m_normalRandomVariable(nullptr),
      m_uniformVariable(nullptr)
{
    NS_LOG_FUNCTION(this);
 
    NS_FATAL_ERROR("SatLooModel::SatLooModel - Constructor not in use");
}
 
SatLooModel::SatLooModel(Ptr<SatLooConf> looConf,
                         uint32_t numOfStates,
                         uint32_t initialSet,
                         uint32_t initialState)
    : m_numOfStates(numOfStates),
      m_currentSet(initialSet),
      m_currentState(initialState),
      m_looConf(looConf),
      m_normalRandomVariable(nullptr),
      m_uniformVariable(nullptr)
{
    NS_LOG_FUNCTION(this << numOfStates << " " << initialSet << " " << initialState);

    m_normalRandomVariable = CreateObject<NormalRandomVariable>();
    m_uniformVariable = CreateObject<UniformRandomVariable>();
    m_uniformVariable->SetAttribute("Min", DoubleValue(-1.0 * M_PI));
    m_uniformVariable->SetAttribute("Max", DoubleValue(M_PI));

    ChangeSet(m_currentSet, m_currentState);
}
 
SatLooModel::~SatLooModel()
{
    NS_LOG_FUNCTION(this);
 
    Reset();
}
 
void
SatLooModel::DoDispose()
{
    NS_LOG_FUNCTION(this);
 
    Reset();
    SatBaseFader::DoDispose();
}
 
void
SatLooModel::Reset()
{
    NS_LOG_FUNCTION(this);
 
    m_looConf = nullptr;
    m_normalRandomVariable = nullptr;
    m_uniformVariable = nullptr;
 
    if (!m_directSignalOscillators.empty())
    {
        for (uint32_t i = 0; i < m_numOfStates; i++)
        {
            if (!m_directSignalOscillators[i].empty())
            {
                m_directSignalOscillators[i].clear();
            }
        }
        m_directSignalOscillators.clear();
    }
 
    if (!m_multipathOscillators.empty())
    {
        for (uint32_t i = 0; i < m_numOfStates; i++)
        {
            if (!m_multipathOscillators[i].empty())
            {
                m_multipathOscillators[i].clear();
            }
        }
        m_multipathOscillators.clear();
    }
 
    m_looParameters.clear();
    m_sigma.clear();
}
 
void
SatLooModel::ConstructDirectSignalOscillators()
{
    NS_LOG_FUNCTION(this);
 
    for (uint32_t i = 0; i < m_numOfStates; i++)
    {
        std::vector<Ptr<SatFadingOscillator>> oscillators;

        double phi = m_uniformVariable->GetValue();
        double theta = m_uniformVariable->GetValue();
        for (uint32_t j = 0; j < m_looParameters[i][3]; j++)
        {
            uint32_t n = j + 1;
            double alpha = (2.0 * M_PI * n - M_PI + theta) / (4.0 * m_looParameters[i][3]);
            double omega = 2.0 * M_PI * m_looParameters[i][5] * std::cos(alpha);

            double amplitude =
                m_normalRandomVariable->GetValue(m_looParameters[i][0], m_looParameters[i][1]);
            amplitude = pow(10, amplitude / 10) / m_looParameters[i][3];

            oscillators.push_back(CreateObject<SatFadingOscillator>(amplitude, phi, omega));
        }
        m_directSignalOscillators.push_back(oscillators);
    }
}
 
void
SatLooModel::ConstructMultipathOscillators()
{
    NS_LOG_FUNCTION(this);
 
    for (uint32_t i = 0; i < m_numOfStates; i++)
    {
        std::vector<Ptr<SatFadingOscillator>> oscillators;

        double phi = m_uniformVariable->GetValue();
        double theta = m_uniformVariable->GetValue();
        for (uint32_t j = 0; j < m_looParameters[i][4]; j++)
        {
            uint32_t n = j + 1;
            double alpha = (2.0 * M_PI * n - M_PI + theta) / (4.0 * m_looParameters[i][4]);
            double omega = 2.0 * M_PI * m_looParameters[i][6] * std::cos(alpha);
            double psi = m_normalRandomVariable->GetValue();
            std::complex<double> amplitude = std::complex<double>(std::cos(psi), std::sin(psi)) *
                                             2.0 / std::sqrt(m_looParameters[i][4]);
            oscillators.push_back(CreateObject<SatFadingOscillator>(amplitude, phi, omega));
        }
        m_multipathOscillators.push_back(oscillators);
    }
}
 
double
SatLooModel::GetChannelGainDb()
{
    NS_LOG_FUNCTION(this);
 
    double tempChannelGainDb = 10.0 * std::log10(GetChannelGain());
    NS_LOG_INFO("Channel gain: " << tempChannelGainDb);
    return tempChannelGainDb;
}
 
double
SatLooModel::GetChannelGain()
{
    NS_LOG_FUNCTION(this);
 
    double timeInSeconds = Now().GetSeconds();

    std::complex<double> directComplexGain =
        GetOscillatorCosineWaveSum(m_directSignalOscillators[m_currentState], timeInSeconds);

    std::complex<double> multipathComplexGain =
        GetOscillatorComplexSum(m_multipathOscillators[m_currentState], timeInSeconds);
    multipathComplexGain = multipathComplexGain * m_sigma[m_currentState];

    std::complex<double> fadingGain = directComplexGain + multipathComplexGain;
    return sqrt((pow(fadingGain.real(), 2) + pow(fadingGain.imag(), 2)));
}
 
std::complex<double>
SatLooModel::GetOscillatorCosineWaveSum(std::vector<Ptr<SatFadingOscillator>> oscillator,
                                        double timeInSeconds)
{
    NS_LOG_FUNCTION(this);
 
    std::complex<double> complexSum = std::complex<double>(0, 0);
 
    for (uint32_t i = 0; i < oscillator.size(); i++)
    {
        complexSum += oscillator[i]->GetCosineWaveValueAt(timeInSeconds);
    }
 
    return complexSum;
}
 
std::complex<double>
SatLooModel::GetOscillatorComplexSum(std::vector<Ptr<SatFadingOscillator>> oscillator,
                                     double timeInSeconds)
{
    NS_LOG_FUNCTION(this);
 
    std::complex<double> complexSum = std::complex<double>(0, 0);
 
    for (uint32_t i = 0; i < oscillator.size(); i++)
    {
        complexSum += oscillator[i]->GetComplexValueAt(timeInSeconds);
    }
 
    return complexSum;
}
 
void
SatLooModel::UpdateParameters(uint32_t newSet, uint32_t newState)
{
    NS_LOG_FUNCTION(this << newSet << " " << newState);
 
    if (m_currentSet != newSet)
    {
        ChangeSet(newSet, newState);
    }
 
    if (m_currentSet == newSet && m_currentState != newState)
    {
        ChangeState(newState);
    }
}
 
void
SatLooModel::ChangeSet(uint32_t newSet, uint32_t newState)
{
    NS_LOG_FUNCTION(this << newSet << " " << newState);
 
    m_looParameters.clear();
    m_looParameters = m_looConf->GetParameters(newSet);
    m_currentSet = newSet;
 
    ChangeState(newState);
 
    if (!m_directSignalOscillators.empty())
    {
        for (uint32_t i = 0; i < m_numOfStates; i++)
        {
            if (!m_directSignalOscillators[i].empty())
            {
                m_directSignalOscillators[i].clear();
            }
        }
        m_directSignalOscillators.clear();
    }
 
    if (!m_multipathOscillators.empty())
    {
        for (uint32_t i = 0; i < m_numOfStates; i++)
        {
            if (!m_multipathOscillators[i].empty())
            {
                m_multipathOscillators[i].clear();
            }
        }
        m_multipathOscillators.clear();
    }
 
    m_sigma.clear();
 
    ConstructDirectSignalOscillators();
    ConstructMultipathOscillators();
    CalculateSigma();
}
 
void
SatLooModel::ChangeState(uint32_t newState)
{
    NS_LOG_FUNCTION(this << newState);
 
    m_currentState = newState;
}
 
void
SatLooModel::CalculateSigma()
{
    NS_LOG_FUNCTION(this);
 
    for (uint32_t i = 0; i < m_numOfStates; i++)
    {
        m_sigma.push_back(sqrt(0.5 * pow(10, (m_looParameters[i][2] / 10))));
    }
}
 
} // namespace ns3