satellite-stats-link-jitter-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_JITTER_HELPER_H
#define SATELLITE_STATS_LINK_JITTER_HELPER_H
 
#include "satellite-stats-helper.h"
 
#include "ns3/address.h"
#include "ns3/collector-map.h"
#include "ns3/ptr.h"
#include "ns3/satellite-enums.h"
 
#include <list>
#include <map>
#include <utility>
 
namespace ns3
{
 
// BASE CLASS /////////////////////////////////////////////////////////////////
 
class SatHelper;
class Node;
class Time;
class DataCollectionObject;
class DistributionCollector;

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

    virtual ~SatStatsLinkJitterHelper();

    static TypeId GetTypeId();

    void SetAveragingMode(bool averagingMode);

    bool GetAveragingMode() const;

    void InstallProbes();

    void RxLinkJitterCallback(const Time& jitter, 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& jitter, uint32_t identifier);

    void SetChannelLink(SatEnums::ChannelType_t channelLink);

    CollectorMap m_terminalCollectors;

    Ptr<DistributionCollector> m_averagingCollector;

    Ptr<DataCollectionObject> m_aggregator;
 
  private:
    bool m_averagingMode; 
 
    SatEnums::ChannelType_t m_channelLink; 
 
}; // end of class SatStatsLinkJitterHelper
 
// FORWARD FEEDER LINK DEV-LEVEL /////////////////////////////////////////////////////

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

    virtual ~SatStatsFwdFeederDevLinkJitterHelper();

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

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

    virtual ~SatStatsFwdUserDevLinkJitterHelper();

    static TypeId GetTypeId();

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

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

    virtual ~SatStatsFwdFeederMacLinkJitterHelper();

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

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

    virtual ~SatStatsFwdUserMacLinkJitterHelper();

    static TypeId GetTypeId();

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

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

    virtual ~SatStatsFwdFeederPhyLinkJitterHelper();

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

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

    virtual ~SatStatsFwdUserPhyLinkJitterHelper();

    static TypeId GetTypeId();

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

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

    virtual ~SatStatsRtnFeederDevLinkJitterHelper();

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

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

    virtual ~SatStatsRtnUserDevLinkJitterHelper();

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

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

    virtual ~SatStatsRtnFeederMacLinkJitterHelper();

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

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

    virtual ~SatStatsRtnUserMacLinkJitterHelper();

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

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

    virtual ~SatStatsRtnFeederPhyLinkJitterHelper();

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

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

    virtual ~SatStatsRtnUserPhyLinkJitterHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsLinkJitterHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnUserPhyLinkJitterHelper
 
} // end of namespace ns3
 
#endif /* SATELLITE_STATS_JITTER_HELPER_H */