satellite-random-access-allocation-channel.cc

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>
 */
 
#include "satellite-random-access-allocation-channel.h"
 
#include <ns3/log.h>
 
NS_LOG_COMPONENT_DEFINE("SatRandomAccessAllocationChannel");
 
namespace ns3
{
 
NS_OBJECT_ENSURE_REGISTERED(SatRandomAccessAllocationChannel);
 
TypeId
SatRandomAccessAllocationChannel::GetTypeId(void)
{
    static TypeId tid = TypeId("ns3::SatRandomAccessAllocationChannel")
                            .SetParent<Object>()
                            .AddConstructor<SatRandomAccessAllocationChannel>();
    return tid;
}
 
SatRandomAccessAllocationChannel::SatRandomAccessAllocationChannel()
    : m_slottedAlohaAllowed(false),
      m_crdsaAllowed(false),
      m_essaAllowed(false),
      m_crdsaMinRandomizationValue(),
      m_crdsaMaxRandomizationValue(),
      m_crdsaNumOfInstances(),
      m_crdsaMinIdleBlocks(),
      m_crdsaIdleBlocksLeft(0),
      m_crdsaBackoffTimeInMilliSeconds(),
      m_crdsaBackoffProbability(),
      m_crdsaMaxUniquePayloadPerBlock(),
      m_crdsaMaxConsecutiveBlocksAccessed(),
      m_crdsaNumOfConsecutiveBlocksUsed(0),
      m_crdsaBackoffReleaseTime(0),
      m_fSimBackoffTimeInMilliSeconds(),
      m_fSimBackoffProbability(),
      m_fSimPhysicalLayerFrameInMilliSeconds()
{
    NS_LOG_FUNCTION(this);
}
 
SatRandomAccessAllocationChannel::~SatRandomAccessAllocationChannel()
{
    NS_LOG_FUNCTION(this);
}
 
void
SatRandomAccessAllocationChannel::DoCrdsaVariableSanityCheck()
{
    NS_LOG_FUNCTION(this);
 
    if (!m_crdsaAllowed)
    {
        NS_LOG_INFO("CRDSA disallowed: skipping sanity check");
        return;
    }
 
    if (m_crdsaMaxRandomizationValue < 1)
    {
        NS_FATAL_ERROR("SatRandomAccessAllocationChannel::DoCrdsaVariableSanityCheck - max < 1");
    }
 
    if (m_crdsaMinRandomizationValue > m_crdsaMaxRandomizationValue)
    {
        NS_FATAL_ERROR("SatRandomAccessAllocationChannel::DoCrdsaVariableSanityCheck - min > max");
    }
 
    if (m_crdsaNumOfInstances < 1)
    {
        NS_FATAL_ERROR(
            "SatRandomAccessAllocationChannel::DoCrdsaVariableSanityCheck - instances < 1");
    }
 
    if ((m_crdsaMaxRandomizationValue - m_crdsaMinRandomizationValue) < m_crdsaNumOfInstances)
    {
        NS_FATAL_ERROR("SatRandomAccessAllocationChannel::DoCrdsaVariableSanityCheck - (max - min) "
                       "< instances");
    }
 
    if (m_crdsaBackoffProbability < 0.0 || m_crdsaBackoffProbability > 1.0)
    {
        NS_FATAL_ERROR("SatRandomAccessAllocationChannel::CrdsaDoVariableSanityCheck - "
                       "m_crdsaBackoffProbability < 0.0 || m_crdsaBackoffProbability > 1.0");
    }
 
    NS_LOG_INFO("Variable sanity check done");
}
 
} // namespace ns3