satellite-stats-packet-error-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_PACKET_ERROR_HELPER_H
#define SATELLITE_STATS_PACKET_ERROR_HELPER_H
 
#include "satellite-stats-helper.h"
 
#include "ns3/address.h"
#include "ns3/collector-map.h"
#include "ns3/ptr.h"
#include "ns3/satellite-enums.h"
#include "ns3/satellite-phy-rx-carrier.h"
 
#include <map>
#include <string>
#include <utility>
 
namespace ns3
{
 
// BASE CLASS /////////////////////////////////////////////////////////////////
 
class SatHelper;
class Node;
class DataCollectionObject;
class Probe;

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

    virtual ~SatStatsPacketErrorHelper();

    static TypeId GetTypeId();

    void ErrorRxCallback(uint32_t nPackets, const Address& fromOrTo, bool isError);

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

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

    virtual void UpdateIdentifierOnProbes();

    void SetTraceSourceName(std::string traceSourceName);

    std::string GetTraceSourceName() const;

    void SetChannelType(SatEnums::ChannelType_t channelType);

    SatEnums::ChannelType_t GetChannelType() const;

    inline SatPhyRxCarrier::CarrierType GetValidCarrierType() const
    {
        return m_carrierType;
    }
 
  protected:
    // inherited from SatStatsHelper base class
    void DoInstall();

    inline void SetValidCarrierType(SatPhyRxCarrier::CarrierType carrierType)
    {
        m_carrierType = carrierType;
    }
 
  private:
    void InstallProbeOnGw(Ptr<Node> gwNode);

    void InstallProbeOnSatFeeder(Ptr<Node> satNode);

    void InstallProbeOnSatUser(Ptr<Node> satNode);

    void InstallProbeOnUt(Ptr<Node> utNode);

    std::map<Ptr<Probe>, std::pair<Ptr<Node>, uint32_t>> m_probes;

    CollectorMap m_terminalCollectors;

    Ptr<DataCollectionObject> m_aggregator;

    std::string m_traceSourceName;

    SatEnums::ChannelType_t m_channelType;

    SatPhyRxCarrier::CarrierType m_carrierType;
 
}; // end of class SatStatsPacketErrorHelper
 
// FORWARD FEEDER LINK DEDICATED ACCESS //////////////////////////////////////////////

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

    virtual ~SatStatsFwdFeederDaPacketErrorHelper();

    static TypeId GetTypeId();
};
 
// FORWARD USER LINK DEDICATED ACCESS //////////////////////////////////////////////

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

    virtual ~SatStatsFwdUserDaPacketErrorHelper();

    static TypeId GetTypeId();
};
 
// RETURN FEEDER LINK DEDICATED ACCESS ///////////////////////////////////////////////

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

    virtual ~SatStatsRtnFeederDaPacketErrorHelper();

    static TypeId GetTypeId();
};
 
// RETURN USER LINK DEDICATED ACCESS ///////////////////////////////////////////////

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

    virtual ~SatStatsRtnUserDaPacketErrorHelper();

    static TypeId GetTypeId();
};
 
// FEEDER SLOTTED ALOHA //////////////////////////////////////////////////////////////

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

    virtual ~SatStatsFeederSlottedAlohaPacketErrorHelper();

    static TypeId GetTypeId();
};
 
// USER SLOTTED ALOHA //////////////////////////////////////////////////////////////

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

    virtual ~SatStatsUserSlottedAlohaPacketErrorHelper();

    static TypeId GetTypeId();
};
 
// FEEDER CRDSA //////////////////////////////////////////////////////////////////////

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

    virtual ~SatStatsFeederCrdsaPacketErrorHelper();

    static TypeId GetTypeId();
};
 
// USER CRDSA //////////////////////////////////////////////////////////////////////

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

    virtual ~SatStatsUserCrdsaPacketErrorHelper();

    static TypeId GetTypeId();
};
 
// FEEDER E-SSA //////////////////////////////////////////////////////////////

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

    virtual ~SatStatsFeederEssaPacketErrorHelper();

    static TypeId GetTypeId();
};
 
// USER E-SSA //////////////////////////////////////////////////////////////

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

    virtual ~SatStatsUserEssaPacketErrorHelper();

    static TypeId GetTypeId();
};
 
} // end of namespace ns3
 
#endif /* SATELLITE_STATS_PACKET_ERROR_HELPER_H */