A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
lte-fr-no-op-algorithm.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2014 Piotr Gawlowicz
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Author: Piotr Gawlowicz <gawlowicz.p@gmail.com>
7 *
8 */
9
10#ifndef LTE_FR_NO_OP_ALGORITHM_H
11#define LTE_FR_NO_OP_ALGORITHM_H
12
13#include "lte-ffr-algorithm.h"
14#include "lte-ffr-rrc-sap.h"
15#include "lte-ffr-sap.h"
16#include "lte-rrc-sap.h"
17
18namespace ns3
19{
20
21/**
22 * \brief FR algorithm implementation which simply does nothing.
23 *
24 * Selecting this FR algorithm is equivalent to disabling FFR.
25 * This is the default choice.
26 *
27 * To enable FR, please select another FR algorithm, i.e.,
28 * another child class of LteFfrAlgorithm.
29 */
31{
32 public:
33 /**
34 * \brief Creates a NoOP FR algorithm instance.
35 */
37
38 ~LteFrNoOpAlgorithm() override;
39
40 /**
41 * \brief Get the type ID.
42 * \return the object TypeId
43 */
44 static TypeId GetTypeId();
45
46 // inherited from LteFfrAlgorithm
47 void SetLteFfrSapUser(LteFfrSapUser* s) override;
49
50 void SetLteFfrRrcSapUser(LteFfrRrcSapUser* s) override;
52
53 /// let the forwarder class access the protected and private members
55 /// let the forwarder class access the protected and private members
57
58 protected:
59 // inherited from Object
60 void DoInitialize() override;
61 void DoDispose() override;
62
63 void Reconfigure() override;
64
65 // FFR SAP PROVIDER IMPLEMENTATION
66 std::vector<bool> DoGetAvailableDlRbg() override;
67 bool DoIsDlRbgAvailableForUe(int i, uint16_t rnti) override;
68 std::vector<bool> DoGetAvailableUlRbg() override;
69 bool DoIsUlRbgAvailableForUe(int i, uint16_t rnti) override;
74 void DoReportUlCqiInfo(std::map<uint16_t, std::vector<double>> ulCqiMap) override;
75 uint8_t DoGetTpc(uint16_t rnti) override;
76 uint16_t DoGetMinContinuousUlBandwidth() override;
77
78 // FFR SAP RRC PROVIDER IMPLEMENTATION
79 void DoReportUeMeas(uint16_t rnti, LteRrcSap::MeasResults measResults) override;
81
82 private:
83 // FFR SAP
84 LteFfrSapUser* m_ffrSapUser; ///< FFR SAP user
85 LteFfrSapProvider* m_ffrSapProvider; ///< FFR SAP provider
86
87 // FFR RRF SAP
88 LteFfrRrcSapUser* m_ffrRrcSapUser; ///< FFR RRC SAP user
89 LteFfrRrcSapProvider* m_ffrRrcSapProvider; ///< FFR RRC SAP provider
90
91}; // end of class LteFrNoOpAlgorithm
92
93} // end of namespace ns3
94
95#endif /* LTE_FFR_NO_OP_ALGORITHM_H */
The abstract base class of a Frequency Reuse algorithm.
Service Access Point (SAP) offered by the Frequency Reuse algorithm instance to the eNodeB RRC instan...
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
Service Access Point (SAP) offered by the Frequency Reuse algorithm instance to the MAC Scheduler ins...
Definition lte-ffr-sap.h:29
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
FR algorithm implementation which simply does nothing.
LteFfrSapProvider * m_ffrSapProvider
FFR SAP provider.
std::vector< bool > DoGetAvailableUlRbg() override
Implementation of LteFfrSapProvider::GetAvailableUlRbg.
LteFfrRrcSapUser * m_ffrRrcSapUser
FFR RRC SAP user.
bool DoIsUlRbgAvailableForUe(int i, uint16_t rnti) override
Implementation of LteFfrSapProvider::IsUlRbgAvailableForUe.
void DoReportUeMeas(uint16_t rnti, LteRrcSap::MeasResults measResults) override
Implementation of LteFfrRrcSapProvider::ReportUeMeas.
std::vector< bool > DoGetAvailableDlRbg() override
Implementation of LteFfrSapProvider::GetAvailableDlRbg.
bool DoIsDlRbgAvailableForUe(int i, uint16_t rnti) override
Implementation of LteFfrSapProvider::IsDlRbgAvailableForUe.
LteFfrSapProvider * GetLteFfrSapProvider() override
Export the "provider" part of the LteFfrSap interface.
void DoReportDlCqiInfo(const FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params) override
DoReportDlCqiInfo.
static TypeId GetTypeId()
Get the type ID.
uint16_t DoGetMinContinuousUlBandwidth() override
DoGetMinContinuousUlBandwidth in number of RB.
LteFfrRrcSapProvider * GetLteFfrRrcSapProvider() override
Export the "provider" part of the LteFfrRrcSap interface.
LteFfrRrcSapProvider * m_ffrRrcSapProvider
FFR RRC SAP provider.
void DoInitialize() override
Initialize() implementation.
void DoRecvLoadInformation(EpcX2Sap::LoadInformationParams params) override
DoRecvLoadInformation.
void DoDispose() override
Destructor implementation.
void Reconfigure() override
Automatic FR reconfiguration.
uint8_t DoGetTpc(uint16_t rnti) override
DoGetTpc for UE.
void SetLteFfrSapUser(LteFfrSapUser *s) override
Set the "user" part of the LteFfrSap interface that this frequency reuse algorithm instance will inte...
void DoReportUlCqiInfo(const FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params) override
DoReportUlCqiInfo.
LteFrNoOpAlgorithm()
Creates a NoOP FR algorithm instance.
LteFfrSapUser * m_ffrSapUser
FFR SAP user.
void SetLteFfrRrcSapUser(LteFfrRrcSapUser *s) override
Set the "user" part of the LteFfrRrcSap interface that this frequency reuse algorithm instance will i...
Template for the implementation of the LteFfrRrcSapProvider as a member of an owner class of type C t...
Template for the implementation of the LteFfrSapProvider as a member of an owner class of type C to w...
a unique identifier for an interface.
Definition type-id.h:48
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Parameters of the LOAD INFORMATION message.
Definition epc-x2-sap.h:295
Parameters of the SCHED_DL_CQI_INFO_REQ primitive.
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
MeasResults structure.