A Discrete-Event Network Simulator
API
lte-fr-strict-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_STRICT_ALGORITHM_H
23 #define LTE_FR_STRICT_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 namespace ns3 {
32 
33 
38 {
39 public:
44 
45  virtual ~LteFrStrictAlgorithm ();
46 
47  // inherited from Object
48  static TypeId GetTypeId ();
49 
50  // inherited from LteFfrAlgorithm
51  virtual void SetLteFfrSapUser (LteFfrSapUser* s);
53 
54  virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser* s);
56 
57  // let the forwarder class access the protected and private members
60 
61 protected:
62  // inherited from Object
63  virtual void DoInitialize ();
64  virtual void DoDispose ();
65 
66  virtual void Reconfigure ();
67 
68  // FFR SAP PROVIDER IMPLEMENTATION
69  virtual std::vector <bool> DoGetAvailableDlRbg ();
70  virtual bool DoIsDlRbgAvailableForUe (int i, uint16_t rnti);
71  virtual std::vector <bool> DoGetAvailableUlRbg ();
72  virtual bool DoIsUlRbgAvailableForUe (int i, uint16_t rnti);
75  virtual void DoReportUlCqiInfo ( std::map <uint16_t, std::vector <double> > ulCqiMap );
76  virtual uint8_t DoGetTpc (uint16_t rnti);
77  virtual uint8_t DoGetMinContinuousUlBandwidth ();
78 
79  // FFR SAP RRC PROVIDER IMPLEMENTATION
80  virtual void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults);
82 
83 private:
84  void SetDownlinkConfiguration (uint16_t cellId, uint8_t bandwidth);
85  void SetUplinkConfiguration (uint16_t cellId, uint8_t bandwidth);
88 
89  // FFR SAP
92 
93  // FFR RRF SAP
96 
97 
101 
105 
106  std::vector <bool> m_dlRbgMap;
107  std::vector <bool> m_ulRbgMap;
108 
109  std::vector <bool> m_dlEdgeRbgMap;
110  std::vector <bool> m_ulEdgeRbgMap;
111 
112  enum SubBand
113  {
117  };
118 
119  std::map< uint16_t, uint8_t > m_ues;
120  std::vector<uint16_t> m_egdeUes;
121 
123 
126 
128  uint8_t m_edgeAreaTpc;
129 
130  // The expected measurement identity
131  uint8_t m_measId;
132 
133 }; // end of class LteFrStrictAlgorithm
134 
135 
136 } // end of namespace ns3
137 
138 
139 #endif /* LTE_FR_STRICT_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 uint8_t DoGetTpc(uint16_t rnti)
DoGetTpc for UE.
virtual void DoRecvLoadInformation(EpcX2Sap::LoadInformationParams params)
DoRecvLoadInformation.
virtual std::vector< bool > DoGetAvailableUlRbg()
Implementation of LteFfrSapProvider::GetAvailableUlRbg.
void SetUplinkConfiguration(uint16_t cellId, uint8_t bandwidth)
virtual bool DoIsUlRbgAvailableForUe(int i, uint16_t rnti)
Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe.
Strict Frequency Reuse algorithm implementation.
virtual void DoReportDlCqiInfo(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
DoReportDlCqiInfo.
LteFrStrictAlgorithm()
Creates a trivial ffr algorithm instance.
virtual uint8_t DoGetMinContinuousUlBandwidth()
DoGetMinContinuousUlBandwidth in number of RB.
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
LteFfrSapProvider * m_ffrSapProvider
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 DoDispose()
Destructor implementation.
virtual void Reconfigure()
Automatic FR reconfiguration.
virtual LteFfrSapProvider * GetLteFfrSapProvider()
Export the "provider" part of the LteFfrSap interface.
virtual LteFfrRrcSapProvider * GetLteFfrRrcSapProvider()
Export the "provider" part of the LteFfrRrcSap interface.
virtual void DoInitialize()
Initialize() implementation.
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, uint8_t > m_ues
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
std::vector< uint16_t > m_egdeUes
Parameters of the SCHED_DL_CQI_INFO_REQ primitive.
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
void SetDownlinkConfiguration(uint16_t cellId, uint8_t bandwidth)
Parameters of the LOAD INFORMATION message.
Definition: epc-x2-sap.h:300
virtual void DoReportUlCqiInfo(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
DoReportUlCqiInfo.
virtual std::vector< bool > DoGetAvailableDlRbg()
Implementation of LteFfrSapProvider::GetAvailableDlRbg.
virtual bool DoIsDlRbgAvailableForUe(int i, uint16_t rnti)
Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe.
virtual void SetLteFfrSapUser(LteFfrSapUser *s)
Set the "user" part of the LteFfrSap interface that this frequency reuse algorithm instance will inte...
a unique identifier for an interface.
Definition: type-id.h:58
virtual void DoReportUeMeas(uint16_t rnti, LteRrcSap::MeasResults measResults)
Implementation of LteFfrRrcSapProvider::ReportUeMeas.
LteFfrRrcSapProvider * m_ffrRrcSapProvider