satellite-phy-rx-carrier-conf.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_CONF_H_
#define SATELLITE_PHY_RX_CARRIER_CONF_H_
 
#include "satellite-channel-estimation-error-container.h"
#include "satellite-channel.h"
#include "satellite-link-results.h"
#include "satellite-typedefs.h"
 
#include "ns3/object.h"
 
#include <stdint.h>
 
namespace ns3
{

class SatPhyRxCarrierConf : public Object
{
  public:
    typedef Callback<double> AdditionalInterferenceCallback;

    enum RxMode
    {
        TRANSPARENT,
        NORMAL
    };

    enum ErrorModel
    {
        EM_NONE,
        EM_CONSTANT,
        EM_AVI
    };

    enum InterferenceModel
    {
        IF_PER_PACKET,
        IF_PER_FRAGMENT,
        IF_TRACE,
        IF_CONSTANT
    };

    enum InterferenceEliminationModel
    {
        SIC_NONE,
        SIC_PERFECT,
        SIC_RESIDUAL
    };

    enum RandomAccessCollisionModel
    {
        RA_COLLISION_NOT_DEFINED,
        RA_COLLISION_ALWAYS_DROP_ALL_COLLIDING_PACKETS,
        RA_COLLISION_CHECK_AGAINST_SINR,
        RA_CONSTANT_COLLISION_PROBABILITY
    };

    typedef struct RxCarrierCreateParams_s
    {
        double m_rxTemperatureK;
        double m_extNoiseDensityWhz;
        double m_aciIfWrtNoiseFactor;
        ErrorModel m_errorModel;
        double m_daConstantErrorRate;
        InterferenceModel m_daIfModel;
        InterferenceModel m_raIfModel;
        InterferenceEliminationModel m_raIfEliminateModel;
        RxMode m_rxMode;
        SatEnums::ChannelType_t m_chType;
        SatEnums::RegenerationMode_t m_linkRegenerationMode;
        SatTypedefs::CarrierBandwidthConverter_t m_bwConverter;
        uint32_t m_carrierCount;
        Ptr<SatChannelEstimationErrorContainer> m_cec;
        RandomAccessCollisionModel m_raCollisionModel;
        double m_raConstantErrorRate;
        SatEnums::RandomAccessModel_t m_randomAccessModel;
 
        RxCarrierCreateParams_s()
            : m_rxTemperatureK(0.0),
              m_extNoiseDensityWhz(0.0),
              m_aciIfWrtNoiseFactor(0.0),
              m_errorModel(SatPhyRxCarrierConf::EM_NONE),
              m_daConstantErrorRate(0.0),
              m_daIfModel(SatPhyRxCarrierConf::IF_CONSTANT),
              m_raIfModel(SatPhyRxCarrierConf::IF_CONSTANT),
              m_raIfEliminateModel(SatPhyRxCarrierConf::SIC_PERFECT),
              m_rxMode(SatPhyRxCarrierConf::TRANSPARENT),
              m_chType(SatEnums::RETURN_USER_CH),
              m_linkRegenerationMode(SatEnums::TRANSPARENT),
              m_bwConverter(),
              m_carrierCount(0),
              m_cec(NULL),
              m_raCollisionModel(SatPhyRxCarrierConf::RA_COLLISION_CHECK_AGAINST_SINR),
              m_raConstantErrorRate(0.0),
              m_randomAccessModel(SatEnums::RA_MODEL_OFF)
        {
            // do nothing
        }
    } RxCarrierCreateParams_s;

    SatPhyRxCarrierConf(RxCarrierCreateParams_s params);

    SatPhyRxCarrierConf();

    virtual ~SatPhyRxCarrierConf()
    {
    }

    static TypeId GetTypeId(void);

    virtual void DoDispose();

    void SetLinkResults(Ptr<SatLinkResults> linkResults);

    uint32_t GetCarrierCount() const;

    ErrorModel GetErrorModel() const;

    double GetConstantDaErrorRate() const;

    InterferenceModel GetInterferenceModel(bool isRandomAccessCarrier) const;

    InterferenceEliminationModel GetInterferenceEliminationModel(bool isRandomAccessCarrier) const;

    Ptr<SatLinkResults> GetLinkResults() const;

    double GetCarrierBandwidthHz(uint32_t carrierId,
                                 SatEnums::CarrierBandwidthType_t bandwidthType) const;

    double GetRxTemperatureK() const;

    double GetExtPowerDensityWhz() const;

    double GetRxAciInterferenceWrtNoiseFactor() const;

    RxMode GetRxMode() const;

    SatEnums::ChannelType_t GetChannelType() const;

    SatEnums::RegenerationMode_t GetLinkRegenerationMode() const;

    bool IsIntfOutputTraceEnabled() const;

    inline AdditionalInterferenceCallback GetAdditionalInterferenceCb()
    {
        return m_additionalInterferenceCallback;
    }

    inline void SetAdditionalInterferenceCb(
        AdditionalInterferenceCallback additionalInterferenceCallback)
    {
        m_additionalInterferenceCallback = additionalInterferenceCallback;
    }

    Ptr<SatChannelEstimationErrorContainer> GetChannelEstimatorErrorContainer() const;

    RandomAccessCollisionModel GetRandomAccessCollisionModel() const;

    double GetRandomAccessConstantErrorRate() const;

    uint32_t GetRandomAccessAverageNormalizedOfferedLoadMeasurementWindowSize() const;

    bool IsRandomAccessDynamicLoadControlEnabled() const;
 
    inline SatEnums::RandomAccessModel_t GetRandomAccessModel() const
    {
        return m_randomAccessModel;
    }
 
  private:
    /*
     * Note, that different carriers may be different bandwidth (symbol rate).
     * This might be one place to have the frame configuration as well, so that
     * we can pass the bandwidth information for each carrier. The bandwidth may be needed
     * for at least noise and C/No calculation.
     */
    InterferenceModel m_daIfModel;
    InterferenceModel m_raIfModel;
    InterferenceEliminationModel m_raIfEliminateModel;
    ErrorModel m_errorModel;
    double m_daConstantErrorRate;
    double m_rxTemperatureK;
    double m_rxAciIfWrtNoiseFactor;
    RxMode m_rxMode;
    uint32_t m_carrierCount;
    SatTypedefs::CarrierBandwidthConverter_t m_carrierBandwidthConverter;
    SatEnums::ChannelType_t m_channelType;
    SatEnums::RegenerationMode_t m_linkRegenerationMode;
    Ptr<SatChannelEstimationErrorContainer> m_channelEstimationError;
    AdditionalInterferenceCallback m_additionalInterferenceCallback;
    Ptr<SatLinkResults> m_linkResults;
    double m_rxExtNoiseDensityWhz;
    bool m_enableIntfOutputTrace;
    uint32_t m_randomAccessAverageNormalizedOfferedLoadMeasurementWindowSize;
    RandomAccessCollisionModel m_raCollisionModel;
    double m_raConstantErrorRate;
    bool m_enableRandomAccessDynamicLoadControl;
    SatEnums::RandomAccessModel_t m_randomAccessModel;
};
 
} // namespace ns3
 
#endif /* SATELLITE_PHY_RX_CARRIER_CONF_H_ */