A Discrete-Event Network Simulator
API
no-op-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 NO_OP_HANDOVER_ALGORITHM_H
23 #define NO_OP_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 
29 namespace ns3 {
30 
31 
41 class NoOpHandoverAlgorithm : public LteHandoverAlgorithm
42 {
43 public:
45  NoOpHandoverAlgorithm ();
46 
47  virtual ~NoOpHandoverAlgorithm ();
48 
53  static TypeId GetTypeId ();
54 
55  // inherited from LteHandoverAlgorithm
56  virtual void SetLteHandoverManagementSapUser (LteHandoverManagementSapUser* s);
57  virtual LteHandoverManagementSapProvider* GetLteHandoverManagementSapProvider ();
58 
60  friend class MemberLteHandoverManagementSapProvider<NoOpHandoverAlgorithm>;
61 
62 protected:
63  // inherited from Object
64  virtual void DoInitialize ();
65  virtual void DoDispose ();
66 
67  // inherited from LteHandoverAlgorithm as a Handover Management SAP implementation
68  void DoReportUeMeas (uint16_t rnti, LteRrcSap::MeasResults measResults);
69 
70 private:
72  LteHandoverManagementSapUser* m_handoverManagementSapUser;
74  LteHandoverManagementSapProvider* m_handoverManagementSapProvider;
75 
76 }; // end of class NoOpHandoverAlgorithm
77 
78 
79 } // end of namespace ns3
80 
81 
82 #endif /* NO_OP_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::NoOpHandoverAlgorithm::m_handoverManagementSapProvider
LteHandoverManagementSapProvider * m_handoverManagementSapProvider
Receive API calls from the eNodeB RRC instance.
Definition: no-op-handover-algorithm.h:74
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::NoOpHandoverAlgorithm::m_handoverManagementSapUser
LteHandoverManagementSapUser * m_handoverManagementSapUser
Interface to the eNodeB RRC instance.
Definition: no-op-handover-algorithm.h:72
ns3::MemberLteHandoverManagementSapProvider
Template for the implementation of the LteHandoverManagementSapProvider as a member of an owner class...
Definition: lte-handover-management-sap.h:116
ns3::NoOpHandoverAlgorithm::GetLteHandoverManagementSapProvider
virtual LteHandoverManagementSapProvider * GetLteHandoverManagementSapProvider()
Export the "provider" part of the Handover Management SAP interface.
Definition: no-op-handover-algorithm.cc:75
ns3::NoOpHandoverAlgorithm::NoOpHandoverAlgorithm
NoOpHandoverAlgorithm()
Creates a No-op handover algorithm instance.
Definition: no-op-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::NoOpHandoverAlgorithm::DoReportUeMeas
void DoReportUeMeas(uint16_t rnti, LteRrcSap::MeasResults measResults)
Implementation of LteHandoverManagementSapProvider::ReportUeMeas.
Definition: no-op-handover-algorithm.cc:91
ns3::NoOpHandoverAlgorithm::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition: no-op-handover-algorithm.cc:55
ns3::NoOpHandoverAlgorithm::DoInitialize
virtual void DoInitialize()
Initialize() implementation.
Definition: no-op-handover-algorithm.cc:83
ns3::LteRrcSap::MeasResults
MeasResults structure.
Definition: lte-rrc-sap.h:679
ns3::NoOpHandoverAlgorithm::~NoOpHandoverAlgorithm
virtual ~NoOpHandoverAlgorithm()
Definition: no-op-handover-algorithm.cc:40
ns3::NoOpHandoverAlgorithm::SetLteHandoverManagementSapUser
virtual void SetLteHandoverManagementSapUser(LteHandoverManagementSapUser *s)
Set the "user" part of the Handover Management SAP interface that this handover algorithm instance wi...
Definition: no-op-handover-algorithm.cc:67
ns3::NoOpHandoverAlgorithm::DoDispose
virtual void DoDispose()
Destructor implementation.
Definition: no-op-handover-algorithm.cc:47
ns3::NoOpHandoverAlgorithm
Handover algorithm implementation which simply does nothing.
Definition: no-op-handover-algorithm.h:42
ns3::LteHandoverAlgorithm
The abstract base class of a handover algorithm that operates using the Handover Management SAP inter...
Definition: lte-handover-algorithm.h:67