satellite-stats-composite-sinr-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_COMPOSITE_SINR_HELPER_H
#define SATELLITE_STATS_COMPOSITE_SINR_HELPER_H
 
#include "satellite-stats-helper.h"
 
#include "ns3/address.h"
#include "ns3/collector-map.h"
#include "ns3/ptr.h"
 
#include <list>
#include <map>
#include <utility>
 
namespace ns3
{
 
// BASE CLASS /////////////////////////////////////////////////////////////////
 
class SatHelper;
class Node;
class DataCollectionObject;

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

    virtual ~SatStatsCompositeSinrHelper();

    static TypeId GetTypeId();

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

    virtual void DoInstallProbes() = 0;

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

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

    CollectorMap m_terminalCollectors;

    Ptr<DataCollectionObject> m_aggregator;
 
}; // end of class SatStatsCompositeSinrHelper
 
// FORWARD LINK ///////////////////////////////////////////////////////////////
 
class Probe;

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

    virtual ~SatStatsFwdCompositeSinrHelper();

    static TypeId GetTypeId();

    virtual void UpdateIdentifierOnProbes();
 
  protected:
    // inherited from SatStatsCompositeSinrHelper base class
    void DoInstallProbes();
 
  private:
    std::map<Ptr<Probe>, std::pair<Ptr<Node>, uint32_t>> m_probes;
 
}; // end of class SatStatsFwdCompositeSinrHelper
 
// RETURN LINK ////////////////////////////////////////////////////////////////

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

    virtual ~SatStatsRtnCompositeSinrHelper();

    static TypeId GetTypeId();

    void SinrCallback(double sinrDb, const Address& from);
 
  protected:
    // inherited from SatStatsCompositeSinrHelper base class
    void DoInstallProbes();
 
  private:
}; // end of class SatStatsRtnCompositeSinrHelper
 
} // end of namespace ns3
 
#endif /* SATELLITE_STATS_COMPOSITE_SINR_HELPER_H */