lte-ffr-algorithm.h

Go to the documentation of this file.

/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2014 Piotr Gawlowicz
 *
 * 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: Piotr Gawlowicz <gawlowicz.p@gmail.com>
 *
 */

#ifndef LTE_FFR_ALGORITHM_H
#define LTE_FFR_ALGORITHM_H

#include <ns3/object.h>
#include <ns3/lte-rrc-sap.h>
#include <ns3/epc-x2-sap.h>
#include <ns3/ff-mac-sched-sap.h>
#include <map>

namespace ns3 {

class LteFfrSapUser;
class LteFfrSapProvider;

class LteFfrRrcSapUser;
class LteFfrRrcSapProvider;

class LteFfrAlgorithm : public Object
{
public:
  LteFfrAlgorithm ();
  virtual ~LteFfrAlgorithm ();

  // inherited from Object
  static TypeId GetTypeId ();

  virtual void SetLteFfrSapUser (LteFfrSapUser* s) = 0;

  virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser* s) = 0;

  virtual LteFfrSapProvider* GetLteFfrSapProvider () = 0;

  virtual LteFfrRrcSapProvider* GetLteFfrRrcSapProvider () = 0;

  uint8_t GetUlBandwidth () const;

  void SetUlBandwidth (uint8_t bw);

  uint8_t GetDlBandwidth () const;

  void SetDlBandwidth (uint8_t bw);

  void SetFrCellTypeId (uint8_t cellTypeId);

  uint8_t GetFrCellTypeId () const;

protected:

  // inherited from Object
  virtual void DoDispose ();

  virtual void Reconfigure () = 0;

  // FFR SAP PROVIDER IMPLEMENTATION

  virtual std::vector <bool> DoGetAvailableDlRbg () = 0;

  virtual bool DoIsDlRbgAvailableForUe (int rbId, uint16_t rnti) = 0;

  virtual std::vector <bool> DoGetAvailableUlRbg () = 0;

  virtual bool DoIsUlRbgAvailableForUe (int rbId, uint16_t rnti) = 0;

  virtual void DoReportDlCqiInfo (const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters& params) = 0;

  virtual void DoReportUlCqiInfo (const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters& params) = 0;

  virtual void DoReportUlCqiInfo ( std::map <uint16_t, std::vector <double> > ulCqiMap ) = 0;

  virtual uint8_t DoGetTpc (uint16_t rnti) = 0;

  virtual uint8_t DoGetMinContinuousUlBandwidth () = 0;

  // FFR SAP RRC PROVIDER IMPLEMENTATION

  virtual void DoSetCellId (uint16_t cellId);

  virtual void DoSetBandwidth (uint8_t ulBandwidth, uint8_t dlBandwidth);

  virtual void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults) = 0;

  virtual void DoRecvLoadInformation (EpcX2Sap::LoadInformationParams params) = 0;

  int GetRbgSize (int dlbandwidth);


  uint16_t m_cellId;

  uint8_t m_dlBandwidth; 
  uint8_t m_ulBandwidth; 
  uint8_t m_frCellTypeId; 
  bool m_enabledInUplink; 
  bool m_needReconfiguration; 
}; // end of class LteFfrAlgorithm


} // end of namespace ns3


#endif /* LTE_FFR_ALGORITHM_H */