satellite-stats-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: Budiarto Herman <budiarto.herman@magister.fi>
 *
 */
 
#ifndef SATELLITE_STATS_QUEUE_HELPER_H
#define SATELLITE_STATS_QUEUE_HELPER_H
 
#include "satellite-stats-helper.h"
 
#include "ns3/collector-map.h"
#include "ns3/nstime.h"
#include "ns3/ptr.h"
 
#include <list>
#include <string>
#include <utility>
 
namespace ns3
{
 
// BASE CLASS /////////////////////////////////////////////////////////////////
 
class SatHelper;
class Mac48Address;
class DataCollectionObject;

class SatStatsQueueHelper : 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
    SatStatsQueueHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsQueueHelper();

    static TypeId GetTypeId();

    void SetPollInterval(Time pollInterval);

    Time GetPollInterval() const;

    void SetUnitType(UnitType_t unitType);

    UnitType_t GetUnitType() const;

    void EnlistSource();

    void Poll();
 
  protected:
    // inherited from SatStatsHelper base class
    void DoInstall();

    virtual void DoEnlistSource() = 0;

    virtual void DoPoll() = 0;

    void PushToCollector(uint32_t identifier, uint32_t value);

    CollectorMap m_terminalCollectors;

    Ptr<DataCollectionObject> m_aggregator;
 
  private:
    Time m_pollInterval;      
    UnitType_t m_unitType;    
    std::string m_shortLabel; 
    std::string m_longLabel;  
 
}; // end of class SatStatsQueueHelper
 
// FORWARD LINK ///////////////////////////////////////////////////////////////
 
class SatLlc;

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

    virtual ~SatStatsFwdQueueHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsQueueHelper base class
    void DoEnlistSource();
    void DoPoll();
 
  private:
    typedef std::list<std::pair<Mac48Address, uint32_t>> ListOfUt_t;

    std::list<std::pair<Ptr<SatLlc>, ListOfUt_t>> m_llc;
 
}; // end of class SatStatsFwdQueueHelper

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

    virtual ~SatStatsFwdQueueBytesHelper();

    static TypeId GetTypeId();
 
}; // end of class SatStatsFwdQueueBytesHelper

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

    virtual ~SatStatsFwdQueuePacketsHelper();

    static TypeId GetTypeId();
 
}; // end of class SatStatsFwdQueuePacketsHelper
 
// RETURN LINK ////////////////////////////////////////////////////////////////

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

    virtual ~SatStatsRtnQueueHelper();

    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsQueueHelper base class
    void DoEnlistSource();
    void DoPoll();
 
  private:
    std::list<std::pair<Ptr<SatLlc>, uint32_t>> m_llc;
 
}; // end of class SatStatsRtnQueueHelper

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

    virtual ~SatStatsRtnQueueBytesHelper();

    static TypeId GetTypeId();
 
}; // end of class SatStatsRtnQueueBytesHelper

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

    virtual ~SatStatsRtnQueuePacketsHelper();

    static TypeId GetTypeId();
 
}; // end of class SatStatsRtnQueuePacketsHelper
 
} // end of namespace ns3
 
#endif /* SATELLITE_STATS_QUEUE_HELPER_H */