A Discrete-Event Network Simulator
API
lte-ffr-enhanced-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_FFR_ENHANCED_ALGORITHM_H
23 #define LTE_FFR_ENHANCED_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 #include <map>
30 
31 // value for SINR outside the range defined by FF-API, used to indicate that there
32 // is no CQI for this element
33 #define NO_SINR -5000
34 
35 namespace ns3 {
36 
41 {
42 public:
47  virtual ~LteFfrEnhancedAlgorithm ();
48 
53  static TypeId GetTypeId ();
54 
55  // inherited from LteFfrAlgorithm
56  virtual void SetLteFfrSapUser (LteFfrSapUser* s);
58 
59  virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser* s);
61 
66 
67 protected:
68  // inherited from Object
69  virtual void DoInitialize ();
70  virtual void DoDispose ();
71 
72  virtual void Reconfigure ();
73 
74  // FFR SAP PROVIDER IMPLEMENTATION
75  virtual std::vector <bool> DoGetAvailableDlRbg ();
76  virtual bool DoIsDlRbgAvailableForUe (int i, uint16_t rnti);
77  virtual std::vector <bool> DoGetAvailableUlRbg ();
78  virtual bool DoIsUlRbgAvailableForUe (int i, uint16_t rnti);
81  virtual void DoReportUlCqiInfo ( std::map <uint16_t, std::vector <double> > ulCqiMap );
82  virtual uint8_t DoGetTpc (uint16_t rnti);
83  virtual uint8_t DoGetMinContinuousUlBandwidth ();
84 
85  // FFR SAP RRC PROVIDER IMPLEMENTATION
86  virtual void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults);
88 
89 private:
96  void SetDownlinkConfiguration (uint16_t cellId, uint8_t bandwidth);
103  void SetUplinkConfiguration (uint16_t cellId, uint8_t bandwidth);
111  void InitializeUplinkRbgMaps ();
112 
121  double EstimateUlSinr (uint16_t rnti, uint16_t rb, std::map <uint16_t, std::vector <double> > ulCqiMap);
128  int GetCqiFromSpectralEfficiency (double s);
129 
130  // FFR SAP
133 
134  // FFR RRF SAP
137 
141 
145 
146  std::vector <bool> m_dlRbgMap;
147  std::vector <bool> m_ulRbgMap;
148 
149  std::vector <bool> m_dlReuse3RbgMap;
150  std::vector <bool> m_dlReuse1RbgMap;
151  std::vector <bool> m_dlPrimarySegmentRbgMap;
152  std::vector <bool> m_dlSecondarySegmentRbgMap;
153 
154  std::vector <bool> m_ulReuse3RbgMap;
155  std::vector <bool> m_ulReuse1RbgMap;
156  std::vector <bool> m_ulPrimarySegmentRbgMap;
157  std::vector <bool> m_ulSecondarySegmentRbgMap;
158 
161  {
165  };
166 
167  std::map< uint16_t, uint8_t > m_ues;
168 
169  uint8_t m_rsrqThreshold;
170 
173 
174  uint8_t m_centerAreaTpc;
175  uint8_t m_edgeAreaTpc;
176 
177 
179 
182  std::map <uint16_t,SbMeasResult_s> m_dlCqi;
183  std::map <uint16_t, std::vector<bool> > m_dlRbgAvailableforUe;
184 
186  std::map <uint16_t, std::vector<int> > m_ulCqi;
187  std::map <uint16_t, std::vector<bool> > m_ulRbAvailableforUe;
188 
190  uint8_t m_measId;
191 
192 }; // end of class LteFfrEnhancedAlgorithm
193 
194 } // end of namespace ns3
195 
196 #endif /* LTE_FFR_ENHANCED_ALGORITHM_H */
Service Access Point (SAP) offered by the Frequency Reuse algorithm instance to the eNodeB RRC instan...
virtual uint8_t DoGetMinContinuousUlBandwidth()
DoGetMinContinuousUlBandwidth in number of RB.
uint8_t m_ulReuse1SubBandwidth
UL reuse 1 subbandwidth.
Template for the implementation of the LteFfrRrcSapProvider as a member of an owner class of type C t...
virtual LteFfrRrcSapProvider * GetLteFfrRrcSapProvider()
Export the "provider" part of the LteFfrRrcSap interface.
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
Definition: lte-ffr-sap.h:138
std::map< uint16_t, std::vector< bool > > m_dlRbgAvailableforUe
DL RBG available for UE.
virtual std::vector< bool > DoGetAvailableUlRbg()
Implementation of LteFfrSapProvider::GetAvailableUlRbg.
std::vector< bool > m_ulSecondarySegmentRbgMap
UL secondary segment RBG map.
LteFfrRrcSapProvider * m_ffrRrcSapProvider
FFR RRC SAP provider.
std::vector< bool > m_ulReuse3RbgMap
UL reuse 3 RBG map.
LteFfrEnhancedAlgorithm()
Creates a trivial ffr algorithm instance.
virtual bool DoIsDlRbgAvailableForUe(int i, uint16_t rnti)
Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe.
std::vector< bool > m_ulReuse1RbgMap
UL reuse 1 RBG map.
virtual void SetLteFfrSapUser(LteFfrSapUser *s)
Set the "user" part of the LteFfrSap interface that this frequency reuse algorithm instance will inte...
uint8_t m_centerAreaTpc
Center area TPC.
virtual void DoReportDlCqiInfo(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
DoReportDlCqiInfo.
virtual void DoDispose()
Destructor implementation.
Template for the implementation of the LteFfrSapProvider as a member of an owner class of type C to w...
Definition: lte-ffr-sap.h:152
virtual uint8_t DoGetTpc(uint16_t rnti)
DoGetTpc for UE.
std::map< uint16_t, SbMeasResult_s > m_dlCqi
Map of UE&#39;s DL CQI A30 received.
MeasResults structure.
Definition: lte-rrc-sap.h:671
uint8_t m_dlReuse1SubBandwidth
DL reuse 1 subband bandwidth.
Service Access Point (SAP) offered by the Frequency Reuse algorithm instance to the MAC Scheduler ins...
Definition: lte-ffr-sap.h:39
LteFfrSapUser * m_ffrSapUser
FFR SAP user.
uint8_t m_dlReuse3SubBandwidth
DL reuse 3 subband bandwidth.
virtual void DoReportUeMeas(uint16_t rnti, LteRrcSap::MeasResults measResults)
Implementation of LteFfrRrcSapProvider::ReportUeMeas.
std::vector< bool > m_dlPrimarySegmentRbgMap
DL primary segment RBG map.
double EstimateUlSinr(uint16_t rnti, uint16_t rb, std::map< uint16_t, std::vector< double > > ulCqiMap)
Initialize uplink RBG maps.
std::vector< bool > m_dlReuse1RbgMap
DL reuse 1 RBG map.
virtual void DoReportUlCqiInfo(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
DoReportUlCqiInfo.
LteFfrSapProvider * m_ffrSapProvider
FFR SAP provider.
virtual void DoInitialize()
Initialize() implementation.
virtual std::vector< bool > DoGetAvailableDlRbg()
Implementation of LteFfrSapProvider::GetAvailableDlRbg.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
The abstract base class of a Frequency Reuse algorithm.
std::map< uint16_t, std::vector< int > > m_ulCqi
UL CQI.
uint8_t m_dlSubBandOffset
DL subband offset.
std::vector< bool > m_dlSecondarySegmentRbgMap
DL secondary segment RBG map.
uint8_t m_edgeAreaPowerOffset
Edge area power offset.
uint8_t m_ulReuse3SubBandwidth
UL reuse 3 subbandwidth.
void InitializeDownlinkRbgMaps()
Initialize downlink RBG maps.
Enhanced Fractional Frequency Reuse algorithm implementation.
uint8_t m_ulCqiThreshold
UL CQI threshold.
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
virtual void DoRecvLoadInformation(EpcX2Sap::LoadInformationParams params)
DoRecvLoadInformation.
uint8_t m_ulSubBandOffset
UL subband offset.
uint8_t m_measId
The expected measurement identity.
Parameters of the SCHED_DL_CQI_INFO_REQ primitive.
int GetCqiFromSpectralEfficiency(double s)
Get CQI from spectral efficiency.
virtual void SetLteFfrRrcSapUser(LteFfrRrcSapUser *s)
Set the "user" part of the LteFfrRrcSap interface that this frequency reuse algorithm instance will i...
void SetUplinkConfiguration(uint16_t cellId, uint8_t bandwidth)
Set uplink configuration.
static TypeId GetTypeId()
Get the type ID.
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
std::map< uint16_t, uint8_t > m_ues
UEs.
virtual LteFfrSapProvider * GetLteFfrSapProvider()
Export the "provider" part of the LteFfrSap interface.
virtual bool DoIsUlRbgAvailableForUe(int i, uint16_t rnti)
Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe.
uint8_t m_dlCqiThreshold
DL CQI threshold.
Parameters of the LOAD INFORMATION message.
Definition: epc-x2-sap.h:303
void SetDownlinkConfiguration(uint16_t cellId, uint8_t bandwidth)
Set downlink configuration.
std::vector< bool > m_ulPrimarySegmentRbgMap
UL primary segment RBG map.
LteFfrRrcSapUser * m_ffrRrcSapUser
FFR RRC SAP user.
a unique identifier for an interface.
Definition: type-id.h:58
std::vector< bool > m_dlRbgMap
DL RBG map.
std::vector< bool > m_ulRbgMap
UL RBG Map.
std::vector< bool > m_dlReuse3RbgMap
DL reuse 3 RBG map.
virtual void Reconfigure()
Automatic FR reconfiguration.
std::map< uint16_t, std::vector< bool > > m_ulRbAvailableforUe
UL RB available for UE.
uint8_t m_centerAreaPowerOffset
Center area power offset.
void InitializeUplinkRbgMaps()
Initialize uplink RBG maps.