satellite-phy-rx.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_H
#define SATELLITE_PHY_RX_H
 
#include "satellite-antenna-gain-pattern.h"
#include "satellite-base-fading.h"
#include "satellite-frame-conf.h"
#include "satellite-mobility-model.h"
#include "satellite-net-device.h"
#include "satellite-signal-parameters.h"
 
#include "ns3/mobility-model.h"
#include "ns3/nstime.h"
#include "ns3/packet.h"
 
#include <stdint.h>
#include <vector>
 
namespace ns3
{
 
class SatPhyRxCarrierConf;
class SatPhyRxCarrier;
class SatPhyRxCarrierPerSlot;
class SatPhyRxCarrierPerFrame;
class SatPhyRxCarrierPerWindow;
class SatPhyRxCarrierUplink;

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

    virtual ~SatPhyRx();

    static TypeId GetTypeId(void);

    virtual void DoDispose();
 
    void SetMobility(Ptr<MobilityModel> m);
    Ptr<MobilityModel> GetMobility();
 
    /*
     * Set the receive antenna gain pattern.
     * @param agp antenna gain pattern
     * @param mobility mobility model of satellite
     */
    void SetAntennaGainPattern(Ptr<SatAntennaGainPattern> agp, Ptr<SatMobilityModel> mobility);
 
    void SetDevice(Ptr<NetDevice> d);
    Ptr<NetDevice> GetDevice();

    void SetMaxAntennaGain_Db(double gain_Db);

    double GetAntennaGain(Ptr<MobilityModel> mobility);

    void SetDefaultFadingValue(double fadingValue);

    double GetFadingValue(Address macAddress, SatEnums::ChannelType_t channelType);

    void SetFadingContainer(Ptr<SatBaseFading> fadingContainer);

    void SetAntennaLoss_Db(double loss_Db);

    double GetLosses();

    void SetSatId(uint32_t satId);

    uint32_t GetSatId() const;

    void SetBeamId(uint32_t beamId);

    uint32_t GetBeamId() const;

    void ConfigurePhyRxCarriers(Ptr<SatPhyRxCarrierConf> carrierConf,
                                Ptr<SatSuperframeConf> superFrameConf);

    virtual void StartRx(Ptr<SatSignalParameters> rxParams);

    typedef Callback<void, Ptr<SatSignalParameters>, bool> ReceiveCallback;

    typedef Callback<void, uint32_t, uint32_t, Address, Address, double, bool> CnoCallback;

    typedef Callback<void, uint32_t, uint32_t, uint32_t, uint8_t, double>
        AverageNormalizedOfferedLoadCallback;

    void SetReceiveCallback(SatPhyRx::ReceiveCallback cb);

    void SetCnoCallback(SatPhyRx::CnoCallback cb);

    void SetAverageNormalizedOfferedLoadCallback(SatPhyRx::AverageNormalizedOfferedLoadCallback cb);

    Mac48Address GetAddress() const;

    void SetNodeInfo(const Ptr<SatNodeInfo> nodeInfo);

    void BeginEndScheduling();

    double GetRxTemperatureK(Ptr<SatSignalParameters> rxParams);
 
  private:
    Ptr<MobilityModel> m_mobility;
    Ptr<NetDevice> m_device;
 
    uint32_t m_satId;
    uint32_t m_beamId;
    Mac48Address m_macAddress;
 
    /*
     * Receive antenna gain pattern
     */
    Ptr<SatAntennaGainPattern> m_antennaGainPattern;
 
    /*
     * Satellite mobility model
     */
    Ptr<SatMobilityModel> m_satMobility;

    double m_maxAntennaGain;

    double m_antennaLoss;
 
    // A SatPhyRxCarrier object for receiving packets from each carrier
    std::vector<Ptr<SatPhyRxCarrier>> m_rxCarriers;

    Ptr<SatBaseFading> m_fadingContainer;

    double m_defaultFadingValue;
};
 
} // namespace ns3
 
#endif /* SATELLITE_PHY_RX_H */