/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2011,2012 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
 *
 * 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: Nicola Baldo <nbaldo@cttc.es>
 */


#ifndef LTE_GLOBAL_PATHLOSS_DATABASE_H
#define LTE_GLOBAL_PATHLOSS_DATABASE_H

#include <ns3/log.h>
#include <ns3/ptr.h>
#include <string>
#include <map>

namespace ns3 {

class SpectrumPhy;

/**
 * \ingroup lte
 *
 * Store the last pathloss value for each TX-RX pair. This is an
 * example of how the PathlossTrace (provided by some SpectrumChannel
 * implementations) work. 
 * 
 */
class LteGlobalPathlossDatabase
{
public:

  virtual ~LteGlobalPathlossDatabase (void);

  /** 
   * update the pathloss value
   * 
   * \param context 
   * \param txPhy the transmitting PHY
   * \param rxPhy the receiving PHY
   * \param lossDb the loss in dB
   */
  virtual void UpdatePathloss (std::string context, Ptr<SpectrumPhy> txPhy, Ptr<SpectrumPhy> rxPhy, double lossDb) = 0;

  /** 
   * 
   * 
   * \param cellId the id of the eNB
   * \param imsi the id of the UE
   * 
   * \return the pathloss value bewteen the UE and the eNB
   */
  double GetPathloss (uint16_t cellId, uint64_t imsi);

  /** 
   * print the stored pathloss values to standard output
   * 
   */
  void Print ();

protected:
  /**
   * List of the last pathloss value for each UE by CellId.
   * ( CELL ID,  ( IMSI,PATHLOSS ))
   */
  std::map<uint16_t, std::map<uint64_t, double> > m_pathlossMap;
};

/**
 * \ingroup lte
 * Store the last pathloss value for each TX-RX pair for downlink
 */
class DownlinkLteGlobalPathlossDatabase : public LteGlobalPathlossDatabase
{
public:
  // inherited from LteGlobalPathlossDatabase
  virtual void UpdatePathloss (std::string context, Ptr<SpectrumPhy> txPhy, Ptr<SpectrumPhy> rxPhy, double lossDb);
};

/**
 * \ingroup lte
 * Store the last pathloss value for each TX-RX pair for uplink
 */
class UplinkLteGlobalPathlossDatabase : public LteGlobalPathlossDatabase
{
public:
  // inherited from LteGlobalPathlossDatabase
  virtual void UpdatePathloss (std::string context, Ptr<SpectrumPhy> txPhy, Ptr<SpectrumPhy> rxPhy, double lossDb);
};


} // namespace ns3




#endif // LTE_GLOBAL_PATHLOSS_DATABASE_H
