satellite-stats-link-delay-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: Bastien Tauran <bastien.tauran@viveris.fr>
 *
 */
 
#ifndef SATELLITE_STATS_LINK_DELAY_HELPER_H
#define SATELLITE_STATS_LINK_DELAY_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 Time;
class DataCollectionObject;
class DistributionCollector;

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

    virtual ~SatStatsLinkDelayHelper();

    static TypeId GetTypeId();

    void SetAveragingMode(bool averagingMode);

    bool GetAveragingMode() const;

    void InstallProbes();

    void RxLinkDelayCallback(const Time& delay, const Address& from);
 
  protected:
    // inherited from SatStatsHelper base class
    void DoInstall();

    virtual void DoInstallProbes() = 0;

    bool ConnectProbeToCollector(Ptr<Probe> probe, uint32_t identifier);

    bool DisconnectProbeFromCollector(Ptr<Probe> probe, uint32_t identifier);

    void PassSampleToCollector(const Time& delay, uint32_t identifier);

    CollectorMap m_terminalCollectors;

    Ptr<DistributionCollector> m_averagingCollector;

    Ptr<DataCollectionObject> m_aggregator;

    std::map<const Address, uint32_t> m_identifierMap;
 
  private:
    bool m_averagingMode; 
 
}; // end of class SatStatsLinkDelayHelper
 
// FORWARD FEEDER LINK DEV-LEVEL /////////////////////////////////////////////////////

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

    virtual ~SatStatsFwdFeederDevLinkDelayHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsLinkDelayHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsFwdFeederDevLinkDelayHelper
 
// FORWARD USER LINK DEV-LEVEL /////////////////////////////////////////////////////

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

    virtual ~SatStatsFwdUserDevLinkDelayHelper();

    static TypeId GetTypeId();

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

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

    virtual ~SatStatsFwdFeederMacLinkDelayHelper();

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

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

    virtual ~SatStatsFwdUserMacLinkDelayHelper();

    static TypeId GetTypeId();

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

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

    virtual ~SatStatsFwdFeederPhyLinkDelayHelper();

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

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

    virtual ~SatStatsFwdUserPhyLinkDelayHelper();

    static TypeId GetTypeId();

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

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

    virtual ~SatStatsRtnFeederDevLinkDelayHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsLinkDelayHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnFeederDevLinkDelayHelper
 
// RETURN USER LINK DEV-LEVEL //////////////////////////////////////////////

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

    virtual ~SatStatsRtnUserDevLinkDelayHelper();

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

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

    virtual ~SatStatsRtnFeederMacLinkDelayHelper();

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

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

    virtual ~SatStatsRtnUserMacLinkDelayHelper();

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

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

    virtual ~SatStatsRtnFeederPhyLinkDelayHelper();

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

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

    virtual ~SatStatsRtnUserPhyLinkDelayHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsLinkDelayHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnUserPhyLinkDelayHelper
 
} // end of namespace ns3
 
#endif /* SATELLITE_STATS_DELAY_HELPER_H */