satellite-stats-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_HELPER_H
#define SATELLITE_STATS_HELPER_H
 
#include "ns3/attribute.h"
#include "ns3/net-device-container.h"
#include "ns3/object.h"
#include "ns3/ptr.h"
 
#include <map>
#include <string>
 
namespace ns3
{
 
class SatHelper;
class Node;
class CollectorMap;
class DataCollectionObject;


class SatStatsHelper : public Object
{
  public:
    // COMMON ENUM DATA TYPES ///////////////////////////////////////////////////

    typedef enum
    {
        IDENTIFIER_GLOBAL = 0,
        IDENTIFIER_GW,
        IDENTIFIER_BEAM,
        IDENTIFIER_UT,
        IDENTIFIER_UT_USER,
        IDENTIFIER_SLICE,
        IDENTIFIER_GROUP,
        IDENTIFIER_SAT,
        IDENTIFIER_ISL
    } IdentifierType_t;

    static std::string GetIdentifierTypeName(IdentifierType_t identifierType);

    typedef enum
    {
        OUTPUT_NONE = 0,
        OUTPUT_SCALAR_FILE,
        OUTPUT_SCATTER_FILE,
        OUTPUT_HISTOGRAM_FILE,
        OUTPUT_PDF_FILE, // probability distribution function
        OUTPUT_CDF_FILE, // cumulative distribution function
        OUTPUT_SCALAR_PLOT,
        OUTPUT_SCATTER_PLOT,
        OUTPUT_HISTOGRAM_PLOT,
        OUTPUT_PDF_PLOT, // probability distribution function
        OUTPUT_CDF_PLOT, // cumulative distribution function
    } OutputType_t;

    static std::string GetOutputTypeName(OutputType_t outputType);
 
    // CONSTRUCTOR AND DESTRUCTOR ///////////////////////////////////////////////

    SatStatsHelper(Ptr<const SatHelper> satHelper);

    virtual ~SatStatsHelper();

    static TypeId GetTypeId();
 
    // PUBLIC METHODS ///////////////////////////////////////////////////////////

    void Install();
 
    // SETTER AND GETTER METHODS ////////////////////////////////////////////////

    void SetName(std::string name);

    std::string GetName() const;

    void SetIdentifierType(IdentifierType_t identifierType);

    IdentifierType_t GetIdentifierType() const;

    void SetOutputType(OutputType_t outputType);

    OutputType_t GetOutputType() const;

    bool IsInstalled() const;

    Ptr<const SatHelper> GetSatHelper() const;

    virtual void UpdateAddressAndIdentifier(Ptr<Node> utNode);

    virtual void UpdateIdentifierOnProbes();
 
  protected:
    virtual void DoInstall() = 0;

    virtual std::string GetOutputPath() const;

    virtual std::string GetOutputFileName() const;

    virtual std::string GetIdentifierHeading(std::string dataLabel) const;

    virtual std::string GetTimeHeading(std::string dataLabel) const;

    virtual std::string GetDistributionHeading(std::string dataLabel) const;

    Ptr<DataCollectionObject> CreateAggregator(std::string aggregatorTypeId,
                                               std::string n1 = "",
                                               const AttributeValue& v1 = EmptyAttributeValue(),
                                               std::string n2 = "",
                                               const AttributeValue& v2 = EmptyAttributeValue(),
                                               std::string n3 = "",
                                               const AttributeValue& v3 = EmptyAttributeValue(),
                                               std::string n4 = "",
                                               const AttributeValue& v4 = EmptyAttributeValue(),
                                               std::string n5 = "",
                                               const AttributeValue& v5 = EmptyAttributeValue());

    uint32_t CreateCollectorPerIdentifier(CollectorMap& collectorMap) const;
 
    // IDENTIFIER RELATED METHODS ///////////////////////////////////////////////

    uint32_t GetUtUserId(Ptr<Node> utUserNode) const;

    uint32_t GetUtId(Ptr<Node> utNode) const;

    uint32_t GetGwId(Ptr<Node> gwNode) const;

    uint32_t GetSatId(Ptr<Node> satNode) const;

    uint32_t GetIdentifierForUtUser(Ptr<Node> utUserNode) const;

    uint32_t GetIdentifierForUt(Ptr<Node> utNode) const;

    uint32_t GetIdentifierForBeam(uint32_t satId, uint32_t beamId) const;

    uint32_t GetIdentifierForGroup(uint32_t groupId) const;

    uint32_t GetIdentifierForGw(Ptr<Node> gwNode) const;

    uint32_t GetIdentifierForSat(Ptr<Node> satNode) const;

    uint32_t GetIdentifierForIsl(Ptr<Node> satNodeSrc, Ptr<Node> satNodeDst) const;
 
    // DEVICE RETRIEVAL METHODS /////////////////////////////////////////////////

    static NetDeviceContainer GetGwSatNetDevice(Ptr<Node> gwNode);

    static Ptr<NetDevice> GetUtSatNetDevice(Ptr<Node> utNode);

    static Ptr<NetDevice> GetSatSatOrbiterNetDevice(Ptr<Node> satNode);

    virtual void SaveAddressAndIdentifier(Ptr<Node> utNode);

    std::map<const Address, uint32_t> m_identifierMap;
 
  private:
    std::string m_name;                
    IdentifierType_t m_identifierType; 
    OutputType_t m_outputType;         
    bool m_isInstalled;                
    Ptr<const SatHelper> m_satHelper;  
 
}; // end of class SatStatsHelper
 
} // end of namespace ns3
 
#endif /* SATELLITE_STATS_HELPER_H */