satellite-stats-link-modcod-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_LINK_MODCOD_HELPER_H
#define SATELLITE_STATS_LINK_MODCOD_HELPER_H
 
#include <ns3/address.h>
#include <ns3/collector-map.h>
#include <ns3/ptr.h>
#include <ns3/satellite-stats-helper.h>
 
#include <list>
#include <map>
 
namespace ns3
{
 
// BASE CLASS /////////////////////////////////////////////////////////////////
 
class SatHelper;
class Node;
class Time;
class DataCollectionObject;
class DistributionCollector;
 
class SatStatsLinkModcodHelper : public SatStatsHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsLinkModcodHelper(Ptr<const SatHelper> satHelper);
 
    virtual ~SatStatsLinkModcodHelper();
 
    static TypeId GetTypeId();
 
    void SetAveragingMode(bool averagingMode);
 
    bool GetAveragingMode() const;
 
    void InstallProbes();
 
    void RxLinkModcodCallback(uint32_t modcod, const Address& from);
 
  protected:
    // inherited from SatStatsHelper base class
    void DoInstall();
 
    virtual void DoInstallProbes() = 0;
 
    void SaveAddressAndIdentifier(Ptr<Node> utNode);
 
    bool ConnectProbeToCollector(Ptr<Probe> probe, uint32_t identifier);
 
    void PassSampleToCollector(uint32_t modcod, uint32_t identifier);
 
    CollectorMap m_terminalCollectors;
 
    Ptr<DistributionCollector> m_averagingCollector;
 
    Ptr<DataCollectionObject> m_aggregator;
 
    std::map<const Address, uint32_t> m_identifierMap;
 
  private:
    bool m_averagingMode; 
 
}; // end of class SatStatsLinkModcodHelper
 
// FORWARD FEEDER LINK /////////////////////////////////////////////////////
 
class SatStatsFwdFeederLinkModcodHelper : public SatStatsLinkModcodHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsFwdFeederLinkModcodHelper(Ptr<const SatHelper> satHelper);
 
    virtual ~SatStatsFwdFeederLinkModcodHelper();
 
    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsLinkModcodHelper base class
    void DoInstallProbes();
 
  private:
    std::list<Ptr<Probe>> m_probes;
 
}; // end of class SatStatsFwdFeederLinkModcodHelper
 
// FORWARD USER LINK /////////////////////////////////////////////////////
 
class SatStatsFwdUserLinkModcodHelper : public SatStatsLinkModcodHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsFwdUserLinkModcodHelper(Ptr<const SatHelper> satHelper);
 
    virtual ~SatStatsFwdUserLinkModcodHelper();
 
    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsLinkModcodHelper base class
    void DoInstallProbes();
 
  private:
    std::list<Ptr<Probe>> m_probes;
 
}; // end of class SatStatsFwdUserLinkModcodHelper
 
// RETURN FEEDER LINK //////////////////////////////////////////////
 
class SatStatsRtnFeederLinkModcodHelper : public SatStatsLinkModcodHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsRtnFeederLinkModcodHelper(Ptr<const SatHelper> satHelper);
 
    virtual ~SatStatsRtnFeederLinkModcodHelper();
 
    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsLinkModcodHelper base class
    void DoInstallProbes();
 
}; // end of class SatStatsRtnFeederLinkModcodHelper
 
// RETURN USER LINK //////////////////////////////////////////////
 
class SatStatsRtnUserLinkModcodHelper : public SatStatsLinkModcodHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsRtnUserLinkModcodHelper(Ptr<const SatHelper> satHelper);
 
    virtual ~SatStatsRtnUserLinkModcodHelper();
 
    static TypeId GetTypeId();
 
  protected:
    // inherited from SatStatsLinkModcodHelper base class
    void DoInstallProbes();
 
  private:
    std::list<Ptr<Probe>> m_probes;
 
}; // end of class SatStatsRtnUserLinkModcodHelper
 
} // end of namespace ns3
 
#endif /* SATELLITE_STATS_LINK_MODCOD_HELPER_H */