A Discrete-Event Network Simulator
API
lte-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 LTE_HANDOVER_ALGORITHM_H
23 #define LTE_HANDOVER_ALGORITHM_H
24 
25 #include <ns3/object.h>
26 #include <ns3/lte-rrc-sap.h>
27 
28 namespace ns3 {
29 
30 
31 class LteHandoverManagementSapUser;
32 class LteHandoverManagementSapProvider;
33 
34 
66 class LteHandoverAlgorithm : public Object
67 {
68 public:
69  LteHandoverAlgorithm ();
70  virtual ~LteHandoverAlgorithm ();
71 
76  static TypeId GetTypeId ();
77 
84  virtual void SetLteHandoverManagementSapUser (LteHandoverManagementSapUser* s) = 0;
85 
91  virtual LteHandoverManagementSapProvider* GetLteHandoverManagementSapProvider () = 0;
92 
93 protected:
94 
95  // inherited from Object
96  virtual void DoDispose ();
97 
98  // HANDOVER MANAGEMENT SAP PROVIDER IMPLEMENTATION
99 
106  virtual void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults) = 0;
107 
108 }; // end of class LteHandoverAlgorithm
109 
110 
111 } // end of namespace ns3
112 
113 
114 #endif /* LTE_HANDOVER_ALGORITHM_H */
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
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::LteHandoverAlgorithm::DoDispose
virtual void DoDispose()
Destructor implementation.
Definition: lte-handover-algorithm.cc:54
ns3::LteHandoverAlgorithm::DoReportUeMeas
virtual void DoReportUeMeas(uint16_t rnti, LteRrcSap::MeasResults measResults)=0
Implementation of LteHandoverManagementSapProvider::ReportUeMeas.
ns3::LteHandoverAlgorithm::LteHandoverAlgorithm
LteHandoverAlgorithm()
Definition: lte-handover-algorithm.cc:32
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::Object
A base class which provides memory management and object aggregation.
Definition: object.h:88
ns3::LteHandoverAlgorithm::SetLteHandoverManagementSapUser
virtual void SetLteHandoverManagementSapUser(LteHandoverManagementSapUser *s)=0
Set the "user" part of the Handover Management SAP interface that this handover algorithm instance wi...
ns3::LteRrcSap::MeasResults
MeasResults structure.
Definition: lte-rrc-sap.h:679
ns3::LteHandoverAlgorithm::GetLteHandoverManagementSapProvider
virtual LteHandoverManagementSapProvider * GetLteHandoverManagementSapProvider()=0
Export the "provider" part of the Handover Management SAP interface.
ns3::LteHandoverAlgorithm::~LteHandoverAlgorithm
virtual ~LteHandoverAlgorithm()
Definition: lte-handover-algorithm.cc:37
ns3::LteHandoverAlgorithm::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition: lte-handover-algorithm.cc:43
ns3::LteHandoverAlgorithm
The abstract base class of a handover algorithm that operates using the Handover Management SAP inter...
Definition: lte-handover-algorithm.h:67