satellite-wave-form-conf.h

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: Sami Rantanen <sami.rantanen@magister.fi>
 */
 
#ifndef SATELLITE_WAVE_FORM_CONF_H
#define SATELLITE_WAVE_FORM_CONF_H
 
#include "satellite-enums.h"
 
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/ptr.h"
#include "ns3/simple-ref-count.h"
 
#include <map>
#include <stdint.h>
#include <string>
#include <vector>
 
namespace ns3
{
 
class SatLinkResultsRtn;

class SatWaveform : public SimpleRefCount<SatWaveform>
{
  public:
    SatWaveform();

    SatWaveform(uint32_t wfId,
                uint32_t modulatedBits,
                double codingRate,
                SatEnums::SatModcod_t modcod,
                uint32_t payloadBytes,
                uint32_t lengthInSymbols,
                uint32_t preambleLengthInSymbols);

    uint32_t GetWaveformId() const;

    SatEnums::SatModcod_t GetModCod() const;

    uint32_t GetPayloadInBytes() const;

    uint32_t GetPreambleLengthInSymbols() const;

    uint32_t GetBurstLengthInSymbols() const;

    Time GetPreambleDuration(double symbolRateInBaud) const;

    Time GetBurstDuration(double symbolRateInBaud) const;

    double GetSpectralEfficiency(double carrierBandwidthInHz, double symbolRateInBaud) const;

    double GetThroughputInBitsPerSecond(double symbolRateInBaud) const;

    double GetCNoThreshold(double symbolRateInBaud) const;

    void SetEbNoRequirement(double ebnoRequirement);

    void Dump(double carrierBandwidthInHz, double symbolRateInBaud) const;
 
  private:
    uint32_t m_waveformId;

    uint32_t m_modulatedBits;

    double m_codingRate;

    SatEnums::SatModcod_t m_modCod;

    uint32_t m_payloadBytes;

    uint32_t m_lengthInSymbols;

    uint32_t m_preambleLengthInSymbols;

    double m_ebnoRequirement;
};

class SatWaveformConf : public Object
{
  public:
    typedef std::vector<uint32_t> BurstLengthContainer_t;

    SatWaveformConf();

    SatWaveformConf(std::string directoryPathName);

    virtual void NotifyConstructionCompleted() override;

    virtual ~SatWaveformConf();

    static TypeId GetTypeId(void);

    inline bool IsAcmEnabled() const
    {
        return m_acmEnabled;
    }

    void InitializeEbNoRequirements(Ptr<SatLinkResultsRtn> linkResults);

    Ptr<SatWaveform> GetWaveform(uint32_t wfId) const;

    SatEnums::SatModcod_t GetModCod(uint32_t wfId) const;

    uint32_t GetDefaultWaveformId() const;

    inline uint32_t GetDefaultBurstLength() const
    {
        return GetWaveform(m_defaultWfId)->GetBurstLengthInSymbols();
    }

    inline const BurstLengthContainer_t& GetSupportedBurstLengths() const
    {
        return m_supportedBurstLengthsInSymbols;
    }

    bool GetBestWaveformId(double cno,
                           double symbolRateInBaud,
                           uint32_t& wfId,
                           double& cnoThreshold,
                           uint32_t burstLength = SHORT_BURST_LENGTH) const;

    bool GetMostRobustWaveformId(uint32_t& wfId, uint32_t burstLength = SHORT_BURST_LENGTH) const;

    void Dump(double carrierBandwidthInHz, double symbolRateInBaud) const;

    inline uint32_t GetMinWfId()
    {
        return m_minWfId;
    }

    inline uint32_t GetMaxWfId()
    {
        return m_maxWfId;
    }

    static const uint32_t SHORT_BURST_LENGTH = 536;

    static const uint32_t LONG_BURST_LENGTH = 1616;
 
  private:
    void ReadFromFileDefaultWaveform(std::string filePathName);

    void ReadFromFile(std::string filePathName);

    SatEnums::SatModcod_t ConvertToModCod(uint32_t modulatedBits,
                                          uint32_t codingRateNumerator,
                                          uint32_t codingRateDenominator) const;

    std::map<uint32_t, Ptr<SatWaveform>> m_waveforms;

    double m_targetBLER;

    bool m_acmEnabled;

    uint32_t m_defaultWfId;

    uint32_t m_minWfId;
    uint32_t m_maxWfId;

    SatEnums::SatWaveFormBurstLength_t m_burstLength;

    BurstLengthContainer_t m_supportedBurstLengthsInSymbols;
};
 
} // namespace ns3
 
#endif // SATELLITE_WAVE_FORM_CONF_H