satellite-lower-layer-service.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_LOWER_LAYER_SERIVICE_H
#define SATELLITE_LOWER_LAYER_SERIVICE_H
 
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/random-variable-stream.h"
 
#include <sstream>
#include <stdint.h>
#include <string>
#include <unordered_set>
#include <vector>
 
namespace ns3
{

class SatLowerLayerServiceDaEntry
{
    // grant access for SatLowerLayerServiceConf to access private members
    friend class SatLowerLayerServiceConf;
 
  public:
    SatLowerLayerServiceDaEntry();

    ~SatLowerLayerServiceDaEntry();
 
  private:
    bool m_constantAssignmentProvided;
    bool m_rbdcAllowed;
    bool m_volumeAllowed;
    Ptr<RandomVariableStream> m_constantServiceRateStream;
    uint16_t m_maximumServiceRateKbps;
    uint16_t m_minimumServiceRateKbps;
    uint16_t m_maximumBacklogInKbytes;

    inline bool GetConstantAssignmentProvided() const
    {
        return m_constantAssignmentProvided;
    }

    inline void SetConstantAssignmentProvided(bool constAssignmentProvided)
    {
        m_constantAssignmentProvided = constAssignmentProvided;
    }

    inline bool GetRbdcAllowed() const
    {
        return m_rbdcAllowed;
    }

    inline void SetRbdcAllowed(bool bdcAllowed)
    {
        m_rbdcAllowed = bdcAllowed;
    }

    inline bool GetVolumeAllowed() const
    {
        return m_volumeAllowed;
    }

    inline void SetVolumeAllowed(bool volumeAllowed)
    {
        m_volumeAllowed = volumeAllowed;
    }

    inline uint16_t GetConstantServiceRateInKbps() const
    {
        return m_constantServiceRateStream->GetInteger();
    }

    inline Ptr<RandomVariableStream> GetConstantServiceRateStream() const
    {
        return m_constantServiceRateStream;
    }

    inline void SetConstantServiceRateStream(Ptr<RandomVariableStream> constantServiceRateStream)
    {
        m_constantServiceRateStream = constantServiceRateStream;
    }

    inline uint16_t GetMaximumServiceRateInKbps() const
    {
        return m_maximumServiceRateKbps;
    }

    inline void SetMaximumServiceRateInKbps(uint16_t maximumServiceRateKbps)
    {
        m_maximumServiceRateKbps = maximumServiceRateKbps;
    }

    inline uint16_t GetMinimumServiceRateInKbps() const
    {
        return m_minimumServiceRateKbps;
    }

    inline void SetMinimumServiceRateInKbps(uint16_t minimumServiceRateKbps)
    {
        m_minimumServiceRateKbps = minimumServiceRateKbps;
    }

    inline uint16_t GetMaximumBacklogInKbytes() const
    {
        return m_maximumBacklogInKbytes;
    }

    inline void SetMaximumBacklogInKbytes(uint16_t maximumBacklogInKbytes)
    {
        m_maximumBacklogInKbytes = maximumBacklogInKbytes;
    }
};

class SatLowerLayerServiceRaEntry
{
    // grant access for SatLowerLayerServiceConf to access private members
    friend class SatLowerLayerServiceConf;
 
  public:
    SatLowerLayerServiceRaEntry();

    ~SatLowerLayerServiceRaEntry();
 
  private:
    uint8_t m_maxUniquePayloadPerBlock;
    uint8_t m_maxConsecutiveBlockAccessed;
    uint8_t m_minimumIdleBlock;
    uint16_t m_backOffTimeInMilliSeconds;
    uint16_t m_highLoadBackOffTimeInMilliSeconds;
    uint16_t m_backOffProbability;
    uint16_t m_highLoadBackOffProbability;
    uint8_t m_numberOfInstances;
    double m_averageNormalizedOfferedLoadThreshold;
    bool m_isCrdsaAllowed;
    bool m_isSlottedAlohaAllowed;
    bool m_isEssaAllowed;

    inline uint8_t GetMaximumUniquePayloadPerBlock() const
    {
        return m_maxUniquePayloadPerBlock;
    }

    inline void SetMaximumUniquePayloadPerBlock(uint8_t maxUniquePayloadPerBlock)
    {
        m_maxUniquePayloadPerBlock = maxUniquePayloadPerBlock;
    }

    inline uint8_t GetMaximumConsecutiveBlockAccessed() const
    {
        return m_maxConsecutiveBlockAccessed;
    }

    inline void SetMaximumConsecutiveBlockAccessed(uint8_t maxConsecutiveBlockAccessed)
    {
        m_maxConsecutiveBlockAccessed = maxConsecutiveBlockAccessed;
    }

    inline uint8_t GetMinimumIdleBlock() const
    {
        return m_minimumIdleBlock;
    }

    inline void SetMinimumIdleBlock(uint8_t minimumIdleBlock)
    {
        m_minimumIdleBlock = minimumIdleBlock;
    }

    inline uint16_t GetBackOffTimeInMilliSeconds() const
    {
        return m_backOffTimeInMilliSeconds;
    }

    inline void SetBackOffTimeInMilliSeconds(uint16_t backOffTimeInMilliSeconds)
    {
        m_backOffTimeInMilliSeconds = backOffTimeInMilliSeconds;
    }

    inline uint16_t GetHighLoadBackOffTimeInMilliSeconds() const
    {
        return m_highLoadBackOffTimeInMilliSeconds;
    }

    inline void SetHighLoadBackOffTimeInMilliSeconds(uint16_t backOffTimeInMilliSeconds)
    {
        m_highLoadBackOffTimeInMilliSeconds = backOffTimeInMilliSeconds;
    }

    inline uint16_t GetBackOffProbability() const
    {
        return m_backOffProbability;
    }

    inline void SetBackOffProbability(uint16_t backOffProbability)
    {
        m_backOffProbability = backOffProbability;
    }

    inline uint16_t GetHighLoadBackOffProbability() const
    {
        return m_highLoadBackOffProbability;
    }

    inline void SetHighLoadBackOffProbability(uint16_t highLoadBackOffProbability)
    {
        m_highLoadBackOffProbability = highLoadBackOffProbability;
    }

    inline uint8_t GetNumberOfInstances() const
    {
        return m_numberOfInstances;
    }

    inline void SetNumberOfInstances(uint8_t numberOfInstances)
    {
        m_numberOfInstances = numberOfInstances;
    }

    inline double GetAverageNormalizedOfferedLoadThreshold() const
    {
        return m_averageNormalizedOfferedLoadThreshold;
    }

    inline void SetAverageNormalizedOfferedLoadThreshold(
        double averageNormalizedOfferedLoadThreshold)
    {
        m_averageNormalizedOfferedLoadThreshold = averageNormalizedOfferedLoadThreshold;
    }

    inline bool GetIsSlottedAlohaAllowed() const
    {
        return m_isSlottedAlohaAllowed;
    }

    inline void SetIsSlottedAlohaAllowed(bool isSlottedAlohaAllowed)
    {
        m_isSlottedAlohaAllowed = isSlottedAlohaAllowed;
    }

    inline bool GetIsCrdsaAllowed() const
    {
        return m_isCrdsaAllowed;
    }

    inline void SetIsCrdsaAllowed(bool isCrdsaAllowed)
    {
        m_isCrdsaAllowed = isCrdsaAllowed;
    }

    inline bool GetIsEssaAllowed() const
    {
        return m_isEssaAllowed;
    }

    inline void SetIsEssaAllowed(bool isEssaAllowed)
    {
        m_isEssaAllowed = isEssaAllowed;
    }
};

class SatLowerLayerServiceConf : public Object
{
  public:
    static const uint8_t m_minDaServiceEntries = 2;
    static const uint8_t m_minRaServiceEntries = 1;
 
    static const uint8_t m_maxDaServiceEntries = 4;
    static const uint8_t m_maxRaServiceEntries = 3;

    SatLowerLayerServiceConf();

    ~SatLowerLayerServiceConf();

    static TypeId GetTypeId(void);

    inline uint8_t GetRaServiceCount() const
    {
        return m_raServiceEntryCount;
    }

    inline uint8_t GetDaServiceCount() const
    {
        return m_daServiceEntryCount;
    }

    uint8_t GetDynamicRatePersistence() const
    {
        return m_dynamicRatePersistence;
    }

    uint8_t GetVolumeBacklogPersistence() const
    {
        return m_volumeBacklogPersistence;
    }

    Time GetDefaultControlRandomizationInterval() const
    {
        return m_defaultControlRandomizationInterval;
    }

    inline uint8_t GetRaDefaultService() const
    {
        return m_raServiceIndexDefault;
    }

    bool GetDaConstantAssignmentProvided(uint8_t index) const;

    bool GetDaRbdcAllowed(uint8_t index) const;

    bool GetDaVolumeAllowed(uint8_t index) const;

    uint16_t GetDaConstantServiceRateInKbps(uint8_t index) const;

    Ptr<RandomVariableStream> GetDaConstantServiceRateStream(uint8_t index) const;

    uint16_t GetDaMaximumServiceRateInKbps(uint8_t index) const;

    uint16_t GetDaMinimumServiceRateInKbps(uint8_t index) const;

    uint16_t GetDaMaximumBacklogInKbytes(uint8_t index) const;

    uint8_t GetRaMaximumUniquePayloadPerBlock(uint8_t index) const;

    uint8_t GetRaMaximumConsecutiveBlockAccessed(uint8_t index) const;

    uint8_t GetRaMinimumIdleBlock(uint8_t index) const;

    uint16_t GetRaBackOffTimeInMilliSeconds(uint8_t index) const;

    uint16_t GetRaHighLoadBackOffTimeInMilliSeconds(uint8_t index) const;

    uint16_t GetRaBackOffProbability(uint8_t index) const;

    uint16_t GetRaHighLoadBackOffProbability(uint8_t index) const;

    uint8_t GetRaNumberOfInstances(uint8_t index) const;

    double GetRaAverageNormalizedOfferedLoadThreshold(uint8_t index) const;

    bool GetRaIsSlottedAlohaAllowed(uint8_t index) const;

    bool GetRaIsCrdsaAllowed(uint8_t index) const;

    bool GetRaIsEssaAllowed(uint8_t index) const;
 
  private:
    uint8_t m_dynamicRatePersistence;
    uint8_t m_volumeBacklogPersistence;
    Time m_defaultControlRandomizationInterval;
    uint8_t m_daServiceEntryCount;
    SatLowerLayerServiceDaEntry m_daServiceEntries[m_maxDaServiceEntries];
    uint8_t m_raServiceIndexDefault;
    uint8_t m_raServiceEntryCount;
    SatLowerLayerServiceRaEntry m_raServiceEntries[m_maxRaServiceEntries];

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

    static std::string GetIndexAsDaServiceName(uint8_t index);

    static std::string GetIndexAsRaServiceName(uint8_t index);

    void SetDaConstantAssignmentProvided(uint8_t index, bool constAssignmentProvided);

    void SetDaRbdcAllowed(uint8_t index, bool bdcAllowed);

    void SetDaVolumeAllowed(uint8_t index, bool volumeAllowed);

    void SetDaConstantServiceRateStream(uint8_t index,
                                        Ptr<RandomVariableStream> constantServiceRateStream);

    void SetDaMaximumServiceRateInKbps(uint8_t index, uint16_t maximumServiceRateKbps);

    void SetDaMinimumServiceRateInKbps(uint8_t index, uint16_t minimumServiceRateKbps);

    void SetDaMaximumBacklogInKbytes(uint8_t index, uint16_t maximumBacklogInKbytes);

    void SetRaMaximumUniquePayloadPerBlock(uint8_t index, uint8_t maxUniquePayloadPerBlock);

    void SetRaMaximumConsecutiveBlockAccessed(uint8_t index, uint8_t maxConsecutiveBlockAccessed);

    void SetRaMinimumIdleBlock(uint8_t index, uint8_t minimumIdleBlock);

    void SetRaBackOffTimeInMilliSeconds(uint8_t index, uint16_t backOffTimeInMilliSeconds);

    void SetRaHighLoadBackOffTimeInMilliSeconds(uint8_t index, uint16_t backOffTimeInMilliSeconds);

    void SetRaBackOffProbability(uint8_t index, uint16_t backOffProbability);

    void SetRaHighLoadBackOffProbability(uint8_t index, uint16_t highLoadBackOffProbability);

    void SetRaNumberOfInstances(uint8_t index, uint8_t numberOfInstances);

    void SetRaAverageNormalizedOfferedLoadThreshold(uint8_t index,
                                                    double averageNormalizedOfferedLoadThreshold);

    void SetRaIsSlottedAlohaAllowed(uint8_t index, bool isSlottedAlohaAllowed);

    void SetRaIsCrdsaAllowed(uint8_t index, bool isCrdsaAllowed);

    void SetRaIsEssaAllowed(uint8_t index, bool isEssaAllowed);

#define SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE(index)                                            \
    inline void SetDaServ##index##ConstantAssignmentProvided(bool value)                           \
    {                                                                                              \
        return SetDaConstantAssignmentProvided(index, value);                                      \
    }                                                                                              \
    inline bool GetDaServ##index##ConstantAssignmentProvided() const                               \
    {                                                                                              \
        return GetDaConstantAssignmentProvided(index);                                             \
    }                                                                                              \
    inline void SetDaServ##index##RbdcAllowed(bool value)                                          \
    {                                                                                              \
        return SetDaRbdcAllowed(index, value);                                                     \
    }                                                                                              \
    inline bool GetDaServ##index##RbdcAllowed() const                                              \
    {                                                                                              \
        return GetDaRbdcAllowed(index);                                                            \
    }                                                                                              \
    inline void SetDaServ##index##VolumeAllowed(bool value)                                        \
    {                                                                                              \
        return SetDaVolumeAllowed(index, value);                                                   \
    }                                                                                              \
    inline bool GetDaServ##index##VolumeAllowed() const                                            \
    {                                                                                              \
        return GetDaVolumeAllowed(index);                                                          \
    }                                                                                              \
    inline void SetDaServ##index##ConstantServiceRateStream(Ptr<RandomVariableStream> value)       \
    {                                                                                              \
        return SetDaConstantServiceRateStream(index, value);                                       \
    }                                                                                              \
    inline Ptr<RandomVariableStream> GetDaServ##index##ConstantServiceRateStream() const           \
    {                                                                                              \
        return GetDaConstantServiceRateStream(index);                                              \
    }                                                                                              \
    inline void SetDaServ##index##MaximumServiceRateInKbps(uint16_t value)                         \
    {                                                                                              \
        return SetDaMaximumServiceRateInKbps(index, value);                                        \
    }                                                                                              \
    inline uint16_t GetDaServ##index##MaximumServiceRateInKbps() const                             \
    {                                                                                              \
        return GetDaMaximumServiceRateInKbps(index);                                               \
    }                                                                                              \
    inline void SetDaServ##index##MinimumServiceRateInKbps(uint16_t value)                         \
    {                                                                                              \
        return SetDaMinimumServiceRateInKbps(index, value);                                        \
    }                                                                                              \
    inline uint16_t GetDaServ##index##MinimumServiceRateInKbps() const                             \
    {                                                                                              \
        return GetDaMinimumServiceRateInKbps(index);                                               \
    }                                                                                              \
    inline void SetDaServ##index##MaximumBacklogInKbytes(uint16_t value)                           \
    {                                                                                              \
        return SetDaMaximumBacklogInKbytes(index, value);                                          \
    }                                                                                              \
    inline uint8_t GetDaServ##index##MaximumBacklogInKbytes() const                                \
    {                                                                                              \
        return GetDaMaximumBacklogInKbytes(index);                                                 \
    }

#define SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE(index)                                            \
    inline void SetRaServ##index##MaximumUniquePayloadPerBlock(uint8_t value)                      \
    {                                                                                              \
        return SetRaMaximumUniquePayloadPerBlock(index, value);                                    \
    }                                                                                              \
    inline uint8_t GetRaServ##index##MaximumUniquePayloadPerBlock() const                          \
    {                                                                                              \
        return GetRaMaximumUniquePayloadPerBlock(index);                                           \
    }                                                                                              \
    inline void SetRaServ##index##MaximumConsecutiveBlockAccessed(uint8_t value)                   \
    {                                                                                              \
        return SetRaMaximumConsecutiveBlockAccessed(index, value);                                 \
    }                                                                                              \
    inline uint8_t GetRaServ##index##MaximumConsecutiveBlockAccessed() const                       \
    {                                                                                              \
        return GetRaMaximumConsecutiveBlockAccessed(index);                                        \
    }                                                                                              \
    inline void SetRaServ##index##MinimumIdleBlock(uint8_t value)                                  \
    {                                                                                              \
        return SetRaMinimumIdleBlock(index, value);                                                \
    }                                                                                              \
    inline uint8_t GetRaServ##index##MinimumIdleBlock() const                                      \
    {                                                                                              \
        return GetRaMinimumIdleBlock(index);                                                       \
    }                                                                                              \
    inline void SetRaServ##index##BackOffTimeInMilliSeconds(uint16_t value)                        \
    {                                                                                              \
        return SetRaBackOffTimeInMilliSeconds(index, value);                                       \
    }                                                                                              \
    inline uint16_t GetRaServ##index##BackOffTimeInMilliSeconds() const                            \
    {                                                                                              \
        return GetRaBackOffTimeInMilliSeconds(index);                                              \
    }                                                                                              \
    inline void SetRaServ##index##HighLoadBackOffTimeInMilliSeconds(uint16_t value)                \
    {                                                                                              \
        return SetRaHighLoadBackOffTimeInMilliSeconds(index, value);                               \
    }                                                                                              \
    inline uint16_t GetRaServ##index##HighLoadBackOffTimeInMilliSeconds() const                    \
    {                                                                                              \
        return GetRaHighLoadBackOffTimeInMilliSeconds(index);                                      \
    }                                                                                              \
    inline void SetRaServ##index##BackOffProbability(uint16_t value)                               \
    {                                                                                              \
        return SetRaBackOffProbability(index, value);                                              \
    }                                                                                              \
    inline uint16_t GetRaServ##index##BackOffProbability() const                                   \
    {                                                                                              \
        return GetRaBackOffProbability(index);                                                     \
    }                                                                                              \
    inline void SetRaServ##index##HighLoadBackOffProbability(uint16_t value)                       \
    {                                                                                              \
        return SetRaHighLoadBackOffProbability(index, value);                                      \
    }                                                                                              \
    inline uint16_t GetRaServ##index##HighLoadBackOffProbability() const                           \
    {                                                                                              \
        return GetRaHighLoadBackOffProbability(index);                                             \
    }                                                                                              \
    inline void SetRaServ##index##NumberOfInstances(uint8_t value)                                 \
    {                                                                                              \
        return SetRaNumberOfInstances(index, value);                                               \
    }                                                                                              \
    inline uint8_t GetRaServ##index##NumberOfInstances() const                                     \
    {                                                                                              \
        return GetRaNumberOfInstances(index);                                                      \
    }                                                                                              \
    inline void SetRaServ##index##AverageNormalizedOfferedLoadThreshold(double value)              \
    {                                                                                              \
        return SetRaAverageNormalizedOfferedLoadThreshold(index, value);                           \
    }                                                                                              \
    inline double GetRaServ##index##AverageNormalizedOfferedLoadThreshold() const                  \
    {                                                                                              \
        return GetRaAverageNormalizedOfferedLoadThreshold(index);                                  \
    }                                                                                              \
    inline void SetRaServ##index##IsSlottedAlohaAllowed(bool value)                                \
    {                                                                                              \
        return SetRaIsSlottedAlohaAllowed(index, value);                                           \
    }                                                                                              \
    inline bool GetRaServ##index##IsSlottedAlohaAllowed() const                                    \
    {                                                                                              \
        return GetRaIsSlottedAlohaAllowed(index);                                                  \
    }                                                                                              \
    inline void SetRaServ##index##IsCrdsaAllowed(bool value)                                       \
    {                                                                                              \
        return SetRaIsCrdsaAllowed(index, value);                                                  \
    }                                                                                              \
    inline bool GetRaServ##index##IsCrdsaAllowed() const                                           \
    {                                                                                              \
        return GetRaIsCrdsaAllowed(index);                                                         \
    }                                                                                              \
    inline void SetRaServ##index##IsEssaAllowed(bool value)                                        \
    {                                                                                              \
        return SetRaIsEssaAllowed(index, value);                                                   \
    }                                                                                              \
    inline bool GetRaServ##index##IsEssaAllowed() const                                            \
    {                                                                                              \
        return GetRaIsEssaAllowed(index);                                                          \
    }
 
    SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE(0);
    SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE(1);
    SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE(2);
    SAT_DA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE(3);
 
    SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE(0);
    SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE(1);
    SAT_RA_SERVICE_ATTRIBUTE_ACCESSOR_DEFINE(2);
};
 
} // namespace ns3
 
#endif /* SATELLITE_LOWER_LAYER_SERIVICE_H */