satellite-phy-rx-carrier-per-window.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * 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: Joaquin Muguerza <jmuguerza@toulouse.viveris.fr>
 */
 
#ifndef SATELLITE_PHY_RX_CARRIER_PER_WINDOW_H
#define SATELLITE_PHY_RX_CARRIER_PER_WINDOW_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 <stdint.h>
#include <utility>
#include <vector>
 
namespace ns3
{
 
class Address;
class SatPhy;
class SatSignalParameters;
class SatLinkResults;
class SatChannelEstimationErrorContainer;
class SatNodeInfo;
class SatPhyRxCarrier;
class SatPhyRxCarrierPerSlot;
class SatCrdsaReplicaTag;

class SatPhyRxCarrierPerWindow : public SatPhyRxCarrierPerSlot
{
  public:
    typedef struct
    {
        Ptr<SatSignalParameters> rxParams;
        Mac48Address destAddress;
        Mac48Address sourceAddress;
        bool hasBeenDecoded;
        bool hasBeenTreatedInWindow;
        bool failedSic;
        bool hasBeenUpdated;
        bool isInsideWindow;
        double meanSinr;
        double preambleMeanSinr;
        std::vector<std::pair<double, double>> gamma;
        Time arrivalTime;
        Time duration;
    } essaPacketRxParams_s;

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

    virtual ~SatPhyRxCarrierPerWindow();

    static TypeId GetTypeId(void);

    void BeginEndScheduling();

    inline virtual CarrierType GetCarrierType()
    {
        return CarrierType::RA_ESSA;
    }

    typedef void (*WindowLoadTraceCallback)(double windowLoad);
 
  protected:
    virtual void ReceiveSlot(SatPhyRxCarrier::rxParams_s packetRxParams, const uint32_t nPackets);


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

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

    TracedCallback<double> m_windowLoadTrace;

    virtual void DoDispose();
 
  private:
    typedef std::list<SatPhyRxCarrierPerWindow::essaPacketRxParams_s> packetList_t;
    void AddEssaPacket(SatPhyRxCarrierPerWindow::essaPacketRxParams_s essaPacketParams);

    double CalculateNormalizedOfferedRandomAccessLoad();

    void MeasureRandomAccessLoad();

    void EliminatePreviousInterferences(SatPhyRxCarrierPerWindow::essaPacketRxParams_s& packet);

    void CalculatePacketInterferenceVectors(SatPhyRxCarrierPerWindow::essaPacketRxParams_s& packet);

    void CleanOldPackets(const Time windowStartTime);

    void DoWindowEnd();

    void DoSic(packetList_t::iterator processedPacket,
               std::pair<packetList_t::iterator, packetList_t::iterator> windowBounds);

    double GetEffectiveSnir(const SatPhyRxCarrierPerWindow::essaPacketRxParams_s& packet);

    packetList_t::iterator GetHighestSnirPacket(
        const std::pair<packetList_t::iterator, packetList_t::iterator> windowBounds);

    std::pair<double, double> GetNormalizedPacketInterferenceTime(
        const SatPhyRxCarrierPerWindow::essaPacketRxParams_s& packet,
        const SatPhyRxCarrierPerWindow::essaPacketRxParams_s& interferingPacket);

    std::pair<packetList_t::iterator, packetList_t::iterator> GetWindowBounds(Time startTime,
                                                                              Time endTime);

    bool PacketCanBeDetected(const SatPhyRxCarrierPerWindow::essaPacketRxParams_s& packet);

    void ProcessWindow(Time startTime, Time endTime);

    Time m_windowDuration;

    Time m_windowStep;

    Time m_windowDelay;

    Time m_firstWindow;

    uint32_t m_windowSicIterations;
 
    // TODO: REMOVE!
    uint32_t m_spreadingFactor;

    bool m_windowEndSchedulingInitialized;

    // TODO: find a more appropiate place for this parameter
    double m_detectionThreshold;

    packetList_t m_essaPacketContainer;

    uint32_t m_payloadBytesInWindow;

    uint32_t m_sicEnabled;
};

 
} // namespace ns3
 
#endif /* SATELLITE_PHY_RX_CARRIER_PER_WINDOW_H */