satellite-stats-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: Budiarto Herman <budiarto.herman@magister.fi>
 *
 */
 
#ifndef SATELLITE_STATS_JITTER_HELPER_H
#define SATELLITE_STATS_JITTER_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 SatStatsJitterHelper : public SatStatsHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsJitterHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsJitterHelper();

    static TypeId GetTypeId();

    void SetAveragingMode(bool averagingMode);

    bool GetAveragingMode() const;

    void InstallProbes();

    void RxJitterCallback(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);

    CollectorMap m_terminalCollectors;

    Ptr<DistributionCollector> m_averagingCollector;

    Ptr<DataCollectionObject> m_aggregator;
 
  private:
    bool m_averagingMode; 
 
}; // end of class SatStatsJitterHelper
 
// FORWARD LINK APPLICATION-LEVEL /////////////////////////////////////////////
 
class Probe;
 
class SatStatsFwdAppJitterHelper : public SatStatsJitterHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsFwdAppJitterHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsFwdAppJitterHelper();

    static TypeId GetTypeId();

    static void RxCallback(Ptr<SatStatsFwdAppJitterHelper> helper,
                           uint32_t identifier,
                           Ptr<const Packet> packet,
                           const Address& from);

    Time GetAndUpdatePreviousDelay(uint32_t identifier, Time newDelay);

    virtual void UpdateIdentifierOnProbes();
 
  protected:
    // inherited from SatStatsFwdAppJitterHelper base class
    void DoInstallProbes();
 
  private:
    std::map<Ptr<Probe>, std::pair<Ptr<Node>, uint32_t>> m_probes;

    std::map<uint32_t, Time> m_previousDelayMap;
 
}; // end of class SatStatsFwdAppJitterHelper
 
// FORWARD LINK DEVICE-LEVEL /////////////////////////////////////////////////////
 
class SatStatsFwdDevJitterHelper : public SatStatsJitterHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsFwdDevJitterHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsFwdDevJitterHelper();

    static TypeId GetTypeId();

    virtual void UpdateIdentifierOnProbes();
 
  protected:
    // inherited from SatStatsJitterHelper base class
    void DoInstallProbes();
 
  private:
    std::map<Ptr<Probe>, std::pair<Ptr<Node>, uint32_t>> m_probes;
 
}; // end of class SatStatsFwdDevJitterHelper
 
// FORWARD LINK MAC-LEVEL /////////////////////////////////////////////////////
 
class SatStatsFwdMacJitterHelper : public SatStatsJitterHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsFwdMacJitterHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsFwdMacJitterHelper();

    static TypeId GetTypeId();

    virtual void UpdateIdentifierOnProbes();
 
  protected:
    // inherited from SatStatsJitterHelper base class
    void DoInstallProbes();
 
  private:
    std::map<Ptr<Probe>, std::pair<Ptr<Node>, uint32_t>> m_probes;
 
}; // end of class SatStatsFwdMacJitterHelper
 
// FORWARD LINK PHY-LEVEL /////////////////////////////////////////////////////
 
class SatStatsFwdPhyJitterHelper : public SatStatsJitterHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsFwdPhyJitterHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsFwdPhyJitterHelper();

    static TypeId GetTypeId();

    virtual void UpdateIdentifierOnProbes();
 
  protected:
    // inherited from SatStatsJitterHelper base class
    void DoInstallProbes();
 
  private:
    std::map<Ptr<Probe>, std::pair<Ptr<Node>, uint32_t>> m_probes;
 
}; // end of class SatStatsFwdPhyJitterHelper
 
// RETURN LINK APPLICATION-LEVEL //////////////////////////////////////////////
 
class SatStatsRtnAppJitterHelper : public SatStatsJitterHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsRtnAppJitterHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsRtnAppJitterHelper();

    static TypeId GetTypeId();

    void RxCallback(Ptr<const Packet> packet, const Address& from);

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

    std::map<const Address, Time> m_previousDelayMap;

 
}; // end of class SatStatsRtnAppJitterHelper
 
// RETURN LINK DEVICE-LEVEL //////////////////////////////////////////////
 
class SatStatsRtnDevJitterHelper : public SatStatsJitterHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsRtnDevJitterHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsRtnDevJitterHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsJitterHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnDevJitterHelper
 
// RETURN LINK MAC-LEVEL //////////////////////////////////////////////
 
class SatStatsRtnMacJitterHelper : public SatStatsJitterHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsRtnMacJitterHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsRtnMacJitterHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsJitterHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnMacJitterHelper
 
// RETURN LINK PHY-LEVEL //////////////////////////////////////////////
 
class SatStatsRtnPhyJitterHelper : public SatStatsJitterHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsRtnPhyJitterHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsRtnPhyJitterHelper();

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