satellite-frame-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
 * Copyright (c) 2018 CNES
 *
 * 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>
 * Author: Mathias Ettinger <mettinger@toulouse.viveris.fr>
 */
 
#ifndef SATELLITE_FRAME_CONF_H
#define SATELLITE_FRAME_CONF_H
 
#include "satellite-const-variables.h"
#include "satellite-enums.h"
#include "satellite-wave-form-conf.h"
 
#include "ns3/ptr.h"
#include "ns3/random-variable-stream.h"
#include "ns3/simple-ref-count.h"
 
#include <map>
#include <sstream>
#include <stdint.h>
#include <string>
#include <tuple>
#include <vector>
 
namespace ns3
{

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

    SatBtuConf(double bandwidthInHz, double rollOff, double spacing, uint32_t spreadingFactor);

    ~SatBtuConf();

    inline double GetAllocatedBandwidthInHz() const
    {
        return m_allocatedBandwidthInHz;
    }

    inline double GetOccupiedBandwidthInHz() const
    {
        return m_occupiedBandwidthInHz;
    }

    inline double GetEffectiveBandwidthInHz() const
    {
        return m_effectiveBandwidthInHz;
    }

    inline double GetSpreadingFactor() const
    {
        return m_spreadingFactor;
    }

    inline double GetSymbolRateInBauds() const
    {
        return GetEffectiveBandwidthInHz() / GetSpreadingFactor();
    }
 
  private:
    double m_allocatedBandwidthInHz;
    double m_occupiedBandwidthInHz;
    double m_effectiveBandwidthInHz; // i.e. symbol rate
    double m_spreadingFactor;
    Time m_duration; // duration field reserved, but not used currently
};

 
class SatTimeSlotConf : public SimpleRefCount<SatTimeSlotConf>
{
  public:
    typedef enum
    {
        SLOT_TYPE_C,  
        SLOT_TYPE_TR, 
        SLOT_TYPE_TRC 
 
    } SatTimeSlotType_t;

    SatTimeSlotConf();

    SatTimeSlotConf(Time startTime,
                    uint32_t waveFormId,
                    uint16_t carrierId,
                    SatTimeSlotConf::SatTimeSlotType_t slotType);

    ~SatTimeSlotConf();

    inline Time GetStartTime() const
    {
        return m_startTime;
    }

    inline uint32_t GetWaveFormId() const
    {
        return m_waveFormId;
    }

    inline uint16_t GetCarrierId() const
    {
        return m_frameCarrierId;
    }

    inline void SetRcIndex(uint8_t rcIndex)
    {
        m_rcIndex = rcIndex;
    }

    inline uint8_t GetRcIndex()
    {
        return m_rcIndex;
    }

    inline SatTimeSlotConf::SatTimeSlotType_t GetSlotType() const
    {
        return m_slotType;
    }

    inline void SetSlotType(SatTimeSlotConf::SatTimeSlotType_t slotType)
    {
        m_slotType = slotType;
    }
 
  private:
    Time m_startTime;
    uint32_t m_waveFormId;
    uint16_t m_frameCarrierId;
    uint8_t m_rcIndex;
 
    SatTimeSlotType_t m_slotType;
};

 
class SatFrameConf : public SimpleRefCount<SatFrameConf>
{
  public:
    typedef std::vector<Ptr<SatTimeSlotConf>> SatTimeSlotConfContainer_t;
 
    static const uint16_t m_maxTimeSlotCount = SatConstVariables::MAXIMUM_TIME_SLOT_ID + 1;

    typedef struct
    {
        double m_bandwidthHz;
        Time m_targetDuration;
        Ptr<SatFrameConf> m_parent;
        Ptr<SatBtuConf> m_btuConf;
        Ptr<SatWaveformConf> m_waveformConf;
        uint8_t m_allocationChannel;
        uint8_t m_guardTimeSymbols;
        bool m_isRandomAccess;
        bool m_isLogon;
        bool m_defaultWaveformInUse;
        bool m_checkSlotLimit;
    } SatFrameConfParams_t;

    SatFrameConf();

    SatFrameConf(SatFrameConfParams_t parameters);

    ~SatFrameConf();

    Ptr<SatTimeSlotConf> GetTimeSlotConf(uint16_t index) const;

    Ptr<SatTimeSlotConf> GetTimeSlotConf(uint16_t carrierId, uint16_t index) const;

    inline double GetBandwidthHz() const
    {
        return m_bandwidthHz;
    }

    inline Time GetDuration() const
    {
        return m_duration;
    }

    inline uint32_t GetCarrierMaxSymbols() const
    {
        return m_maxSymbolsPerCarrier;
    }

    inline uint32_t GetCarrierMinPayloadInBytes() const
    {
        return m_minPayloadPerCarrierInBytes;
    }

    double GetCarrierFrequencyHz(uint16_t carrierId) const;

    double GetCarrierBandwidthHz(SatEnums::CarrierBandwidthType_t bandwidthType) const;

    inline bool IsSubdivided() const
    {
        return m_parent != nullptr;
        ;
    }

    uint8_t GetSubdivisionLevel() const;
 
    inline Ptr<SatFrameConf> GetParent() const
    {
        return m_parent;
    }

    inline Ptr<SatBtuConf> GetBtuConf() const
    {
        return m_btuConf;
    }

    inline uint16_t GetCarrierCount() const
    {
        return m_carrierCount;
    }

    uint16_t GetTimeSlotCount() const;

    SatTimeSlotConfContainer_t GetTimeSlotConfs(uint16_t carrierId) const;

    inline bool IsRandomAccess() const
    {
        return m_isRandomAccess;
    }

    inline bool IsLogon() const
    {
        return m_isLogon;
    }

    inline uint8_t GetAllocationChannelId() const
    {
        return m_allocationChannel;
    }

    inline Ptr<SatWaveformConf> GetWaveformConf() const
    {
        return m_waveformConf;
    }

    inline uint8_t GetGuardTimeSymbols() const
    {
        return m_guardTimeSymbols;
    }
 
  private:
    typedef std::map<uint16_t, SatTimeSlotConfContainer_t> SatTimeSlotConfMap_t; // key = carrier ID
 
    double m_bandwidthHz;
    Time m_duration;
    bool m_isRandomAccess;
    bool m_isLogon;
 
    Ptr<SatFrameConf> m_parent;
    Ptr<SatBtuConf> m_btuConf;
    Ptr<SatWaveformConf> m_waveformConf;
    uint8_t m_allocationChannel;
    uint16_t m_carrierCount;
    uint32_t m_maxSymbolsPerCarrier;
    uint32_t m_minPayloadPerCarrierInBytes;
    SatTimeSlotConfMap_t m_timeSlotConfMap;
    uint8_t m_guardTimeSymbols;

    uint16_t AddTimeSlotConf(Ptr<SatTimeSlotConf> conf);
};

class SatSuperframeConf : public Object
{
  public:
    typedef enum
    {
        SUPER_FRAME_CONFIG_0, 
        SUPER_FRAME_CONFIG_1, 
        SUPER_FRAME_CONFIG_2, 
        SUPER_FRAME_CONFIG_3, 
        SUPER_FRAME_CONFIG_4, 
    } SuperFrameConfiguration_t;

    typedef std::vector<Ptr<SatFrameConf>> SatFrameConfList_t;

    typedef enum
    {
        CONFIG_TYPE_0, 
        CONFIG_TYPE_1, 
        CONFIG_TYPE_2, 
        CONFIG_TYPE_3, 
        CONFIG_TYPE_4  
    } ConfigType_t;
 
    static const uint8_t m_maxFrameCount = 10;

    static Ptr<SatSuperframeConf> CreateSuperframeConf(SuperFrameConfiguration_t conf);

    template <class T>
    static std::string GetNumberAsString(T number)
    {
        std::stringstream ss; // create a string stream
        ss << number;         // add number to the stream
 
        return ss.str();
    }

    static std::string GetIndexAsFrameName(uint32_t index);

    static TypeId GetTypeId(void);

    SatSuperframeConf();

    ~SatSuperframeConf();

    inline double GetBandwidthHz() const
    {
        return m_usedBandwidthHz;
    }

    inline Time GetDuration() const
    {
        return m_duration;
    }

    Ptr<SatFrameConf> GetFrameConf(uint8_t id) const;

    uint32_t GetCarrierId(uint8_t frameId, uint16_t frameCarrierId) const;

    uint32_t GetCarrierCount() const;

    double GetCarrierFrequencyHz(uint32_t carrierId) const;

    double GetCarrierBandwidthHz(uint32_t carrierId,
                                 SatEnums::CarrierBandwidthType_t bandwidthType) const;

    Ptr<SatFrameConf> GetCarrierFrameConf(uint32_t carrierId) const;

    bool IsRandomAccessCarrier(uint32_t carrierId) const;

    void Configure(double allocatedBandwidthHz,
                   Time targetDuration,
                   Ptr<SatWaveformConf> waveformConf);

    virtual void DoConfigure() = 0;

    SatFrameConf::SatTimeSlotConfContainer_t GetRaSlots(uint8_t raChannel);

    uint16_t GetRaSlotCount(uint8_t raChannel);

    uint8_t GetRaChannelCount() const;

    uint8_t GetRaChannel(uint32_t carrierId) const;

    uint8_t GetRaChannelFrameId(uint8_t raChannel) const;

    uint8_t GetRaChannelAllocationChannelId(uint8_t raChannel) const;

    uint32_t GetRaChannelTimeSlotPayloadInBytes(uint8_t raChannel) const;

    inline void SetFrameCount(uint8_t frameCount)
    {
        m_frameCount = frameCount;
    }

    inline uint8_t GetFrameCount() const
    {
        return m_frameCount;
    }

    inline void SetConfigType(SatSuperframeConf::ConfigType_t type)
    {
        m_configType = type;
    }

    inline SatSuperframeConf::ConfigType_t GetConfigType() const
    {
        return m_configType;
    }
 
    inline void SetMaxSubdivision(uint8_t maximumCarrierSubdivision)
    {
        m_maxCarrierSubdivision = maximumCarrierSubdivision;
    }
 
    inline uint8_t GetMaxSubdivision() const
    {
        return m_maxCarrierSubdivision;
    }
 
    // Frame specific getter and setter method for attributes (called by methods of objects derived
    // from this object)
    void SetFrameAllocatedBandwidthHz(uint8_t frameIndex, double bandwidthHz);
    void SetFrameCarrierAllocatedBandwidthHz(uint8_t frameIndex, double bandwidthHz);
    void SetFrameCarrierSpacing(uint8_t frameIndex, double spacing);
    void SetFrameCarrierRollOff(uint8_t frameIndex, double rollOff);
    void SetFrameCarrierSpreadingFactor(uint8_t frameIndex, uint32_t spreadingFactor);
    void SetFrameRandomAccess(uint8_t frameIndex, bool randomAccess);
    void SetFrameLogon(uint8_t frameIndex, bool logon);
    void SetFrameAllocationChannelId(uint8_t frameIndex, uint8_t allocationChannel);
    void SetFrameGuardTimeSymbols(uint8_t frameIndex, uint8_t guardTimeSymbols);
 
    double GetFrameAllocatedBandwidthHz(uint8_t frameIndex) const;
    double GetFrameCarrierAllocatedBandwidthHz(uint8_t frameIndex) const;
    double GetFrameCarrierSpacing(uint8_t frameIndex) const;
    double GetFrameCarrierRollOff(uint8_t frameIndex) const;
    uint32_t GetFrameCarrierSpreadingFactor(uint8_t frameIndex) const;
    bool IsFrameRandomAccess(uint8_t frameIndex) const;
    bool IsFrameLogon(uint8_t frameIndex) const;
    uint8_t GetFrameAllocationChannelId(uint8_t frameIndex) const;
    uint8_t GetFrameGuardTimeSymbols(uint8_t frameIndex) const;
    bool IsLogonEnabled() const;
    uint32_t GetLogonChannelIndex() const;
 
  private:
    // first = frame ID, second = RA channel id (index), third = allocation channel id
    typedef std::tuple<uint8_t, uint8_t, uint8_t> RaChannelInfo_t;
 
    double m_usedBandwidthHz;
    Time m_duration;
 
    uint8_t m_frameCount;
    ConfigType_t m_configType;
    uint8_t m_maxCarrierSubdivision;
 
    double m_frameAllocatedBandwidth[m_maxFrameCount];
    double m_frameCarrierAllocatedBandwidth[m_maxFrameCount];
    double m_frameCarrierSpacing[m_maxFrameCount];
    double m_frameCarrierRollOff[m_maxFrameCount];
    uint32_t m_frameCarrierSpreadingFactor[m_maxFrameCount];
    bool m_frameIsRandomAccess[m_maxFrameCount];
    bool m_frameIsLogon[m_maxFrameCount];
    uint8_t m_frameAllocationChannel[m_maxFrameCount];
    uint8_t m_frameGuardTimeSymbols[m_maxFrameCount];
 
    SatFrameConfList_t m_frames;
    std::vector<RaChannelInfo_t> m_raChannels;
    uint32_t m_carrierCount;
    bool m_logonEnabled;
    uint32_t m_logonChannelIndex;

    uint8_t GetCarrierFrame(uint32_t carrierId) const;

    void AddFrameConf(SatFrameConf::SatFrameConfParams_t frameConfParameters,
                      double bandwidthInHz,
                      double rollOff,
                      double spacing,
                      uint32_t spreadingFactor,
                      uint8_t subdivisionLevel);
 
  public:
// macro to ease definition of access methods for frame specific attributes
#define FRAME_ATTRIBUTE_ACCESSOR_DEFINE(index)                                                     \
    inline void SetFrame##index##AllocatedBandwidthHz(double value)                                \
    {                                                                                              \
        return SetFrameAllocatedBandwidthHz(index, value);                                         \
    }                                                                                              \
    inline double GetFrame##index##AllocatedBandwidthHz() const                                    \
    {                                                                                              \
        return GetFrameAllocatedBandwidthHz(index);                                                \
    }                                                                                              \
    inline void SetFrame##index##CarrierAllocatedBandwidthHz(double value)                         \
    {                                                                                              \
        return SetFrameCarrierAllocatedBandwidthHz(index, value);                                  \
    }                                                                                              \
    inline double GetFrame##index##CarrierAllocatedBandwidthHz() const                             \
    {                                                                                              \
        return GetFrameCarrierAllocatedBandwidthHz(index);                                         \
    }                                                                                              \
    inline void SetFrame##index##CarrierSpacing(double value)                                      \
    {                                                                                              \
        return SetFrameCarrierSpacing(index, value);                                               \
    }                                                                                              \
    inline double GetFrame##index##CarrierSpacing() const                                          \
    {                                                                                              \
        return GetFrameCarrierSpacing(index);                                                      \
    }                                                                                              \
    inline void SetFrame##index##CarrierRollOff(double value)                                      \
    {                                                                                              \
        return SetFrameCarrierRollOff(index, value);                                               \
    }                                                                                              \
    inline double GetFrame##index##CarrierRollOff() const                                          \
    {                                                                                              \
        return GetFrameCarrierRollOff(index);                                                      \
    }                                                                                              \
    inline void SetFrame##index##SpreadingFactor(uint32_t value)                                   \
    {                                                                                              \
        return SetFrameCarrierSpreadingFactor(index, value);                                       \
    }                                                                                              \
    inline double GetFrame##index##SpreadingFactor() const                                         \
    {                                                                                              \
        return GetFrameCarrierSpreadingFactor(index);                                              \
    }                                                                                              \
    inline void SetFrame##index##RandomAccess(bool value)                                          \
    {                                                                                              \
        return SetFrameRandomAccess(index, value);                                                 \
    }                                                                                              \
    inline double IsFrame##index##RandomAccess() const                                             \
    {                                                                                              \
        return IsFrameRandomAccess(index);                                                         \
    }                                                                                              \
    inline void SetFrame##index##AllocationChannelId(uint8_t value)                                \
    {                                                                                              \
        return SetFrameAllocationChannelId(index, value);                                          \
    }                                                                                              \
    inline uint8_t GetFrame##index##AllocationChannelId() const                                    \
    {                                                                                              \
        return GetFrameAllocationChannelId(index);                                                 \
    }                                                                                              \
    inline void SetFrame##index##Logon(bool value)                                                 \
    {                                                                                              \
        return SetFrameLogon(index, value);                                                        \
    }                                                                                              \
    inline double IsFrame##index##Logon() const                                                    \
    {                                                                                              \
        return IsFrameLogon(index);                                                                \
    }                                                                                              \
    inline void SetFrame##index##GuardTimeSymbols(uint8_t value)                                   \
    {                                                                                              \
        return SetFrameGuardTimeSymbols(index, value);                                             \
    }                                                                                              \
    inline uint8_t GetFrame##index##GuardTimeSymbols() const                                       \
    {                                                                                              \
        return GetFrameGuardTimeSymbols(index);                                                    \
    }
 
    // Access method definition for frame specific attributes
    // there should be as many macro calls as m_maxFrameCount defines
    FRAME_ATTRIBUTE_ACCESSOR_DEFINE(0);
    FRAME_ATTRIBUTE_ACCESSOR_DEFINE(1);
    FRAME_ATTRIBUTE_ACCESSOR_DEFINE(2);
    FRAME_ATTRIBUTE_ACCESSOR_DEFINE(3);
    FRAME_ATTRIBUTE_ACCESSOR_DEFINE(4);
    FRAME_ATTRIBUTE_ACCESSOR_DEFINE(5);
    FRAME_ATTRIBUTE_ACCESSOR_DEFINE(6);
    FRAME_ATTRIBUTE_ACCESSOR_DEFINE(7);
    FRAME_ATTRIBUTE_ACCESSOR_DEFINE(8);
    FRAME_ATTRIBUTE_ACCESSOR_DEFINE(9);
};

class SatSuperframeConf0 : public SatSuperframeConf
{
  public:
    static TypeId GetTypeId(void);

    SatSuperframeConf0();

    ~SatSuperframeConf0();
 
    virtual void DoConfigure();
 
  private:
};

class SatSuperframeConf1 : public SatSuperframeConf
{
  public:
    static TypeId GetTypeId(void);

    SatSuperframeConf1();

    ~SatSuperframeConf1();
 
    virtual void DoConfigure();
 
  private:
};

class SatSuperframeConf2 : public SatSuperframeConf
{
  public:
    static TypeId GetTypeId(void);

    SatSuperframeConf2();

    ~SatSuperframeConf2();
 
    virtual void DoConfigure();
 
  private:
};

class SatSuperframeConf3 : public SatSuperframeConf
{
  public:
    static TypeId GetTypeId(void);

    SatSuperframeConf3();

    ~SatSuperframeConf3();
 
    virtual void DoConfigure();
 
  private:
};

class SatSuperframeConf4 : public SatSuperframeConf
{
  public:
    static TypeId GetTypeId(void);

    SatSuperframeConf4();

    ~SatSuperframeConf4();
 
    virtual void DoConfigure();
 
  private:
};
 
} // namespace ns3
 
#endif // SATELLITE_FRAME_CONF_H