A Discrete-Event Network Simulator
API
lte-fr-no-op-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_NO_OP_ALGORITHM_H
23 #define LTE_FR_NO_OP_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 
43 {
44 public:
49 
50  virtual ~LteFrNoOpAlgorithm ();
51 
56  static TypeId GetTypeId ();
57 
58  // inherited from LteFfrAlgorithm
59  virtual void SetLteFfrSapUser (LteFfrSapUser* s);
61 
62  virtual void SetLteFfrRrcSapUser (LteFfrRrcSapUser* s);
64 
69 
70 protected:
71  // inherited from Object
72  virtual void DoInitialize ();
73  virtual void DoDispose ();
74 
75  virtual void Reconfigure ();
76 
77  // FFR SAP PROVIDER IMPLEMENTATION
78  virtual std::vector <bool> DoGetAvailableDlRbg ();
79  virtual bool DoIsDlRbgAvailableForUe (int i, uint16_t rnti);
80  virtual std::vector <bool> DoGetAvailableUlRbg ();
81  virtual bool DoIsUlRbgAvailableForUe (int i, uint16_t rnti);
84  virtual void DoReportUlCqiInfo ( std::map <uint16_t, std::vector <double> > ulCqiMap );
85  virtual uint8_t DoGetTpc (uint16_t rnti);
86  virtual uint16_t DoGetMinContinuousUlBandwidth ();
87 
88  // FFR SAP RRC PROVIDER IMPLEMENTATION
89  virtual void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults);
91 
92 private:
93  // FFR SAP
96 
97  // FFR RRF SAP
100 
101 }; // end of class LteFrNoOpAlgorithm
102 
103 
104 } // end of namespace ns3
105 
106 
107 #endif /* LTE_FFR_NO_OP_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...
LteFfrRrcSapProvider * m_ffrRrcSapProvider
FFR RRC SAP provider.
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
Definition: lte-ffr-sap.h:138
virtual bool DoIsDlRbgAvailableForUe(int i, uint16_t rnti)
Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe.
LteFfrSapUser * m_ffrSapUser
FFR SAP user.
virtual bool DoIsUlRbgAvailableForUe(int i, uint16_t rnti)
Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe.
virtual void Reconfigure()
Automatic FR reconfiguration.
virtual LteFfrRrcSapProvider * GetLteFfrRrcSapProvider()
Export the "provider" part of the LteFfrRrcSap interface.
LteFrNoOpAlgorithm()
Creates a NoOP FR algorithm instance.
virtual void DoReportUeMeas(uint16_t rnti, LteRrcSap::MeasResults measResults)
Implementation of LteFfrRrcSapProvider::ReportUeMeas.
FR algorithm implementation which simply does nothing.
virtual void DoRecvLoadInformation(EpcX2Sap::LoadInformationParams params)
DoRecvLoadInformation.
LteFfrRrcSapUser * m_ffrRrcSapUser
FFR RRC SAP user.
virtual void SetLteFfrRrcSapUser(LteFfrRrcSapUser *s)
Set the "user" part of the LteFfrRrcSap interface that this frequency reuse algorithm instance will i...
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.
virtual uint16_t DoGetMinContinuousUlBandwidth()
DoGetMinContinuousUlBandwidth in number of RB.
MeasResults structure.
Definition: lte-rrc-sap.h:678
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.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
The abstract base class of a Frequency Reuse algorithm.
virtual void DoInitialize()
Initialize() implementation.
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.
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
virtual void DoReportDlCqiInfo(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
DoReportDlCqiInfo.
Parameters of the LOAD INFORMATION message.
Definition: epc-x2-sap.h:303
virtual void SetLteFfrSapUser(LteFfrSapUser *s)
Set the "user" part of the LteFfrSap interface that this frequency reuse algorithm instance will inte...
virtual std::vector< bool > DoGetAvailableDlRbg()
Implementation of LteFfrSapProvider::GetAvailableDlRbg.
virtual LteFfrSapProvider * GetLteFfrSapProvider()
Export the "provider" part of the LteFfrSap interface.
LteFfrSapProvider * m_ffrSapProvider
FFR SAP provider.
a unique identifier for an interface.
Definition: type-id.h:58
static TypeId GetTypeId()
Get the type ID.
virtual void DoReportUlCqiInfo(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
DoReportUlCqiInfo.