satellite-per-packet-interference.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_PER_PACKET_INTERFERENCE_H
#define SATELLITE_PER_PACKET_INTERFERENCE_H
 
#include "satellite-enums.h"
#include "satellite-interference-output-trace-container.h"
#include "satellite-interference.h"
 
#include <map>
#include <set>
#include <stdint.h>
#include <tuple>
#include <utility>
#include <vector>
 
namespace ns3
{

class SatPerPacketInterference : public SatInterference
{
  public:
    static TypeId GetTypeId(void);

    SatPerPacketInterference();

    SatPerPacketInterference(SatEnums::ChannelType_t channelType, double rxBandwidthHz);

    ~SatPerPacketInterference();

    void DoDispose();

    void SetRxBandwidth(double rxBandwidth);
 
  protected:
    virtual std::vector<std::pair<double, double>> DoCalculate(
        Ptr<SatInterference::InterferenceChangeEvent> event);

    virtual void onOwnStartReached(double ifPowerW);

    virtual void onInterferentEvent(long double timeRatio,
                                    double interferenceValue,
                                    double& ifPowerW);
 
  private:
    virtual Ptr<SatInterference::InterferenceChangeEvent> DoAdd(Time rxDuration,
                                                                double rxPower,
                                                                Address rxAddress);

    virtual void DoReset(void);

    virtual void DoNotifyRxStart(Ptr<SatInterference::InterferenceChangeEvent> event);

    virtual void DoNotifyRxEnd(Ptr<SatInterference::InterferenceChangeEvent> event);

    typedef std::tuple<uint32_t, long double, bool> InterferenceChange;

    typedef std::multimap<Time, InterferenceChange> InterferenceChanges;

    SatPerPacketInterference(const SatPerPacketInterference& o);

    SatPerPacketInterference& operator=(const SatPerPacketInterference& o);

    InterferenceChanges m_interferenceChanges;

    std::set<uint32_t> m_rxEventIds;

    long double m_residualPowerW;

    bool m_rxing;

    uint32_t m_nextEventId;

    bool m_enableTraceOutput;

    SatEnums::ChannelType_t m_channelType;

    double m_rxBandwidth_Hz;
};
 
} // namespace ns3
 
#endif /* SATELLITE_PER_PACKET_INTERFERENCE_H */