satellite-stats-throughput-helper.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014 Magister Solutions
 *
 * 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: Budiarto Herman <budiarto.herman@magister.fi>
 *
 */
 
#ifndef SATELLITE_STATS_THROUGHPUT_HELPER_H
#define SATELLITE_STATS_THROUGHPUT_HELPER_H
 
#include "satellite-stats-helper.h"
 
#include "ns3/address.h"
#include "ns3/collector-map.h"
#include "ns3/ptr.h"
 
#include <list>
#include <map>
#include <utility>
 
namespace ns3
{
 
// BASE CLASS /////////////////////////////////////////////////////////////////
 
class SatHelper;
class Node;
class Packet;
class DataCollectionObject;
class DistributionCollector;

class SatStatsThroughputHelper : public SatStatsHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsThroughputHelper();

    static TypeId GetTypeId();

    void SetAveragingMode(bool averagingMode);

    bool GetAveragingMode() const;

    void InstallProbes();

    void RxCallback(Ptr<const Packet> packet, const Address& from);
 
  protected:
    // inherited from SatStatsHelper base class
    void DoInstall();

    virtual void DoInstallProbes() = 0;

    CollectorMap m_conversionCollectors;

    CollectorMap m_terminalCollectors;

    Ptr<DistributionCollector> m_averagingCollector;

    Ptr<DataCollectionObject> m_aggregator;
 
  private:
    bool m_averagingMode; 
 
}; // end of class SatStatsThroughputHelper
 
// FORWARD LINK APPLICATION-LEVEL /////////////////////////////////////////////
 
class Probe;

class SatStatsFwdAppThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsFwdAppThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsFwdAppThroughputHelper();

    static TypeId GetTypeId();

    virtual void UpdateIdentifierOnProbes();
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
  private:
    std::map<Ptr<Probe>, std::pair<Ptr<Node>, uint32_t>> m_probes;
 
}; // end of class SatStatsFwdAppThroughputHelper
 
// FORWARD FEEDER LINK DEVICE-LEVEL //////////////////////////////////////////////////

class SatStatsFwdFeederDevThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsFwdFeederDevThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsFwdFeederDevThroughputHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsFwdFeederDevThroughputHelper
 
// FORWARD USER LINK DEVICE-LEVEL //////////////////////////////////////////////////

class SatStatsFwdUserDevThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsFwdUserDevThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsFwdUserDevThroughputHelper();

    static TypeId GetTypeId();

    virtual void UpdateIdentifierOnProbes();
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
  private:
    std::map<Ptr<Probe>, std::pair<Ptr<Node>, uint32_t>> m_probes;
 
}; // end of class SatStatsFwdUserDevThroughputHelper
 
// FORWARD FEEDER LINK MAC-LEVEL /////////////////////////////////////////////////////

class SatStatsFwdFeederMacThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsFwdFeederMacThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsFwdFeederMacThroughputHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsFwdFeederMacThroughputHelper
 
// FORWARD USER LINK MAC-LEVEL /////////////////////////////////////////////////////

class SatStatsFwdUserMacThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsFwdUserMacThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsFwdUserMacThroughputHelper();

    static TypeId GetTypeId();

    virtual void UpdateIdentifierOnProbes();
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
  private:
    std::map<Ptr<Probe>, std::pair<Ptr<Node>, uint32_t>> m_probes;
 
}; // end of class SatStatsFwdUserMacThroughputHelper
 
// FORWARD FEEDER LINK PHY-LEVEL /////////////////////////////////////////////////////

class SatStatsFwdFeederPhyThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsFwdFeederPhyThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsFwdFeederPhyThroughputHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsFwdFeederPhyThroughputHelper
 
// FORWARD USER LINK PHY-LEVEL /////////////////////////////////////////////////////

class SatStatsFwdUserPhyThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsFwdUserPhyThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsFwdUserPhyThroughputHelper();

    static TypeId GetTypeId();

    virtual void UpdateIdentifierOnProbes();
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
  private:
    std::map<Ptr<Probe>, std::pair<Ptr<Node>, uint32_t>> m_probes;
 
}; // end of class SatStatsFwdUserPhyThroughputHelper
 
// RETURN LINK APPLICATION-LEVEL //////////////////////////////////////////////

class SatStatsRtnAppThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsRtnAppThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsRtnAppThroughputHelper();

    static TypeId GetTypeId();

    void Ipv4Callback(Ptr<const Packet> packet, const Address& from);
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
  private:
    void SaveIpv4AddressAndIdentifier(Ptr<Node> utUserNode);

 
}; // end of class SatStatsRtnAppThroughputHelper
 
// RETURN FEEDER LINK DEVICE-LEVEL ///////////////////////////////////////////////////

class SatStatsRtnFeederDevThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsRtnFeederDevThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsRtnFeederDevThroughputHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnFeederDevThroughputHelper
 
// RETURN USER LINK DEVICE-LEVEL ///////////////////////////////////////////////////

class SatStatsRtnUserDevThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsRtnUserDevThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsRtnUserDevThroughputHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnUserDevThroughputHelper
 
// RETURN FEEDER LINK MAC-LEVEL //////////////////////////////////////////////////////

class SatStatsRtnFeederMacThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsRtnFeederMacThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsRtnFeederMacThroughputHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnFeederMacThroughputHelper
 
// RETURN USER LINK MAC-LEVEL //////////////////////////////////////////////////////

class SatStatsRtnUserMacThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsRtnUserMacThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsRtnUserMacThroughputHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnUserMacThroughputHelper
 
// RETURN FEEDER LINK PHY-LEVEL //////////////////////////////////////////////////////

class SatStatsRtnFeederPhyThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsRtnFeederPhyThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsRtnFeederPhyThroughputHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnFeederPhyThroughputHelper
 
// RETURN USER LINK PHY-LEVEL //////////////////////////////////////////////////////

class SatStatsRtnUserPhyThroughputHelper : public SatStatsThroughputHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsRtnUserPhyThroughputHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsRtnUserPhyThroughputHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsThroughputHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnUserPhyThroughputHelper
 
} // end of namespace ns3
 
#endif /* SATELLITE_STATS_THROUGHPUT_HELPER_H */