satellite-phy-rx-carrier-per-slot.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: Jani Puttonen <jani.puttonen@magister.fi>
 * Author: Mathias Ettinger <mettinger@toulouse.viveris.fr>
 */
 
#ifndef SATELLITE_PHY_RX_CARRIER_PER_SLOT_H
#define SATELLITE_PHY_RX_CARRIER_PER_SLOT_H
 
#include "satellite-phy-rx-carrier.h"
 
#include "ns3/mac48-address.h"
#include "ns3/object.h"
#include "ns3/ptr.h"
#include "ns3/traced-callback.h"
 
#include <deque>
#include <list>
#include <map>
#include <stdint.h>
#include <vector>
 
namespace ns3
{
 
class SatPhyRxCarrier;

class SatPhyRxCarrierPerSlot : public SatPhyRxCarrier
{
  public:
    SatPhyRxCarrierPerSlot(uint32_t carrierId,
                           Ptr<SatPhyRxCarrierConf> carrierConf,
                           Ptr<SatWaveformConf> waveformConf,
                           bool randomAccessEnabled);

    virtual ~SatPhyRxCarrierPerSlot();

    static TypeId GetTypeId(void);

    virtual void BeginEndScheduling();

    inline void SetRandomAccessAllocationChannelId(uint8_t randomAccessAllocationChannelId)
    {
        m_randomAccessAllocationChannelId = randomAccessAllocationChannelId;
    }

    inline uint8_t GetRandomAccessAllocationChannelId() const
    {
        return m_randomAccessAllocationChannelId;
    }

    inline virtual CarrierType GetCarrierType()
    {
        return m_randomAccessEnabled ? CarrierType::RA_SLOTTED_ALOHA
                                     : CarrierType::DEDICATED_ACCESS;
    }
 
  protected:
    virtual void EndRxData(uint32_t key);

    virtual void DoDispose();

    virtual void ReceiveSlot(SatPhyRxCarrier::rxParams_s packetRxParams, const uint32_t nPackets);

    inline SatPhyRxCarrierConf::RandomAccessCollisionModel GetRandomAccessCollisionModel() const
    {
        return m_randomAccessCollisionModel;
    }

    inline bool IsRandomAccessDynamicLoadControlEnabled() const
    {
        return m_enableRandomAccessDynamicLoadControl;
    }

    double CalculateAverageNormalizedOfferedRandomAccessLoad();

    void SaveMeasuredRandomAccessLoad(double measuredRandomAccessLoad);

    virtual Ptr<SatInterference::InterferenceChangeEvent> CreateInterference(
        Ptr<SatSignalParameters> rxParams,
        Address rxAddress);

    uint32_t m_randomAccessBitsInFrame;


    TracedCallback<uint32_t, const Address&, bool> m_slottedAlohaRxCollisionTrace;

    TracedCallback<uint32_t, const Address&, bool> m_slottedAlohaRxErrorTrace;
 
  private:
    bool ProcessSlottedAlohaCollisions(
        double cSinr,
        Ptr<SatSignalParameters> rxParams,
        Ptr<SatInterference::InterferenceChangeEvent> interferenceEvent);

 
    uint8_t m_randomAccessAllocationChannelId; //< Random access allocation ID
    SatPhyRxCarrierConf::RandomAccessCollisionModel
        m_randomAccessCollisionModel;       //< Random access collision model
    double m_randomAccessConstantErrorRate; //< Constant error rate if collision model is
                                            // RA_CONSTANT_COLLISION_PROBABILITY
    uint32_t
        m_randomAccessAverageNormalizedOfferedLoadMeasurementWindowSize; //< Random access average
                                                                         // normalized offered load
                                                                         // measurement window size
    bool m_enableRandomAccessDynamicLoadControl; //< Is random access dynamic load control enabled
    std::deque<double>
        m_randomAccessDynamicLoadControlNormalizedOfferedLoad; //< Container for calculated
                                                               // normalized offered loads
 
    bool m_disableErrorHighTransmissionTime; //< Disable fatal error when transmission time is
                                             // higher than propagation time, but computations are
                                             // less precise
};
 
} // namespace ns3
 
#endif /* SATELLITE_PHY_RX_CARRIER_PER_SLOT_H */