satellite-orbiter-user-phy.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Magister Solutions Ltd.
 *
 * 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: Sami Rantanen <sami.rantanen@magister.fi>
 *         Bastien Tauran <bastien.tauran@viveris.fr>
 */
 
#ifndef SATELLITE_ORBITER_USER_PHY_H
#define SATELLITE_ORBITER_USER_PHY_H
 
#include "satellite-frame-conf.h"
#include "satellite-phy.h"
#include "satellite-signal-parameters.h"
 
#include "ns3/address.h"
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/packet.h"
#include "ns3/ptr.h"
 
#include <queue>
#include <stdint.h>
#include <tuple>
 
namespace ns3
{
 
class SatPhyRxCarrier;
class SatPhyRxCarrierUplink;
class SatPhyRxCarrierPerSlot;
class SatPhyRxCarrierPerFrame;
class SatPhyRxCarrierPerWindow;

class SatOrbiterUserPhy : public SatPhy
{
  public:
    SatOrbiterUserPhy(void);
 
    SatOrbiterUserPhy(SatPhy::CreateParam_t& params,
                      Ptr<SatLinkResults> linkResults,
                      SatPhyRxCarrierConf::RxCarrierCreateParams_s parameters,
                      Ptr<SatSuperframeConf> superFrameConf);

    virtual void NotifyConstructionCompleted() override;

    virtual ~SatOrbiterUserPhy();

    static TypeId GetTypeId(void);
    virtual void DoInitialize(void);

    virtual void DoDispose(void);

    virtual void SendPduWithParams(Ptr<SatSignalParameters> rxParams);

    virtual void Receive(Ptr<SatSignalParameters> rxParams, bool phyError);

    virtual double GetAdditionalInterference();

    typedef void (*QueueSizeCallback)(uint32_t size, const Address& from);

    typedef Callback<bool, Ptr<SatControlMessage>, const Address&, Ptr<SatSignalParameters>>
        SendControlMsgToFeederCallback;

    SatOrbiterUserPhy::SendControlMsgToFeederCallback m_txCtrlFeederCallback;

    void SetSendControlMsgToFeederCallback(SendControlMsgToFeederCallback cb);
 
  protected:
    virtual void RxTraces(SatPhy::PacketContainer_t packets);

    virtual SatEnums::SatLinkDir_t GetSatLinkTxDir();

    virtual SatEnums::SatLinkDir_t GetSatLinkRxDir();

    TracedCallback<uint32_t, const Address&> m_queueSizeBytesTrace;

    TracedCallback<uint32_t, const Address&> m_queueSizePacketsTrace;
 
  private:
    Ptr<SatLinkResults> m_linkResults;

    SatPhyRxCarrierConf::RxCarrierCreateParams_s m_parameters;

    Ptr<SatSuperframeConf> m_superFrameConf;

    void SendFromQueue();

    void EndTx();

    Address GetE2EDestinationAddress(SatPhy::PacketContainer_t packets);

    double m_aciInterferenceCOverIDb;

    double m_otherSysInterferenceCOverIDb;

    double m_aciInterferenceCOverI;

    double m_otherSysInterferenceCOverI;

    SatEnums::RegenerationMode_t m_forwardLinkRegenerationMode;

    SatEnums::RegenerationMode_t m_returnLinkRegenerationMode;

    std::queue<std::tuple<Ptr<SatSignalParameters>, uint32_t, uint32_t>> m_queue;

    uint32_t m_queueSizeBytes;

    uint32_t m_queueSizePackets;

    uint32_t m_queueSizeMax;

    bool m_isSending;
};
 
} // namespace ns3
 
#endif /* SATELLITE_ORBITER_USER_PHY_H */