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 */
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::LteFrNoOpAlgorithm::DoReportUlCqiInfo
virtual void DoReportUlCqiInfo(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
DoReportUlCqiInfo.
Definition: lte-fr-no-op-algorithm.cc:153
ns3::LteFfrSapUser
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
Definition: lte-ffr-sap.h:139
ns3::FfMacSchedSapProvider::SchedDlCqiInfoReqParameters
Parameters of the SCHED_DL_CQI_INFO_REQ primitive.
Definition: ff-mac-sched-sap.h:125
ns3::LteFrNoOpAlgorithm::DoGetAvailableUlRbg
virtual std::vector< bool > DoGetAvailableUlRbg()
Implementation of LteFfrSapProvider::GetAvailableUlRbg.
Definition: lte-fr-no-op-algorithm.cc:130
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::LteFrNoOpAlgorithm::DoRecvLoadInformation
virtual void DoRecvLoadInformation(EpcX2Sap::LoadInformationParams params)
DoRecvLoadInformation.
Definition: lte-fr-no-op-algorithm.cc:189
ns3::FfMacSchedSapProvider::SchedUlCqiInfoReqParameters
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
Definition: ff-mac-sched-sap.h:186
ns3::LteFrNoOpAlgorithm::DoReportUeMeas
virtual void DoReportUeMeas(uint16_t rnti, LteRrcSap::MeasResults measResults)
Implementation of LteFfrRrcSapProvider::ReportUeMeas.
Definition: lte-fr-no-op-algorithm.cc:181
ns3::LteFrNoOpAlgorithm::DoGetMinContinuousUlBandwidth
virtual uint16_t DoGetMinContinuousUlBandwidth()
DoGetMinContinuousUlBandwidth in number of RB.
Definition: lte-fr-no-op-algorithm.cc:174
ns3::LteFrNoOpAlgorithm::DoReportDlCqiInfo
virtual void DoReportDlCqiInfo(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
DoReportDlCqiInfo.
Definition: lte-fr-no-op-algorithm.cc:146
ns3::LteFrNoOpAlgorithm::LteFrNoOpAlgorithm
LteFrNoOpAlgorithm()
Creates a NoOP FR algorithm instance.
Definition: lte-fr-no-op-algorithm.cc:32
ns3::LteFrNoOpAlgorithm::GetLteFfrSapProvider
virtual LteFfrSapProvider * GetLteFfrSapProvider()
Export the "provider" part of the LteFfrSap interface.
Definition: lte-fr-no-op-algorithm.cc:77
ns3::LteFrNoOpAlgorithm::m_ffrSapProvider
LteFfrSapProvider * m_ffrSapProvider
FFR SAP provider.
Definition: lte-fr-no-op-algorithm.h:95
ns3::MemberLteFfrRrcSapProvider
Template for the implementation of the LteFfrRrcSapProvider as a member of an owner class of type C t...
Definition: lte-ffr-rrc-sap.h:144
ns3::LteFrNoOpAlgorithm::DoGetAvailableDlRbg
virtual std::vector< bool > DoGetAvailableDlRbg()
Implementation of LteFfrSapProvider::GetAvailableDlRbg.
Definition: lte-fr-no-op-algorithm.cc:113
ns3::LteFfrRrcSapUser
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
Definition: lte-ffr-rrc-sap.h:89
ns3::LteFrNoOpAlgorithm::SetLteFfrSapUser
virtual void SetLteFfrSapUser(LteFfrSapUser *s)
Set the "user" part of the LteFfrSap interface that this frequency reuse algorithm instance will inte...
Definition: lte-fr-no-op-algorithm.cc:69
ns3::LteFfrSapProvider
Service Access Point (SAP) offered by the Frequency Reuse algorithm instance to the MAC Scheduler ins...
Definition: lte-ffr-sap.h:40
ns3::LteFrNoOpAlgorithm::~LteFrNoOpAlgorithm
virtual ~LteFrNoOpAlgorithm()
Definition: lte-fr-no-op-algorithm.cc:41
ns3::LteFrNoOpAlgorithm
FR algorithm implementation which simply does nothing.
Definition: lte-fr-no-op-algorithm.h:43
ns3::LteFrNoOpAlgorithm::GetLteFfrRrcSapProvider
virtual LteFfrRrcSapProvider * GetLteFfrRrcSapProvider()
Export the "provider" part of the LteFfrRrcSap interface.
Definition: lte-fr-no-op-algorithm.cc:92
ns3::LteFrNoOpAlgorithm::DoDispose
virtual void DoDispose()
Destructor implementation.
Definition: lte-fr-no-op-algorithm.cc:48
ns3::LteFrNoOpAlgorithm::DoInitialize
virtual void DoInitialize()
Initialize() implementation.
Definition: lte-fr-no-op-algorithm.cc:100
ns3::LteFrNoOpAlgorithm::DoIsDlRbgAvailableForUe
virtual bool DoIsDlRbgAvailableForUe(int i, uint16_t rnti)
Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe.
Definition: lte-fr-no-op-algorithm.cc:123
ns3::LteFrNoOpAlgorithm::m_ffrSapUser
LteFfrSapUser * m_ffrSapUser
FFR SAP user.
Definition: lte-fr-no-op-algorithm.h:94
ns3::LteFrNoOpAlgorithm::Reconfigure
virtual void Reconfigure()
Automatic FR reconfiguration.
Definition: lte-fr-no-op-algorithm.cc:107
ns3::LteFrNoOpAlgorithm::DoGetTpc
virtual uint8_t DoGetTpc(uint16_t rnti)
DoGetTpc for UE.
Definition: lte-fr-no-op-algorithm.cc:167
ns3::LteFrNoOpAlgorithm::SetLteFfrRrcSapUser
virtual void SetLteFfrRrcSapUser(LteFfrRrcSapUser *s)
Set the "user" part of the LteFfrRrcSap interface that this frequency reuse algorithm instance will i...
Definition: lte-fr-no-op-algorithm.cc:84
ns3::LteRrcSap::MeasResults
MeasResults structure.
Definition: lte-rrc-sap.h:679
ns3::EpcX2Sap::LoadInformationParams
Parameters of the LOAD INFORMATION message.
Definition: epc-x2-sap.h:304
ns3::LteFfrAlgorithm
The abstract base class of a Frequency Reuse algorithm.
Definition: lte-ffr-algorithm.h:58
ns3::LteFrNoOpAlgorithm::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition: lte-fr-no-op-algorithm.cc:57
ns3::LteFrNoOpAlgorithm::m_ffrRrcSapUser
LteFfrRrcSapUser * m_ffrRrcSapUser
FFR RRC SAP user.
Definition: lte-fr-no-op-algorithm.h:98
ns3::LteFrNoOpAlgorithm::DoIsUlRbgAvailableForUe
virtual bool DoIsUlRbgAvailableForUe(int i, uint16_t rnti)
Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe.
Definition: lte-fr-no-op-algorithm.cc:139
ns3::MemberLteFfrSapProvider
Template for the implementation of the LteFfrSapProvider as a member of an owner class of type C to w...
Definition: lte-ffr-sap.h:153
ns3::LteFfrRrcSapProvider
Service Access Point (SAP) offered by the Frequency Reuse algorithm instance to the eNodeB RRC instan...
Definition: lte-ffr-rrc-sap.h:39
ns3::LteFrNoOpAlgorithm::m_ffrRrcSapProvider
LteFfrRrcSapProvider * m_ffrRrcSapProvider
FFR RRC SAP provider.
Definition: lte-fr-no-op-algorithm.h:99