satellite-stats-marsala-correlation-helper.h

Go to the documentation of this file.

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2018 CNES
 *
 * 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: Mathias Ettinger <mettinger@toulouse.viveris.com>
 */
 
#ifndef SATELLITE_STATS_MARSALA_CORRELATION_HELPER_H
#define SATELLITE_STATS_MARSALA_CORRELATION_HELPER_H
 
#include <ns3/address.h>
#include <ns3/collector-map.h>
#include <ns3/ptr.h>
#include <ns3/satellite-phy-rx-carrier.h>
#include <ns3/satellite-stats-helper.h>
 
#include <map>
 
namespace ns3
{
 
// BASE CLASS /////////////////////////////////////////////////////////////////
 
class SatHelper;
class Node;
class DataCollectionObject;
 
class SatStatsMarsalaCorrelationHelper : public SatStatsHelper
{
  public:
    // inherited from SatStatsHelper base class
    SatStatsMarsalaCorrelationHelper(Ptr<const SatHelper> satHelper);
 
    virtual ~SatStatsMarsalaCorrelationHelper();
 
    static TypeId GetTypeId();
 
    void CorrelationRxCallback(uint32_t nPackets, const Address& from, bool isCollided);
 
    std::string GetTraceSourceName() const;
 
    inline SatPhyRxCarrier::CarrierType GetValidCarrierType() const
    {
        return m_carrierType;
    }
 
  protected:
    // inherited from SatStatsHelper base class
    void DoInstall();
 
    void SetTraceSourceName(std::string traceSourceName);
 
    inline void SetValidCarrierType(SatPhyRxCarrier::CarrierType carrierType)
    {
        m_carrierType = carrierType;
    }
 
  private:
    void SaveAddressAndIdentifier(Ptr<Node> utNode);
 
    CollectorMap m_terminalCollectors;
 
    Ptr<DataCollectionObject> m_aggregator;
 
    std::map<const Address, uint32_t> m_identifierMap;
 
    std::string m_traceSourceName;
 
    SatPhyRxCarrier::CarrierType m_carrierType;
 
}; // end of class SatStatsMarsalaCorrelationHelper
 
} // end of namespace ns3
 
#endif /* SATELLITE_STATS_MARSALA_CORRELATION_HELPER_H */