satellite-bbframe-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: Jani Puttonen <jani.puttonen@magister.fi>
 */
 
#ifndef SATELLITE_BBFRAME_CONF_H
#define SATELLITE_BBFRAME_CONF_H
 
#include "satellite-enums.h"
#include "satellite-link-results.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 <utility>
#include <vector>
 
namespace ns3
{
 
class SatLinkResultsDvbS2;
 
class SatDvbS2Waveform : public SimpleRefCount<SatDvbS2Waveform>
{
  public:
    SatDvbS2Waveform();
 
    SatDvbS2Waveform(SatEnums::SatModcod_t modcod,
                     SatEnums::SatBbFrameType_t fType,
                     Time frameLen,
                     uint32_t payloadBits);
 
    SatEnums::SatModcod_t GetModcod() const;
 
    SatEnums::SatBbFrameType_t GetBbFrameType() const;
 
    uint32_t GetPayloadInBits() const;
 
    Time GetFrameDuration() const;
 
    void SetCNoRequirement(double cnoRequirement);
 
    double GetCNoRequirement() const;
 
    void Dump() const;
 
  private:
    SatEnums::SatModcod_t m_modcod;
 
    SatEnums::SatBbFrameType_t m_frameType;
 
    Time m_frameDuration;
 
    uint32_t m_payloadBits;
 
    double m_cnoRequirement;
};
 
class SatBbFrameConf : public Object
{
  public:
    SatBbFrameConf();
 
    SatBbFrameConf(double symbolRate, SatEnums::DvbVersion_t dvbVersion);
 
    virtual ~SatBbFrameConf();
 
    static TypeId GetTypeId(void);
 
    virtual TypeId GetInstanceTypeId(void) const;
 
    typedef std::map<std::pair<SatEnums::SatModcod_t, SatEnums::SatBbFrameType_t>,
                     Ptr<SatDvbS2Waveform>>
        waveformMap_t;
 
    inline uint32_t GetBbFrameHeaderSizeInBytes() const
    {
        return m_bbFrameHeaderSizeInBytes;
    }
 
    inline double GetBbFrameHighOccupancyThreshold() const
    {
        return m_bbFrameHighOccupancyThreshold;
    }
 
    inline double GetBbFrameLowOccupancyThreshold() const
    {
        return m_bbFrameLowOccupancyThreshold;
    }
 
    inline SatEnums::BbFrameUsageMode_t GetBbFrameUsageMode() const
    {
        return m_bbFrameUsageMode;
    }
 
    void InitializeCNoRequirements(Ptr<SatLinkResultsFwd> linkResults);
 
    Time GetDummyBbFrameDuration() const;
 
    Time GetBbFrameDuration(SatEnums::SatModcod_t modcod,
                            SatEnums::SatBbFrameType_t frameType) const;
 
    double GetSymbolRate();
 
    uint32_t GetBbFramePayloadBits(SatEnums::SatModcod_t modcod,
                                   SatEnums::SatBbFrameType_t frameType) const;
 
    SatEnums::SatModcod_t GetBestModcod(double cNo, SatEnums::SatBbFrameType_t frameType) const;
 
    SatEnums::SatModcod_t GetDefaultModCodDummyFramesS2X() const;
 
    SatEnums::SatModcod_t GetDefaultModCod() const;
 
    SatEnums::SatModcod_t GetMostRobustModcod(SatEnums::SatBbFrameType_t frameType) const;
 
    void DumpWaveforms() const;
 
    SatEnums::DvbVersion_t GetDvbVersion();
 
    std::vector<SatEnums::SatModcod_t> GetModCodsUsed();
 
  private:
    uint32_t CalculateBbFramePayloadBits(SatEnums::SatModcod_t modcod,
                                         SatEnums::SatBbFrameType_t frameType) const;
 
    Time CalculateBbFrameDuration(SatEnums::SatModcod_t modcod,
                                  SatEnums::SatBbFrameType_t frameType) const;
 
    void GetModCodsList();
 
    double m_symbolRate;
 
    uint32_t m_symbolsPerSlot;
 
    uint32_t m_pilotBlockInSymbols;
 
    uint32_t m_pilotBlockIntervalInSlots;
 
    uint32_t m_plHeaderInSlots;
 
    uint32_t m_dummyFrameInSlots;
 
    uint32_t m_bbFrameHeaderSizeInBytes;
 
    double m_bbFrameHighOccupancyThreshold;
 
    double m_bbFrameLowOccupancyThreshold;
 
    double m_targetBler;
 
    bool m_acmEnabled;
 
    SatEnums::SatModcod_t m_defaultModCodDummyFramesS2X;
 
    std::string m_defaultModCodDummyFramesS2XStr;
 
    SatEnums::SatModcod_t m_defaultModCod;
 
    std::string m_defaultModCodStr;
 
    std::map<uint32_t, uint32_t> m_shortFramePayloadInSlots;
    std::map<uint32_t, uint32_t> m_normalFramePayloadInSlots;
 
    waveformMap_t m_waveforms;
 
    SatEnums::BbFrameUsageMode_t m_bbFrameUsageMode;
 
    SatEnums::SatModcod_t m_mostRobustShortFrameModcod;
 
    SatEnums::SatModcod_t m_mostRobustNormalFrameModcod;
 
    SatEnums::DvbVersion_t m_dvbVersion;
 
    bool m_bbFrameS2XPilots;
 
    std::vector<SatEnums::SatModcod_t> m_modCodsUsed;
 
    std::string m_modCodsUsedStr;
};
 
} // namespace ns3
 
#endif // SATELLITE_BBFRAME_CONF_H