/usr/include/ns3.27/ns3/lte-enb-net-device.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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2010 TELEMATICS LAB, DEE - Politecnico di Bari
*
* 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: Giuseppe Piro <g.piro@poliba.it>
* Author: Marco Miozzo <marco.miozzo@cttc.es> : Update to FF API Architecture
* Author: Danilo Abrignani <danilo.abrignani@unibo.it> : Integrated with new architecture - GSoC 2015 - Carrier Aggregation
*/
#ifndef LTE_ENB_NET_DEVICE_H
#define LTE_ENB_NET_DEVICE_H
#include "ns3/lte-net-device.h"
#include "ns3/event-id.h"
#include "ns3/mac48-address.h"
#include "ns3/traced-callback.h"
#include "ns3/nstime.h"
#include "ns3/lte-phy.h"
#include "ns3/component-carrier-enb.h"
#include <vector>
#include <map>
namespace ns3 {
class Packet;
class PacketBurst;
class Node;
class LtePhy;
class LteEnbPhy;
class LteEnbMac;
class LteEnbRrc;
class FfMacScheduler;
class LteHandoverAlgorithm;
class LteAnr;
class LteFfrAlgorithm;
class LteEnbComponentCarrierManager;
/**
* \ingroup lte
*
* The eNodeB device implementation
*/
class LteEnbNetDevice : public LteNetDevice
{
public:
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
LteEnbNetDevice ();
virtual ~LteEnbNetDevice (void);
virtual void DoDispose (void);
// inherited from NetDevice
virtual bool Send (Ptr<Packet> packet, const Address& dest, uint16_t protocolNumber);
/**
* \return a pointer to the MAC of the PCC.
*/
Ptr<LteEnbMac> GetMac (void) const;
/**
* \param index CC index
* \return a pointer to the MAC of the CC addressed by index.
*/
Ptr<LteEnbMac> GetMac (uint8_t index);
/**
* \return a pointer to the physical layer of the PCC.
*/
Ptr<LteEnbPhy> GetPhy (void) const;
/**
* \param index SCC index
* \return a pointer to the physical layer of the SCC addressed by index.
*/
Ptr<LteEnbPhy> GetPhy (uint8_t index);
/**
* \return a pointer to the Radio Resource Control instance of the eNB
*/
Ptr<LteEnbRrc> GetRrc () const;
/**
* \return a pointer to the ComponentCarrierManager instance of the eNB
*/
Ptr<LteEnbComponentCarrierManager> GetComponentCarrierManager () const;
/**
* \return the Cell Identifier of this eNB
*/
uint16_t GetCellId () const;
/**
* \param cellId cell ID
* \return true if cellId is served by this eNB
*/
bool HasCellId (uint16_t cellId) const;
/**
* \return the uplink bandwidth in RBs
*/
uint8_t GetUlBandwidth () const;
/**
* \param bw the uplink bandwidth in RBs
*/
void SetUlBandwidth (uint8_t bw);
/**
* \return the downlink bandwidth in RBs
*/
uint8_t GetDlBandwidth () const;
/**
* \param bw the downlink bandwidth in RBs
*/
void SetDlBandwidth (uint8_t bw);
/**
* \return the downlink carrier frequency (EARFCN)
*/
uint32_t GetDlEarfcn () const;
/**
* \param earfcn the downlink carrier frequency (EARFCN)
*/
void SetDlEarfcn (uint32_t earfcn);
/**
* \return the uplink carrier frequency (EARFCN)
*/
uint32_t GetUlEarfcn () const;
/**
* \param earfcn the uplink carrier frequency (EARFCN)
*/
void SetUlEarfcn (uint32_t earfcn);
/**
* \brief Returns the CSG ID of the eNodeB.
* \return the Closed Subscriber Group identity
* \sa LteEnbNetDevice::SetCsgId
*/
uint32_t GetCsgId () const;
/**
* \brief Associate the eNodeB device with a particular CSG.
* \param csgId the intended Closed Subscriber Group identity
*
* CSG identity is a number identifying a Closed Subscriber Group which the
* cell belongs to. eNodeB is associated with a single CSG identity.
*
* The same CSG identity can also be associated to several UEs, which is
* equivalent as enlisting these UEs as the members of this particular CSG.
*
* \sa LteEnbNetDevice::SetCsgIndication
*/
void SetCsgId (uint32_t csgId);
/**
* \brief Returns the CSG indication flag of the eNodeB.
* \return the CSG indication flag
* \sa LteEnbNetDevice::SetCsgIndication
*/
bool GetCsgIndication () const;
/**
* \brief Enable or disable the CSG indication flag.
* \param csgIndication if TRUE, only CSG members are allowed to access this
* cell
*
* When the CSG indication field is set to TRUE, only UEs which are members of
* the CSG (i.e. same CSG ID) can gain access to the eNodeB, therefore
* enforcing closed access mode. Otherwise, the eNodeB operates as a non-CSG
* cell and implements open access mode.
*
* \note This restriction only applies to initial cell selection and
* EPC-enabled simulation.
*
* \sa LteEnbNetDevice::SetCsgIndication
*/
void SetCsgIndication (bool csgIndication);
/**
* \brief Set the ComponentCarrier Map of the Enb
* \param ccm the map of ComponentCarrierEnb
*
*/
void SetCcMap (std::map< uint8_t, Ptr<ComponentCarrierEnb> > ccm);
/**
* \returns The Component Carrier Map of the Enb.
*
*/
std::map< uint8_t, Ptr<ComponentCarrierEnb> > GetCcMap (void);
protected:
// inherited from Object
virtual void DoInitialize (void);
private:
bool m_isConstructed; ///< is constructed?
bool m_isConfigured; ///< is configured?
/**
* \brief Propagate attributes and configuration to sub-modules.
*
* Several attributes (e.g., the bandwidth) are exported as the attributes of
* the LteEnbNetDevice from a user perspective, but are actually used also in
* other sub-modules (the RRC, the PHY, the scheduler, etc.). This method
* takes care of updating the configuration of all these sub-modules so that
* their copy of attribute values are in sync with the one in
* the LteEnbNetDevice.
*/
void UpdateConfig ();
Ptr<LteEnbRrc> m_rrc; ///< the RRC
Ptr<LteHandoverAlgorithm> m_handoverAlgorithm; ///< the handover algorithm
Ptr<LteAnr> m_anr; ///< ANR
Ptr<LteFfrAlgorithm> m_ffrAlgorithm; /**< DEPRECATED - It is maintained for backward compatibility after adding CA feature*/
uint16_t m_cellId; /**< Cell Identifer. Part of the CGI, see TS 29.274, section 8.21.1 */
uint8_t m_dlBandwidth; /**<DEPRECATE - It is maintained for backward compatibility after adding CA feature- downlink bandwidth in RBs */
uint8_t m_ulBandwidth; /**<DEPRECATE - It is maintained for backward compatibility after adding CA feature- uplink bandwidth in RBs */
uint32_t m_dlEarfcn; /**<DEPRECATE - It is maintained for backward compatibility after adding CA feature- downlink carrier frequency */
uint32_t m_ulEarfcn; /**<DEPRECATE - It is maintained for backward compatibility after adding CA feature- uplink carrier frequency */
uint16_t m_csgId; ///< CSG ID
bool m_csgIndication; ///< CSG indication
std::map < uint8_t, Ptr<ComponentCarrierEnb> > m_ccMap; /**< ComponentCarrier map */
Ptr<LteEnbComponentCarrierManager> m_componentCarrierManager; ///< the component carrier manager of this eNb
}; // end of class LteEnbNetDevice
} // namespace ns3
#endif /* LTE_ENB_NET_DEVICE_H */
|