satellite-stats-frame-load-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_FRAME_LOAD_HELPER_H
#define SATELLITE_STATS_FRAME_LOAD_HELPER_H
 
#include "satellite-stats-helper.h"
 
#include "ns3/collector-map.h"
#include "ns3/ptr.h"
 
#include <list>
#include <map>
#include <sstream>
#include <string>
 
namespace ns3
{
 
// BASE CLASS /////////////////////////////////////////////////////////////////
 
class SatHelper;
class DataCollectionObject;
class ScalarCollector;

class SatStatsFrameLoadHelper : public SatStatsHelper
{
  public:
    typedef enum
    {
        UNIT_SYMBOLS = 0,
        UNIT_USERS,
    } UnitType_t;

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

    virtual ~SatStatsFrameLoadHelper();

    static TypeId GetTypeId();

    void SetUnitType(UnitType_t unitType);

    UnitType_t GetUnitType() const;
 
  protected:
    // inherited from SatStatsHelper base class
    void DoInstall();
    std::string GetIdentifierHeading(std::string dataLabel) const;
 
  private:
    template <typename P, typename V>
    bool SetupProbe(Ptr<Object> object,
                    uint32_t identifier,
                    void (SatStatsFrameLoadHelper::*traceSink)(std::string, uint32_t, V));

    void FrameSymbolLoadCallback(std::string context, uint32_t frameId, double loadRatio);

    void FrameUserLoadCallback(std::string context, uint32_t frameId, uint32_t utCount);

    Ptr<ScalarCollector> GetCollector(uint32_t frameId, std::string identifier);
 
    UnitType_t m_unitType;               
    std::string m_shortLabel;            
    std::string m_longLabel;             
    std::string m_objectTraceSourceName; 
    std::string m_probeTraceSourceName;  

    std::list<Ptr<Probe>> m_probes;

    std::map<uint32_t, CollectorMap> m_collectors;

    Ptr<DataCollectionObject> m_aggregator;
 
}; // end of class SatStatsFrameLoadHelper
 
template <typename P, typename V>
bool
SatStatsFrameLoadHelper::SetupProbe(Ptr<Object> object,
                                    uint32_t identifier,
                                    void (SatStatsFrameLoadHelper::*traceSink)(std::string,
                                                                               uint32_t,
                                                                               V))
{
    std::ostringstream oss;
    oss << identifier;
 
    Ptr<P> probe = CreateObject<P>();
    if (!probe->GetInstanceTypeId().IsChildOf(TypeId::LookupByName("ns3::Probe")))
    {
        NS_FATAL_ERROR("The specified type is not a probe.");
    }
 
    // Connect the object to the probe and then to the callback.
    if (probe->ConnectByObject(m_objectTraceSourceName, object) &&
        probe->TraceConnect(m_probeTraceSourceName, oss.str(), MakeCallback(traceSink, this)))
    {
        m_probes.push_back(probe->template GetObject<Probe>());
        return true;
    }
    else
    {
        return false;
    }
}
 
// IN SYMBOL UNIT /////////////////////////////////////////////////////////////

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

    virtual ~SatStatsFrameSymbolLoadHelper();

    static TypeId GetTypeId();
 
}; // end of class SatStatsFrameSymbolLoadHelper
 
// IN USER UNIT ///////////////////////////////////////////////////////////////

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

    virtual ~SatStatsFrameUserLoadHelper();

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