satellite-stats-satellite-queue-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_SAT_QUEUE_HELPER_H
#define SATELLITE_STATS_SAT_QUEUE_HELPER_H
 
#include "satellite-stats-helper.h"
 
#include "ns3/callback.h"
#include "ns3/collector-map.h"
#include "ns3/ptr.h"
 
#include <string>
 
namespace ns3
{
 
// BASE CLASS /////////////////////////////////////////////////////////////////
 
class SatHelper;
class Node;
class DataCollectionObject;
class DistributionCollector;

class SatStatsSatelliteQueueHelper : public SatStatsHelper
{
  public:
    typedef enum
    {
        UNIT_BYTES = 0,
        UNIT_NUMBER_OF_PACKETS,
    } UnitType_t;

    static std::string GetUnitTypeName(UnitType_t unitType);
 
    // inherited from SatStatsHelper base class
    SatStatsSatelliteQueueHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsSatelliteQueueHelper();

    static TypeId GetTypeId();

    void SetUnitType(UnitType_t unitType);

    void SetAveragingMode(bool averagingMode);

    void InstallProbes();

    void QueueSizeCallback(uint32_t size, const Address& addr);
 
  protected:
    // inherited from SatStatsHelper base class
    void DoInstall();

    virtual void DoInstallProbes() = 0;

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

    void PassSampleToCollector(uint32_t size, uint32_t identifier);

    CollectorMap m_terminalCollectors;

    Ptr<DataCollectionObject> m_collector;

    Ptr<DataCollectionObject> m_aggregator;

    Ptr<DistributionCollector> m_averagingCollector;
 
  private:
    bool m_averagingMode;     
    UnitType_t m_unitType;    
    std::string m_shortLabel; 
    std::string m_longLabel;  
 
}; // end of class SatStatsLinkSinrHelper
 
// RTN FEEDER QUEUE IN PACKETS ////////////////////////////////////////////////////////

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

    virtual ~SatStatsRtnFeederQueuePacketsHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsLinkSinrHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnFeederQueuePacketsHelper
 
// RTN FEEDER QUEUE IN BYTES ////////////////////////////////////////////////////////

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

    virtual ~SatStatsRtnFeederQueueBytesHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsLinkSinrHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnFeederQueueBytesHelper
 
// FWD USER QUEUE IN PACKETS ////////////////////////////////////////////////////////

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

    virtual ~SatStatsFwdUserQueuePacketsHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsLinkSinrHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsFwdUserQueuePacketsHelper
 
// FWD USER QUEUE IN BYTES ////////////////////////////////////////////////////////

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

    virtual ~SatStatsFwdUserQueueBytesHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsLinkSinrHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsFwdUserQueueBytesHelper
 
} // end of namespace ns3
 
#endif /* SATELLITE_STATS_SAT_QUEUE_HELPER_H */