A Discrete-Event Network Simulator
API
lte-ue-component-carrier-manager.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2015 Danilo Abrignani
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: Danilo Abrignani <danilo.abrignani@unibo.it>
19  *
20  */
21 
22 #ifndef LTE_UE_COMPONENT_CARRIER_MANAGER_H
23 #define LTE_UE_COMPONENT_CARRIER_MANAGER_H
24 
25 #include <ns3/object.h>
26 #include <ns3/lte-rrc-sap.h>
27 #include <ns3/lte-ue-ccm-rrc-sap.h>
28 #include <ns3/lte-mac-sap.h>
29 #include <map>
30 #include <vector>
31 
32 #define MIN_NO_CC 1
33 #define MAX_NO_CC 5 // this is the maximum number of carrier components allowed by 3GPP up to R13
34 
35 namespace ns3 {
36 
37 
38 class LteUeCcmRrcSapUser;
39 class LteUeCcmRrcSapProvider;
40 
41 class LteMacSapUser;
42 class LteMacSapProvider;
43 
44 
51 {
52 
53 public:
56 
61  static TypeId GetTypeId ();
62 
69  virtual void SetLteCcmRrcSapUser (LteUeCcmRrcSapUser* s);
70 
77 
84 
91  bool SetComponentCarrierMacSapProviders (uint8_t componentCarrierId, LteMacSapProvider* sap);
92 
97  void SetNumberOfComponentCarriers (uint8_t noOfComponentCarriers);
98 
99 protected:
100 
101  // inherited from Object
102  virtual void DoDispose ();
103 
106 
107  std::map<uint8_t, LteMacSapUser*> m_lcAttached;
108  std::map<uint8_t, std::map<uint8_t, LteMacSapProvider*> > m_componentCarrierLcMap;
110  std::map <uint8_t, LteMacSapProvider*> m_macSapProvidersMap;
111 
112 }; // end of class LteUeComponentCarrierManager
113 
114 
115 } // end of namespace ns3
116 
117 
118 #endif /* LTE_UE_COMPONENT_CARRIER_MANAGER_H */
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::LteMacSapProvider
Service Access Point (SAP) offered by the MAC to the RLC See Femto Forum MAC Scheduler Interface Spec...
Definition: lte-mac-sap.h:37
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::LteUeComponentCarrierManager::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition: lte-ue-component-carrier-manager.cc:42
ns3::LteUeComponentCarrierManager::m_macSapProvidersMap
std::map< uint8_t, LteMacSapProvider * > m_macSapProvidersMap
Map of pointers to SAP to interfaces of the MAC instance if the flows of this UE.
Definition: lte-ue-component-carrier-manager.h:110
ns3::LteUeComponentCarrierManager::LteUeComponentCarrierManager
LteUeComponentCarrierManager()
Definition: lte-ue-component-carrier-manager.cc:30
ns3::LteUeComponentCarrierManager::m_noOfComponentCarriers
uint16_t m_noOfComponentCarriers
// The number of component carriers that this UE can support.
Definition: lte-ue-component-carrier-manager.h:109
ns3::LteUeComponentCarrierManager::SetNumberOfComponentCarriers
void SetNumberOfComponentCarriers(uint8_t noOfComponentCarriers)
Sets number of component carriers that are supported by this UE.
Definition: lte-ue-component-carrier-manager.cc:96
ns3::LteUeCcmRrcSapUser
Service Access Point (SAP) offered by the UE RRC to the UE CCM.
Definition: lte-ue-ccm-rrc-sap.h:174
ns3::Object
A base class which provides memory management and object aggregation.
Definition: object.h:88
ns3::LteUeComponentCarrierManager
The abstract base class of a Component Carrier Manager* for UE that operates using the component carr...
Definition: lte-ue-component-carrier-manager.h:51
ns3::LteUeComponentCarrierManager::DoDispose
virtual void DoDispose()
Destructor implementation.
Definition: lte-ue-component-carrier-manager.cc:51
ns3::LteUeComponentCarrierManager::SetComponentCarrierMacSapProviders
bool SetComponentCarrierMacSapProviders(uint8_t componentCarrierId, LteMacSapProvider *sap)
Sets a pointer to SAP interface of MAC instance for the specified carrier.
Definition: lte-ue-component-carrier-manager.cc:72
ns3::LteUeComponentCarrierManager::m_lcAttached
std::map< uint8_t, LteMacSapUser * > m_lcAttached
Map of pointers to SAP interfaces of the RLC instance of the flows of this UE.
Definition: lte-ue-component-carrier-manager.h:107
ns3::LteUeComponentCarrierManager::m_ccmRrcSapUser
LteUeCcmRrcSapUser * m_ccmRrcSapUser
Interface to the UE RRC instance.
Definition: lte-ue-component-carrier-manager.h:104
ns3::LteUeComponentCarrierManager::m_ccmRrcSapProvider
LteUeCcmRrcSapProvider * m_ccmRrcSapProvider
Receive API calls from the UE RRC instance.
Definition: lte-ue-component-carrier-manager.h:105
ns3::LteUeComponentCarrierManager::GetLteCcmRrcSapProvider
virtual LteUeCcmRrcSapProvider * GetLteCcmRrcSapProvider()
Exports the "provider" part of the ComponentCarrier Management SAP interface.
Definition: lte-ue-component-carrier-manager.cc:64
ns3::LteUeCcmRrcSapProvider
Service Access Point (SAP) offered by the UE component carrier manager to the UE RRC.
Definition: lte-ue-ccm-rrc-sap.h:45
ns3::LteUeComponentCarrierManager::~LteUeComponentCarrierManager
virtual ~LteUeComponentCarrierManager()
Definition: lte-ue-component-carrier-manager.cc:36
ns3::LteUeComponentCarrierManager::m_componentCarrierLcMap
std::map< uint8_t, std::map< uint8_t, LteMacSapProvider * > > m_componentCarrierLcMap
Flow configuration per flow Id of this UE.
Definition: lte-ue-component-carrier-manager.h:108
ns3::LteUeComponentCarrierManager::SetLteCcmRrcSapUser
virtual void SetLteCcmRrcSapUser(LteUeCcmRrcSapUser *s)
Set the "user" part of the ComponentCarrier Management SAP interface that this UE component carrier m...
Definition: lte-ue-component-carrier-manager.cc:57
ns3::LteUeComponentCarrierManager::GetLteMacSapProvider
virtual LteMacSapProvider * GetLteMacSapProvider()=0
Returns the MAC sap provider interface that if forwarding calls to the instance of the LteUeComponent...