A Discrete-Event Network Simulator
API
lte-fr-hard-algorithm.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014 Piotr Gawlowicz
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Piotr Gawlowicz <gawlowicz.p@gmail.com>
19  *
20  */
21 
22 #ifndef LTE_FR_HARD_ALGORITHM_H
23 #define LTE_FR_HARD_ALGORITHM_H
24 
25 #include <ns3/lte-ffr-algorithm.h>
26 #include <ns3/lte-ffr-sap.h>
27 #include <ns3/lte-ffr-rrc-sap.h>
28 #include <ns3/lte-rrc-sap.h>
29 
30 namespace ns3 {
31 
32 
37 {
38 public:
43 
44  virtual ~LteFrHardAlgorithm ();
45 
46  // inherited from Object
47  static TypeId GetTypeId ();
48 
49  // inherited from LteFfrAlgorithm
50  virtual void SetLteFfrSapUser (LteFfrSapUser* s);
52 
53  virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser* s);
55 
56  // let the forwarder class access the protected and private members
59 
60 protected:
61  // inherited from Object
62  virtual void DoInitialize ();
63  virtual void DoDispose ();
64 
65  virtual void Reconfigure ();
66 
67  // FFR SAP PROVIDER IMPLEMENTATION
68  virtual std::vector <bool> DoGetAvailableDlRbg ();
69  virtual bool DoIsDlRbgAvailableForUe (int i, uint16_t rnti);
70  virtual std::vector <bool> DoGetAvailableUlRbg ();
71  virtual bool DoIsUlRbgAvailableForUe (int i, uint16_t rnti);
74  virtual void DoReportUlCqiInfo ( std::map <uint16_t, std::vector <double> > ulCqiMap );
75  virtual uint8_t DoGetTpc (uint16_t rnti);
76  virtual uint8_t DoGetMinContinuousUlBandwidth ();
77 
78  // FFR SAP RRC PROVIDER IMPLEMENTATION
79  virtual void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults);
81 
82 private:
83  void SetDownlinkConfiguration (uint16_t cellId, uint8_t bandwidth);
84  void SetUplinkConfiguration (uint16_t cellId, uint8_t bandwidth);
87 
88  // FFR SAP
91 
92  // FFR RRF SAP
95 
96  uint8_t m_dlOffset;
97  uint8_t m_dlSubBand;
98 
99  uint8_t m_ulOffset;
100  uint8_t m_ulSubBand;
101 
102  std::vector <bool> m_dlRbgMap;
103  std::vector <bool> m_ulRbgMap;
104 
105 }; // end of class LteFrHardAlgorithm
106 
107 
108 } // end of namespace ns3
109 
110 
111 #endif /* LTE_FR_HARD_ALGORITHM_H */
Service Access Point (SAP) offered by the Frequency Reuse algorithm instance to the eNodeB RRC instan...
Template for the implementation of the LteFfrRrcSapProvider as a member of an owner class of type C t...
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
Definition: lte-ffr-sap.h:132
virtual void DoDispose()
Destructor implementation.
LteFrHardAlgorithm()
Creates a trivial ffr algorithm instance.
virtual bool DoIsDlRbgAvailableForUe(int i, uint16_t rnti)
Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe.
void SetDownlinkConfiguration(uint16_t cellId, uint8_t bandwidth)
Template for the implementation of the LteFfrSapProvider as a member of an owner class of type C to w...
Definition: lte-ffr-sap.h:146
virtual void Reconfigure()
Automatic FR reconfiguration.
virtual void SetLteFfrRrcSapUser(LteFfrRrcSapUser *s)
Set the "user" part of the LteFfrRrcSap interface that this frequency reuse algorithm instance will i...
Service Access Point (SAP) offered by the Frequency Reuse algorithm instance to the MAC Scheduler ins...
Definition: lte-ffr-sap.h:39
virtual void DoReportUeMeas(uint16_t rnti, LteRrcSap::MeasResults measResults)
Implementation of LteFfrRrcSapProvider::ReportUeMeas.
Hard Frequency Reuse algorithm implementation which uses only 1 sub-band.
std::vector< bool > m_ulRbgMap
virtual void DoInitialize()
Initialize() implementation.
std::vector< bool > m_dlRbgMap
LteFfrSapProvider * m_ffrSapProvider
LteFfrRrcSapUser * m_ffrRrcSapUser
Every class exported by the ns3 library is enclosed in the ns3 namespace.
The abstract base class of a Frequency Reuse algorithm.
virtual std::vector< bool > DoGetAvailableDlRbg()
Implementation of LteFfrSapProvider::GetAvailableDlRbg.
virtual uint8_t DoGetMinContinuousUlBandwidth()
DoGetMinContinuousUlBandwidth in number of RB.
virtual void DoReportDlCqiInfo(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
DoReportDlCqiInfo.
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
virtual std::vector< bool > DoGetAvailableUlRbg()
Implementation of LteFfrSapProvider::GetAvailableUlRbg.
Parameters of the SCHED_DL_CQI_INFO_REQ primitive.
virtual void DoRecvLoadInformation(EpcX2Sap::LoadInformationParams params)
DoRecvLoadInformation.
virtual void SetLteFfrSapUser(LteFfrSapUser *s)
Set the "user" part of the LteFfrSap interface that this frequency reuse algorithm instance will inte...
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
virtual uint8_t DoGetTpc(uint16_t rnti)
DoGetTpc for UE.
virtual LteFfrRrcSapProvider * GetLteFfrRrcSapProvider()
Export the "provider" part of the LteFfrRrcSap interface.
Parameters of the LOAD INFORMATION message.
Definition: epc-x2-sap.h:300
LteFfrRrcSapProvider * m_ffrRrcSapProvider
virtual bool DoIsUlRbgAvailableForUe(int i, uint16_t rnti)
Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe.
void SetUplinkConfiguration(uint16_t cellId, uint8_t bandwidth)
virtual LteFfrSapProvider * GetLteFfrSapProvider()
Export the "provider" part of the LteFfrSap interface.
a unique identifier for an interface.
Definition: type-id.h:58
virtual void DoReportUlCqiInfo(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
DoReportUlCqiInfo.