satellite-channel.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: Jani Puttonen <jani.puttonen@magister.fi>
 */
 
#ifndef SATELLITE_CHANNEL_H
#define SATELLITE_CHANNEL_H
 
#include "satellite-enums.h"
#include "satellite-fading-external-input-trace-container.h"
#include "satellite-free-space-loss.h"
#include "satellite-phy-rx-carrier-conf.h"
#include "satellite-phy-rx.h"
#include "satellite-signal-parameters.h"
#include "satellite-typedefs.h"
 
#include "ns3/channel.h"
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/propagation-delay-model.h"
#include "ns3/traced-callback.h"
 
#include <cstddef>
#include <stdint.h>
#include <vector>
 
namespace ns3
{

 
class SatChannel : public Channel
{
  public:
    SatChannel();

    virtual void NotifyConstructionCompleted() override;

    virtual ~SatChannel();

    enum SatChannelFwdMode_e
    {
        ONLY_DEST_NODE,
        ONLY_DEST_BEAM,
        ALL_BEAMS
    };

    static TypeId GetTypeId(void);

    typedef std::vector<Ptr<SatPhyRx>> PhyRxContainer;

    typedef Callback<double, SatEnums::ChannelType_t, uint32_t, uint32_t> CarrierFreqConverter;

    virtual void SetPropagationDelayModel(Ptr<PropagationDelayModel> delay);

    virtual Ptr<PropagationDelayModel> GetPropagationDelayModel();

    virtual void SetChannelType(SatEnums::ChannelType_t chType);

    virtual void SetFrequencyId(uint32_t freqId);

    virtual void SetFrequencyConverter(CarrierFreqConverter converter);

    virtual void SetBandwidthConverter(SatTypedefs::CarrierBandwidthConverter_t converter);

    virtual SatEnums::ChannelType_t GetChannelType();

    virtual void SetFreeSpaceLoss(Ptr<SatFreeSpaceLoss> delay);

    virtual Ptr<SatFreeSpaceLoss> GetFreeSpaceLoss() const;

    virtual void StartTx(Ptr<SatSignalParameters> params);

    virtual void AddRx(Ptr<SatPhyRx> phyRx);

    virtual void RemoveRx(Ptr<SatPhyRx> phyRx);

    virtual std::size_t GetNDevices(void) const;

    virtual Ptr<NetDevice> GetDevice(std::size_t i) const;
 
  private:
    SatChannelFwdMode_e m_fwdMode;

    PhyRxContainer m_phyRxContainer;

    SatEnums::ChannelType_t m_channelType;

    CarrierFreqConverter m_carrierFreqConverter;

    SatTypedefs::CarrierBandwidthConverter_t m_carrierBandwidthConverter;

    uint32_t m_freqId;

    Ptr<PropagationDelayModel> m_propagationDelay;

    Ptr<SatFreeSpaceLoss> m_freeSpaceLoss;

    SatEnums::RxPowerCalculationMode_t m_rxPowerCalculationMode;

    bool m_enableRxPowerOutputTrace;

    bool m_enableFadingOutputTrace;

    bool m_enableExternalFadingInputTrace;

    Ptr<SatFadingExternalInputTraceContainer> m_satFadingExternalInputTraceContainer;

    virtual void DoDispose();

    void ScheduleRx(Ptr<SatSignalParameters> txParams, Ptr<SatPhyRx> phyRx);

    void StartRx(Ptr<SatSignalParameters> rxParams, Ptr<SatPhyRx> phyRx);

    void DoRxPowerOutputTrace(Ptr<SatSignalParameters> rxParams, Ptr<SatPhyRx> phyRx);

    void DoRxPowerInputTrace(Ptr<SatSignalParameters> rxParams, Ptr<SatPhyRx> phyRx);

    void DoRxCnoInputTrace(Ptr<SatSignalParameters> rxParams, Ptr<SatPhyRx> phyRx);

    void DoFadingOutputTrace(Ptr<SatSignalParameters> rxParams,
                             Ptr<SatPhyRx> phyRx,
                             double fadingValue);

    void DoRxPowerCalculation(Ptr<SatSignalParameters> rxParams, Ptr<SatPhyRx> phyRx);

    double GetExternalFadingTrace(Ptr<SatSignalParameters> rxParams, Ptr<SatPhyRx> phyRx);

    Mac48Address GetSourceAddress(Ptr<SatSignalParameters> rxParams);
};
 
} // namespace ns3
 
#endif /* SATELLITE_CHANNEL_H */