/usr/include/ns3.27/ns3/component-carrier.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 | /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2015 Danilo Abrignani
*
* 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: Danilo Abrignani <danilo.abrignani@unibo.it>
*/
#ifndef COMPONENT_CARRIER_H
#define COMPONENT_CARRIER_H
#include <ns3/object.h>
#include <ns3/packet.h>
#include <ns3/nstime.h>
#include "ns3/lte-phy.h"
#include <ns3/lte-enb-phy.h>
#include <ns3/pointer.h>
namespace ns3 {
/**
* \ingroup lte
*
* ComponentCarrier Object, it defines a single Carrier
* This is the parent class for both ComponentCarrierEnb
* and ComponentCarrierUe.
* This class contains the main physical configuration
* parameters for a carrier. Does not contain pointers to
* the MAC/PHY objects of the carrier.
*/
class ComponentCarrier : public Object
{
public:
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
ComponentCarrier ();
virtual ~ComponentCarrier (void);
virtual void DoDispose (void);
/**
* \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 as primary carrier
* \param primaryCarrier true to set as primary carrier
*/
void SetAsPrimary (bool primaryCarrier);
/**
* \brief Checks if the carrier is the primary carrier
* \returns true if the carrier is primary
*/
bool IsPrimary () const;
uint8_t m_dlBandwidth; /**< downlink bandwidth in RBs */
uint8_t m_ulBandwidth; /**< uplink bandwidth in RBs */
uint32_t m_dlEarfcn; /**< downlink carrier frequency */
uint32_t m_ulEarfcn; /**< uplink carrier frequency */
protected:
// inherited from Object
virtual void DoInitialize (void);
uint16_t m_csgId; ///< CSG ID
bool m_csgIndication; ///< CSG indication
bool m_primaryCarrier; ///< whether the carrier is primary
bool m_isConstructed; ///< whether the instance is constructed
// bool m_isConfigured;
};
} // namespace ns3
#endif /* COMPONENT_CARRIER_H */
|