satellite-phy-rx-carrier-per-frame.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_FRAME_H
#define SATELLITE_PHY_RX_CARRIER_PER_FRAME_H
 
#include "satellite-crdsa-replica-tag.h"
#include "satellite-phy-rx-carrier-per-slot.h"
#include "satellite-phy-rx-carrier.h"
#include "satellite-rtn-link-time.h"
 
#include "ns3/singleton.h"
 
#include <list>
#include <map>
#include <stdint.h>
#include <vector>
 
namespace ns3
{
 
class Address;
class SatPhy;
class SatSignalParameters;
class SatLinkResults;
class SatChannelEstimationErrorContainer;
class SatNodeInfo;
class SatPhyRxCarrier;
class SatPhyRxCarrierPerSlot;
class SatCrdsaReplicaTag;

class SatPhyRxCarrierPerFrame : public SatPhyRxCarrierPerSlot
{
  public:
    typedef struct
    {
        Ptr<SatSignalParameters> rxParams;
        Mac48Address destAddress;
        Mac48Address sourceAddress;
        uint16_t ownSlotId;
        std::vector<uint16_t> slotIdsForOtherReplicas;
        bool hasCollision;
        bool packetHasBeenProcessed;
        double cSinr;
        double ifPower;
        bool phyError;
    } crdsaPacketRxParams_s;

    SatPhyRxCarrierPerFrame(uint32_t carrierId,
                            Ptr<SatPhyRxCarrierConf> carrierConf,
                            Ptr<SatWaveformConf> waveformConf,
                            bool randomAccessEnabled);

    virtual ~SatPhyRxCarrierPerFrame();

    static TypeId GetTypeId(void);

    static bool CompareCrdsaPacketId(SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s obj1,
                                     SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s obj2);

    void BeginEndScheduling();

    inline virtual CarrierType GetCarrierType()
    {
        return CarrierType::RA_CRDSA;
    }
 
  protected:
    virtual void ReceiveSlot(SatPhyRxCarrier::rxParams_s packetRxParams, const uint32_t nPackets);

    virtual void DoDispose();

    virtual void PerformSicCycles(
        std::vector<SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s>& combinedPacketsForFrame);

    bool IsReplica(const SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s& packet,
                   const SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s& otherPacket) const;

    double CalculatePacketCompositeSinr(crdsaPacketRxParams_s& packet);

    void EliminateInterference(
        std::map<uint32_t, std::list<SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s>>::iterator
            iter,
        SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s processedPacket);

    void FindAndRemoveReplicas(SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s packet);
 
    inline std::map<uint32_t, std::list<SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s>>&
    GetCrdsaPacketContainer()
    {
        return m_crdsaPacketContainer;
    }
 
  private:
    void AddCrdsaPacket(SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s crdsaPacketParams);

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

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

    std::vector<SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s> ProcessFrame();

    bool HaveSameSlotIds(const SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s& packet,
                         const SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s& otherPacket) const;

    double CalculateNormalizedOfferedRandomAccessLoad();

    void DoFrameEnd();

    void MeasureRandomAccessLoad();

    void UpdateRandomAccessLoad();

    SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s ProcessReceivedCrdsaPacket(
        SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s packet,
        uint32_t numOfPacketsForThisSlot);

    std::map<uint32_t, std::list<SatPhyRxCarrierPerFrame::crdsaPacketRxParams_s>>
        m_crdsaPacketContainer;

    bool m_frameEndSchedulingInitialized;
};

 
} // namespace ns3
 
#endif /* SATELLITE_PHY_RX_CARRIER_PER_FRAME_H */