satellite-cno-estimator.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014 Magister Solutions Ltd
 *
 * 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: Sami Rantanen <sami.rantanen@magister.fi>
 */
 
#ifndef SAT_CNO_ESTIMATOR
#define SAT_CNO_ESTIMATOR
 
#include "satellite-cno-estimator.h"
 
#include "ns3/nstime.h"
#include "ns3/simple-ref-count.h"
 
#include <cmath>
#include <map>
#include <utility>
 
namespace ns3
{

class SatCnoEstimator : public SimpleRefCount<SatCnoEstimator>
{
  public:
    typedef enum
    {
        LAST,    
        MINIMUM, 
        AVERAGE  
    } EstimationMode_t;

    SatCnoEstimator();

    virtual ~SatCnoEstimator();

    void AddSample(double cno);

    double GetCnoEstimation();
 
  private:
    virtual void DoAddSample(double cno) = 0;

    virtual double DoGetCnoEstimation() = 0;
};

class SatBasicCnoEstimator : public SatCnoEstimator
{
  public:
    static inline double AddToSum(double currentSum, const std::pair<Time, double>& sample)
    {
        double newSum = currentSum;
 
        if (!std::isnan(sample.second))
        {
            newSum += sample.second;
        }
 
        return newSum;
    }

    SatBasicCnoEstimator();

    SatBasicCnoEstimator(SatCnoEstimator::EstimationMode_t mode, Time window);

    ~SatBasicCnoEstimator();
 
  private:
    typedef std::map<Time, double> SampleMap_t;
 
    SampleMap_t m_samples;
    Time m_window;
    EstimationMode_t m_mode;

    virtual void DoAddSample(double cno);

    virtual double DoGetCnoEstimation();

    void ClearOutdatedSamples();
};
 
} // namespace ns3
 
#endif /* SAT_CNO_ESTIMATOR */