/usr/include/ns3.27/ns3/lte-handover-management-sap.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 | /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2013 Budiarto Herman
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Budiarto Herman <budiarto.herman@magister.fi>
*
*/
#ifndef LTE_HANDOVER_MANAGEMENT_SAP_H
#define LTE_HANDOVER_MANAGEMENT_SAP_H
#include <ns3/lte-rrc-sap.h>
namespace ns3 {
/**
* \brief Service Access Point (SAP) offered by the handover algorithm instance
* to the eNodeB RRC instance.
*
* This is the *Handover Management SAP Provider*, i.e., the part of the SAP
* that contains the handover algorithm methods called by the eNodeB RRC
* instance.
*/
class LteHandoverManagementSapProvider
{
public:
virtual ~LteHandoverManagementSapProvider ();
/**
* \brief Send a UE measurement report to handover algorithm.
* \param rnti Radio Network Temporary Identity, an integer identifying the UE
* where the report originates from
* \param measResults a single report of one measurement identity
*
* The received measurement report is a result of the UE measurement
* configuration previously configured by calling
* LteHandoverManagementSapUser::AddUeMeasReportConfigForHandover. The report
* may be stored and utilised for the purpose of making handover decision.
*/
virtual void ReportUeMeas (uint16_t rnti,
LteRrcSap::MeasResults measResults) = 0;
}; // end of class LteHandoverManagementSapProvider
/**
* \brief Service Access Point (SAP) offered by the eNodeB RRC instance to the
* handover algorithm instance.
*
* This is the *Handover Management SAP User*, i.e., the part of the SAP that
* contains the eNodeB RRC methods called by the handover algorithm instance.
*/
class LteHandoverManagementSapUser
{
public:
virtual ~LteHandoverManagementSapUser ();
/**
* \brief Request a certain reporting configuration to be fulfilled by the UEs
* attached to the eNodeB entity.
* \param reportConfig the UE measurement reporting configuration
* \return the measurement identity associated with this newly added
* reporting configuration
*
* The eNodeB RRC entity is expected to configure the same reporting
* configuration in each of the attached UEs. When later in the simulation a
* UE measurement report is received from a UE as a result of this
* configuration, the eNodeB RRC entity shall forward this report to the
* handover algorithm through the LteHandoverManagementSapProvider::ReportUeMeas
* SAP function.
*
* \note This function is only valid before the simulation begins.
*/
virtual uint8_t AddUeMeasReportConfigForHandover (LteRrcSap::ReportConfigEutra reportConfig) = 0;
/**
* \brief Instruct the eNodeB RRC entity to prepare a handover.
* \param rnti Radio Network Temporary Identity, an integer identifying the
* UE which shall perform the handover
* \param targetCellId the cell ID of the target eNodeB
*
* This function is used by the handover algorithm entity when a handover
* decision has been reached.
*
* The process to produce the decision is up to the implementation of handover
* algorithm. It is typically based on the reported UE measurements, which are
* received through the LteHandoverManagementSapProvider::ReportUeMeas function.
*/
virtual void TriggerHandover (uint16_t rnti, uint16_t targetCellId) = 0;
}; // end of class LteHandoverManagementSapUser
/**
* \brief Template for the implementation of the LteHandoverManagementSapProvider
* as a member of an owner class of type C to which all methods are
* forwarded.
*/
template <class C>
class MemberLteHandoverManagementSapProvider : public LteHandoverManagementSapProvider
{
public:
/**
* Constructor
*
* \param owner the owner class
*/
MemberLteHandoverManagementSapProvider (C* owner);
// inherited from LteHandoverManagemenrSapProvider
virtual void ReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults);
private:
MemberLteHandoverManagementSapProvider ();
C* m_owner; ///< the owner class
}; // end of class MemberLteHandoverManagementSapProvider
template <class C>
MemberLteHandoverManagementSapProvider<C>::MemberLteHandoverManagementSapProvider (C* owner)
: m_owner (owner)
{
}
template <class C>
void
MemberLteHandoverManagementSapProvider<C>::ReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults)
{
m_owner->DoReportUeMeas (rnti, measResults);
}
/**
* \brief Template for the implementation of the LteHandoverManagementSapUser
* as a member of an owner class of type C to which all methods are
* forwarded.
*/
template <class C>
class MemberLteHandoverManagementSapUser : public LteHandoverManagementSapUser
{
public:
/**
* Constructor
*
* \param owner the owner class
*/
MemberLteHandoverManagementSapUser (C* owner);
// inherited from LteHandoverManagementSapUser
virtual uint8_t AddUeMeasReportConfigForHandover (LteRrcSap::ReportConfigEutra reportConfig);
virtual void TriggerHandover (uint16_t rnti, uint16_t targetCellId);
private:
MemberLteHandoverManagementSapUser ();
C* m_owner; ///< the owner class
}; // end of class MemberLteAnrSapUser
template <class C>
MemberLteHandoverManagementSapUser<C>::MemberLteHandoverManagementSapUser (C* owner)
: m_owner (owner)
{
}
template <class C>
uint8_t
MemberLteHandoverManagementSapUser<C>::AddUeMeasReportConfigForHandover (LteRrcSap::ReportConfigEutra reportConfig)
{
return m_owner->DoAddUeMeasReportConfigForHandover (reportConfig);
}
template <class C>
void
MemberLteHandoverManagementSapUser<C>::TriggerHandover (uint16_t rnti, uint16_t targetCellId)
{
return m_owner->DoTriggerHandover (rnti, targetCellId);
}
} // end of namespace ns3
#endif /* LTE_HANDOVER_MANAGEMENT_SAP_H */
|