A Discrete-Event Network Simulator
API
a3-rsrp-handover-algorithm.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013 Budiarto Herman
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: Budiarto Herman <budiarto.herman@magister.fi>
19  *
20  */
21 
22 #ifndef A3_RSRP_HANDOVER_ALGORITHM_H
23 #define A3_RSRP_HANDOVER_ALGORITHM_H
24 
25 #include <ns3/lte-handover-algorithm.h>
26 #include <ns3/lte-handover-management-sap.h>
27 #include <ns3/lte-rrc-sap.h>
28 #include <ns3/nstime.h>
29 
30 namespace ns3 {
31 
32 
66 {
67 public:
70 
71  virtual ~A3RsrpHandoverAlgorithm ();
72 
77  static TypeId GetTypeId ();
78 
79  // inherited from LteHandoverAlgorithm
82 
85 
86 protected:
87  // inherited from Object
88  virtual void DoInitialize ();
89  virtual void DoDispose ();
90 
91  // inherited from LteHandoverAlgorithm as a Handover Management SAP implementation
92  void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults);
93 
94 private:
102  bool IsValidNeighbour (uint16_t cellId);
103 
105  uint8_t m_measId;
106 
117 
122 
123 }; // end of class A3RsrpHandoverAlgorithm
124 
125 
126 } // end of namespace ns3
127 
128 
129 #endif /* A3_RSRP_HANDOVER_ALGORITHM_H */
ns3::A3RsrpHandoverAlgorithm::DoDispose
virtual void DoDispose()
Destructor implementation.
Definition: a3-rsrp-handover-algorithm.cc:115
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::LteHandoverManagementSapUser
Service Access Point (SAP) offered by the eNodeB RRC instance to the handover algorithm instance.
Definition: lte-handover-management-sap.h:68
ns3::A3RsrpHandoverAlgorithm::IsValidNeighbour
bool IsValidNeighbour(uint16_t cellId)
Determines if a neighbour cell is a valid destination for handover.
Definition: a3-rsrp-handover-algorithm.cc:180
ns3::A3RsrpHandoverAlgorithm::SetLteHandoverManagementSapUser
virtual void SetLteHandoverManagementSapUser(LteHandoverManagementSapUser *s)
Set the "user" part of the Handover Management SAP interface that this handover algorithm instance wi...
Definition: a3-rsrp-handover-algorithm.cc:75
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::MemberLteHandoverManagementSapProvider
Template for the implementation of the LteHandoverManagementSapProvider as a member of an owner class...
Definition: lte-handover-management-sap.h:116
ns3::A3RsrpHandoverAlgorithm::m_handoverManagementSapProvider
LteHandoverManagementSapProvider * m_handoverManagementSapProvider
Receive API calls from the eNodeB RRC instance.
Definition: a3-rsrp-handover-algorithm.h:121
ns3::A3RsrpHandoverAlgorithm
Implementation of the strongest cell handover algorithm, based on RSRP measurements and Event A3.
Definition: a3-rsrp-handover-algorithm.h:66
ns3::LteHandoverManagementSapProvider
Service Access Point (SAP) offered by the handover algorithm instance to the eNodeB RRC instance.
Definition: lte-handover-management-sap.h:39
ns3::A3RsrpHandoverAlgorithm::DoInitialize
virtual void DoInitialize()
Initialize() implementation.
Definition: a3-rsrp-handover-algorithm.cc:91
ns3::A3RsrpHandoverAlgorithm::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition: a3-rsrp-handover-algorithm.cc:50
ns3::A3RsrpHandoverAlgorithm::~A3RsrpHandoverAlgorithm
virtual ~A3RsrpHandoverAlgorithm()
Definition: a3-rsrp-handover-algorithm.cc:43
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
ns3::A3RsrpHandoverAlgorithm::DoReportUeMeas
void DoReportUeMeas(uint16_t rnti, LteRrcSap::MeasResults measResults)
Implementation of LteHandoverManagementSapProvider::ReportUeMeas.
Definition: a3-rsrp-handover-algorithm.cc:123
ns3::A3RsrpHandoverAlgorithm::m_measId
uint8_t m_measId
The expected measurement identity for A3 measurements.
Definition: a3-rsrp-handover-algorithm.h:105
ns3::A3RsrpHandoverAlgorithm::m_timeToTrigger
Time m_timeToTrigger
The TimeToTrigger attribute.
Definition: a3-rsrp-handover-algorithm.h:116
ns3::LteRrcSap::MeasResults
MeasResults structure.
Definition: lte-rrc-sap.h:679
ns3::A3RsrpHandoverAlgorithm::GetLteHandoverManagementSapProvider
virtual LteHandoverManagementSapProvider * GetLteHandoverManagementSapProvider()
Export the "provider" part of the Handover Management SAP interface.
Definition: a3-rsrp-handover-algorithm.cc:83
ns3::A3RsrpHandoverAlgorithm::A3RsrpHandoverAlgorithm
A3RsrpHandoverAlgorithm()
Creates a strongest cell handover algorithm instance.
Definition: a3-rsrp-handover-algorithm.cc:35
ns3::A3RsrpHandoverAlgorithm::m_handoverManagementSapUser
LteHandoverManagementSapUser * m_handoverManagementSapUser
Interface to the eNodeB RRC instance.
Definition: a3-rsrp-handover-algorithm.h:119
ns3::LteHandoverAlgorithm
The abstract base class of a handover algorithm that operates using the Handover Management SAP inter...
Definition: lte-handover-algorithm.h:67
ns3::A3RsrpHandoverAlgorithm::m_hysteresisDb
double m_hysteresisDb
The Hysteresis attribute.
Definition: a3-rsrp-handover-algorithm.h:111