satellite-random-access-container-conf.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_CONF_H
#define SATELLITE_RANDOM_ACCESS_CONF_H
 
#include "satellite-lower-layer-service.h"
#include "satellite-random-access-allocation-channel.h"
#include "satellite-superframe-sequence.h"
 
#include "ns3/object.h"
#include "ns3/simulator.h"
#include "ns3/uinteger.h"
 
#include <map>
#include <stdint.h>
#include <vector>
 
namespace ns3
{

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

    SatRandomAccessConf(Ptr<SatLowerLayerServiceConf> llsConf,
                        Ptr<SatSuperframeSeq> m_superframeSeq);

    virtual ~SatRandomAccessConf();

    static TypeId GetTypeId(void);

    Ptr<SatRandomAccessAllocationChannel> GetAllocationChannelConfiguration(
        uint32_t allocationChannel);

    uint32_t GetSlottedAlohaControlRandomizationIntervalInMilliSeconds()
    {
        return m_slottedAlohaControlRandomizationIntervalInMilliSeconds;
    }

    void SetSlottedAlohaControlRandomizationIntervalInMilliSeconds(
        uint32_t controlRandomizationIntervalInMilliSeconds)
    {
        m_slottedAlohaControlRandomizationIntervalInMilliSeconds =
            controlRandomizationIntervalInMilliSeconds;
    }

    uint32_t GetNumOfAllocationChannelsConfigurations()
    {
        return m_allocationChannelCount;
    }

    uint32_t GetAllocationChannelConfigurationId(uint32_t allocationChannel);

    uint32_t GetCrdsaSignalingOverheadInBytes()
    {
        return m_crdsaSignalingOverheadInBytes;
    }

    uint32_t GetSlottedAlohaSignalingOverheadInBytes()
    {
        return m_slottedAlohaSignalingOverheadInBytes;
    }

    void DoSlottedAlohaVariableSanityCheck();
 
  private:
    std::map<uint32_t, Ptr<SatRandomAccessAllocationChannel>> m_allocationChannelConf;

    std::vector<uint32_t> m_configurationIdPerAllocationChannel;

    uint32_t m_slottedAlohaControlRandomizationIntervalInMilliSeconds;

    uint32_t m_allocationChannelCount;

    uint32_t m_crdsaSignalingOverheadInBytes;

    uint32_t m_slottedAlohaSignalingOverheadInBytes;
};
 
} // namespace ns3
 
#endif /* SATELLITE_RANDOM_ACCESS_CONF_H */