satellite-ut-helper.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: Sami Rantanen <sami.rantanen@magister.fi>
 * Author: Mathias Ettinger <mettinger@viveris.toulouse.fr>
 */
 
#ifndef SATELLITE_UT_HELPER_H
#define SATELLITE_UT_HELPER_H
 
#include "ns3/net-device-container.h"
#include "ns3/node-container.h"
#include "ns3/object-factory.h"
#include "ns3/output-stream-wrapper.h"
#include "ns3/satellite-channel.h"
#include "ns3/satellite-link-results.h"
#include "ns3/satellite-mac.h"
#include "ns3/satellite-ncc.h"
#include "ns3/satellite-phy.h"
#include "ns3/satellite-random-access-container-conf.h"
#include "ns3/satellite-random-access-container.h"
#include "ns3/satellite-superframe-sequence.h"
#include "ns3/satellite-typedefs.h"
#include "ns3/traced-callback.h"
 
#include <stdint.h>
#include <string>
 
namespace ns3
{

class SatUtHelper : public Object
{
  public:
    typedef struct
    {
        SatEnums::RandomAccessModel_t m_randomAccessModel;
        SatPhyRxCarrierConf::InterferenceModel m_raInterferenceModel;
        SatPhyRxCarrierConf::InterferenceEliminationModel m_raInterferenceEliminationModel;
        SatPhyRxCarrierConf::RandomAccessCollisionModel m_raCollisionModel;
    } RandomAccessSettings_s;

    static TypeId GetTypeId(void);

    SatUtHelper();

    SatUtHelper(SatTypedefs::CarrierBandwidthConverter_t carrierBandwidthConverter,
                uint32_t rtnLinkCarrierCount,
                Ptr<SatSuperframeSeq> seq,
                SatMac::ReadCtrlMsgCallback readCb,
                SatMac::ReserveCtrlMsgCallback reserveCb,
                SatMac::SendCtrlMsgCallback sendCb,
                RandomAccessSettings_s randomAccessSettings);

    virtual ~SatUtHelper()
    {
    }
 
    /*
     * Initializes the UT helper based on attributes
     * @param lrFwd DVB-S2 or DVB-S2X link results
     */
    void Initialize(Ptr<SatLinkResultsFwd> lrFwd);

    void SetDeviceAttribute(std::string name, const AttributeValue& value);

    void SetChannelAttribute(std::string name, const AttributeValue& value);

    void SetPhyAttribute(std::string name, const AttributeValue& value);

    NetDeviceContainer Install(NodeContainer c,
                               uint32_t satId,
                               uint32_t beamId,
                               Ptr<SatChannel> fCh,
                               Ptr<SatChannel> rCh,
                               Ptr<SatNetDevice> gwNd,
                               Ptr<SatNcc> ncc,
                               Address satUserAddress,
                               SatPhy::ChannelPairGetterCallback cbChannel,
                               SatMac::RoutingUpdateCallback cbRouting);
    virtual Ptr<NetDevice> Install(Ptr<Node> n,
                                   uint32_t satId,
                                   uint32_t beamId,
                                   Ptr<SatChannel> fCh,
                                   Ptr<SatChannel> rCh,
                                   Ptr<SatNetDevice> gwNd,
                                   Ptr<SatNcc> ncc,
                                   Address satUserAddress,
                                   SatPhy::ChannelPairGetterCallback cbChannel,
                                   SatMac::RoutingUpdateCallback cbRouting) = 0;

    void EnableCreationTraces(Ptr<OutputStreamWrapper> stream, CallbackBase& cb);
 
  protected:
    SatTypedefs::CarrierBandwidthConverter_t m_carrierBandwidthConverter;
    uint32_t m_fwdLinkCarrierCount;
    Ptr<SatSuperframeSeq> m_superframeSeq;
 
    // Control message container callbacks
    SatMac::ReadCtrlMsgCallback m_readCtrlCb;
    SatMac::ReserveCtrlMsgCallback m_reserveCtrlCb;
    SatMac::SendCtrlMsgCallback m_sendCtrlCb;
 
    ObjectFactory m_channelFactory;
    ObjectFactory m_deviceFactory;
 
    /*
     * Configured dedicated access interference model for the forward link. Set as an attribute.
     */
    SatPhy::InterferenceModel m_daInterferenceModel;
 
    /*
     * Configured error model for the forward link. Set as an attribute.
     */
    SatPhy::ErrorModel m_errorModel;
 
    /*
     * Constant error rate for dedicated access in the FWD link.
     */
    double m_daConstantErrorRate;
 
    /*
     * Forward channel link results (DVB-S2) are created if ErrorModel
     * is configured to be AVI. Note, that only one instance of the
     * link results is needed for all UTs.
     */
    Ptr<SatLinkResults> m_linkResults;

    TracedCallback<std::string> m_creationTrace;

    Ptr<SatLowerLayerServiceConf> m_llsConf;

    bool m_enableChannelEstimationError;

    bool m_crdsaOnlyForControl;
 
    /*
     * Asynchronous access on the return channel:
     * - true -> asynchronous
     * - false -> synchronous
     */
    bool m_asyncAccess;

    RandomAccessSettings_s m_raSettings;
};
 
} // namespace ns3
 
#endif /* SATELLITE_UT_HELPER_H */