satellite-random-access-allocation-channel.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014 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: Frans Laakso <frans.laakso@magister.fi>
 * Author: Mathias Ettinger <mettinger@toulouse.viveris.fr>
 */
#ifndef SATELLITE_RANDOM_ACCESS_ALLOCATION_CHANNEL_H
#define SATELLITE_RANDOM_ACCESS_ALLOCATION_CHANNEL_H
 
#include "ns3/object.h"
#include "ns3/simulator.h"
#include "ns3/uinteger.h"
 
#include <cmath>
#include <stdint.h>
 
namespace ns3
{

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

    virtual ~SatRandomAccessAllocationChannel();

    static TypeId GetTypeId(void);

    bool GetSlottedAlohaAllowed()
    {
        return m_slottedAlohaAllowed;
    }

    void SetSlottedAlohaAllowed(bool isSlottedAlohaAllowed)
    {
        m_slottedAlohaAllowed = isSlottedAlohaAllowed;
    }

    bool GetCrdsaAllowed()
    {
        return m_crdsaAllowed;
    }

    void SetCrdsaAllowed(bool isCrdsaAllowed)
    {
        m_crdsaAllowed = isCrdsaAllowed;
    }

    bool GetEssaAllowed()
    {
        return m_essaAllowed;
    }

    void SetEssaAllowed(bool isEssaAllowed)
    {
        m_essaAllowed = isEssaAllowed;
    }

    uint32_t GetCrdsaBackoffTimeInMilliSeconds()
    {
        return m_crdsaBackoffTimeInMilliSeconds;
    }

    void SetCrdsaBackoffTimeInMilliSeconds(uint32_t crdsaBackoffTimeInMilliSeconds)
    {
        m_crdsaBackoffTimeInMilliSeconds = crdsaBackoffTimeInMilliSeconds;
    }

    uint32_t GetFSimBackoffTimeInMilliSeconds()
    {
        return m_fSimBackoffTimeInMilliSeconds;
    }

    void SetFSimBackoffTimeInMilliSeconds(uint32_t fSimBackoffTimeInMilliSeconds)
    {
        m_fSimBackoffTimeInMilliSeconds = fSimBackoffTimeInMilliSeconds;
    }

    void SetFSimBackoffTimeInFrames(uint32_t fSimBackoffTimeInFrames)
    {
        m_fSimBackoffTimeInMilliSeconds =
            fSimBackoffTimeInFrames * m_fSimPhysicalLayerFrameInMilliSeconds;
    }

    Time GetCrdsaBackoffReleaseTime()
    {
        return m_crdsaBackoffReleaseTime;
    }

    void SetFSimPhysicalLayerFrameInMilliSeconds(uint32_t fSimPhysicalLayerFrameInMilliSeconds)
    {
        m_fSimPhysicalLayerFrameInMilliSeconds = fSimPhysicalLayerFrameInMilliSeconds;
    }

    void SetCrdsaBackoffReleaseTime(Time crdsaBackoffReleaseTime)
    {
        m_crdsaBackoffReleaseTime = crdsaBackoffReleaseTime;
    }

    double GetCrdsaBackoffProbability()
    {
        return m_crdsaBackoffProbability;
    }

    void SetCrdsaBackoffProbability(uint16_t crdsaBackoffProbability)
    {
        m_crdsaBackoffProbability = (crdsaBackoffProbability + 1) * (1 / (std::pow(2, 16)));
    }

    double GetFSimBackoffProbability()
    {
        return m_fSimBackoffProbability;
    }

    void SetFSimBackoffProbability(uint16_t fSimPersistence)
    {
        m_fSimBackoffProbability = 1.0 / (std::pow(2.0, fSimPersistence / 2.0));
    }

    uint32_t GetCrdsaMinRandomizationValue()
    {
        return m_crdsaMinRandomizationValue;
    }

    void SetCrdsaMinRandomizationValue(uint32_t minRandomizationValue)
    {
        m_crdsaMinRandomizationValue = minRandomizationValue;
    }

    uint32_t GetCrdsaMaxRandomizationValue()
    {
        return m_crdsaMaxRandomizationValue;
    }

    void SetCrdsaMaxRandomizationValue(uint32_t maxRandomizationValue)
    {
        m_crdsaMaxRandomizationValue = maxRandomizationValue;
    }

    uint32_t GetCrdsaNumOfInstances()
    {
        return m_crdsaNumOfInstances;
    }

    void SetCrdsaNumOfInstances(uint32_t numOfInstances)
    {
        m_crdsaNumOfInstances = numOfInstances;
    }

    uint32_t GetCrdsaMinIdleBlocks()
    {
        return m_crdsaMinIdleBlocks;
    }

    void SetCrdsaMinIdleBlocks(uint32_t minIdleBlocks)
    {
        m_crdsaMinIdleBlocks = minIdleBlocks;
    }

    uint32_t GetCrdsaIdleBlocksLeft()
    {
        return m_crdsaIdleBlocksLeft;
    }

    void SetCrdsaIdleBlocksLeft(uint32_t idleBlocksLeft)
    {
        m_crdsaIdleBlocksLeft = idleBlocksLeft;
    }

    uint32_t GetCrdsaMaxUniquePayloadPerBlock()
    {
        return m_crdsaMaxUniquePayloadPerBlock;
    }

    void SetCrdsaMaxUniquePayloadPerBlock(uint32_t maxUniquePayloadPerBlock)
    {
        m_crdsaMaxUniquePayloadPerBlock = maxUniquePayloadPerBlock;
    }

    uint32_t GetCrdsaMaxConsecutiveBlocksAccessed()
    {
        return m_crdsaMaxConsecutiveBlocksAccessed;
    }

    void SetCrdsaMaxConsecutiveBlocksAccessed(uint32_t maxConsecutiveBlocksAccessed)
    {
        m_crdsaMaxConsecutiveBlocksAccessed = maxConsecutiveBlocksAccessed;
    }

    uint32_t GetCrdsaNumOfConsecutiveBlocksUsed()
    {
        return m_crdsaNumOfConsecutiveBlocksUsed;
    }

    void SetCrdsaNumOfConsecutiveBlocksUsed(uint32_t numOfConsecutiveBlocksUsed)
    {
        m_crdsaNumOfConsecutiveBlocksUsed = numOfConsecutiveBlocksUsed;
    }

    void DoCrdsaVariableSanityCheck();
 
  private:
    bool m_slottedAlohaAllowed;

    bool m_crdsaAllowed;

    bool m_essaAllowed;

    uint32_t m_crdsaMinRandomizationValue;

    uint32_t m_crdsaMaxRandomizationValue;

    uint32_t m_crdsaNumOfInstances;

    uint32_t m_crdsaMinIdleBlocks;

    uint32_t m_crdsaIdleBlocksLeft;

    uint32_t m_crdsaBackoffTimeInMilliSeconds;

    double m_crdsaBackoffProbability;

    uint32_t m_crdsaMaxUniquePayloadPerBlock;

    uint32_t m_crdsaMaxConsecutiveBlocksAccessed;

    uint32_t m_crdsaNumOfConsecutiveBlocksUsed;

    Time m_crdsaBackoffReleaseTime;

    uint32_t m_fSimBackoffTimeInMilliSeconds;

    double m_fSimBackoffProbability;

    uint32_t m_fSimPhysicalLayerFrameInMilliSeconds;
};
 
} // namespace ns3
 
#endif /* SATELLITE_RANDOM_ACCESS_ALLOCATION_CHANNEL_H */