satellite-link-results.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions
 *
 * 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: Budiarto Herman <budiarto.herman@magister.fi>
 *
 */
 
#ifndef SATELLITE_LINK_RESULTS_H
#define SATELLITE_LINK_RESULTS_H
 
#include "satellite-enums.h"
#include "satellite-look-up-table.h"
#include "satellite-mutual-information-table.h"
 
#include "ns3/object.h"
#include "ns3/ptr.h"
 
#include <map>
#include <stdint.h>
#include <string>
 
namespace ns3
{

class SatLinkResults : public Object
{
  public:
    SatLinkResults();

    static TypeId GetTypeId();

    void Initialize();
 
  protected:
    virtual void DoInitialize() = 0;

    std::string m_inputPath;

    bool m_isInitialized;
};

class SatLinkResultsRtn : public SatLinkResults
{
  public:
    SatLinkResultsRtn();
 
    ~SatLinkResultsRtn()
    {
    }

    static TypeId GetTypeId();

    double GetBler(uint32_t waveformId, double ebNoDb) const;

    double GetEbNoDb(uint32_t waveformId, double blerTarget) const;
 
  protected:
    virtual void DoInitialize() = 0;

    std::map<uint32_t, Ptr<SatLookUpTable>> m_table;
};

class SatLinkResultsDvbRcs2 : public SatLinkResultsRtn
{
  public:
    SatLinkResultsDvbRcs2();
 
    ~SatLinkResultsDvbRcs2()
    {
    }

    static TypeId GetTypeId();
 
  protected:
    virtual void DoInitialize();
};

class SatLinkResultsFSim : public SatLinkResultsRtn
{
  public:
    SatLinkResultsFSim();
 
    ~SatLinkResultsFSim()
    {
    }

    static TypeId GetTypeId();

    inline double GetNormalizedSymbolInformation(double snirDb) const
    {
        return m_mutualInformationTable->GetNormalizedSymbolInformation(snirDb);
    }

    inline double GetSnirDb(double symbolInformationTarget) const
    {
        return m_mutualInformationTable->GetSnirDb(symbolInformationTarget);
    }

    inline Ptr<SatMutualInformationTable> GetMutualInformationTable() const
    {
        return m_mutualInformationTable;
    }
 
  protected:
    void DoInitialize();
 
  private:
    Ptr<SatMutualInformationTable> m_mutualInformationTable;
};

class SatLinkResultsLora : public SatLinkResultsRtn
{
  public:
    SatLinkResultsLora();
 
    ~SatLinkResultsLora()
    {
    }

    static TypeId GetTypeId();

    inline double GetNormalizedSymbolInformation(double snirDb) const
    {
        return m_mutualInformationTable->GetNormalizedSymbolInformation(snirDb);
    }

    inline double GetSnirDb(double symbolInformationTarget) const
    {
        return m_mutualInformationTable->GetSnirDb(symbolInformationTarget);
    }

    inline Ptr<SatMutualInformationTable> GetMutualInformationTable() const
    {
        return m_mutualInformationTable;
    }
 
  protected:
    void DoInitialize();
 
  private:
    Ptr<SatMutualInformationTable> m_mutualInformationTable;
};

class SatLinkResultsFwd : public SatLinkResults
{
  public:
    SatLinkResultsFwd();
 
    ~SatLinkResultsFwd()
    {
    }

    static TypeId GetTypeId();

    double GetBler(SatEnums::SatModcod_t modcod,
                   SatEnums::SatBbFrameType_t frameType,
                   double esNoDb) const;

    double GetEsNoDb(SatEnums::SatModcod_t modcod,
                     SatEnums::SatBbFrameType_t frameType,
                     double blerTarget) const;
 
  protected:
    virtual void DoInitialize() = 0;

    std::map<SatEnums::SatModcod_t, Ptr<SatLookUpTable>> m_table;
 
    double m_shortFrameOffsetInDb;
};

class SatLinkResultsDvbS2 : public SatLinkResultsFwd
{
  public:
    SatLinkResultsDvbS2();
 
    ~SatLinkResultsDvbS2()
    {
    }

    static TypeId GetTypeId();
 
  private:
    void DoInitialize();
};

class SatLinkResultsDvbS2X : public SatLinkResultsFwd
{
  public:
    SatLinkResultsDvbS2X();
 
    ~SatLinkResultsDvbS2X()
    {
    }

    static TypeId GetTypeId();
 
  private:
    void DoInitialize();
};
 
} // end of namespace ns3
 
#endif /* SATELLITE_LINK_RESULTS_H */