satellite-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.
 *
 * 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>
 */
 
#ifndef SATELLITE_INTERFERENCE_H
#define SATELLITE_INTERFERENCE_H
 
#include "ns3/mac48-address.h"
#include "ns3/nstime.h"
#include "ns3/object.h"
#include "ns3/simple-ref-count.h"
 
#include <map>
#include <stdint.h>
#include <utility>
#include <vector>
 
namespace ns3
{

class SatInterference : public Object
{
  public:
    class InterferenceChangeEvent : public SimpleRefCount<SatInterference::InterferenceChangeEvent>
    {
      public:
        InterferenceChangeEvent(uint32_t id,
                                Time duration,
                                double rxPower,
                                Address satEarthStationAddress);

        ~InterferenceChangeEvent();

        uint32_t GetId(void) const;

        Time GetDuration(void) const;

        Time GetStartTime(void) const;

        Time GetEndTime(void) const;

        double GetRxPower(void) const;

        Address GetSatEarthStationAddress(void) const;
 
      private:
        Time m_startTime;
        Time m_endTime;
        double m_rxPower;
        uint32_t m_id;
        Address m_satEarthStationAddress;
    };

    static TypeId GetTypeId(void);

    SatInterference();

    ~SatInterference();

    Ptr<SatInterference::InterferenceChangeEvent> Add(Time rxDuration,
                                                      double rxPower,
                                                      Address rxAddress);

    std::vector<std::pair<double, double>> Calculate(
        Ptr<SatInterference::InterferenceChangeEvent> event);

    void Reset(void);

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

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

    virtual bool HasCollision(Ptr<SatInterference::InterferenceChangeEvent> event);
 
  private:
    virtual Ptr<SatInterference::InterferenceChangeEvent> DoAdd(Time rxDuration,
                                                                double rxPower,
                                                                Address rxAddress) = 0;

    virtual std::vector<std::pair<double, double>> DoCalculate(
        Ptr<SatInterference::InterferenceChangeEvent> event) = 0;

    virtual void DoReset(void) = 0;

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

    virtual void DoNotifyRxEnd(Ptr<SatInterference::InterferenceChangeEvent> event) = 0;
 
    SatInterference(const SatInterference& o);
    SatInterference& operator=(const SatInterference& o);

    std::map<Ptr<SatInterference::InterferenceChangeEvent>, bool> m_packetCollisions;

    uint32_t m_currentlyReceiving;
};
 
} // namespace ns3
 
#endif /* SATELLITE_INTERFERENCE_H */