Creation and configuration of LTE entities. More...
#include "lte-helper.h"
Public Member Functions | |
LteHelper () | |
~LteHelper () override | |
void | ActivateDataRadioBearer (NetDeviceContainer ueDevices, EpsBearer bearer) |
Activate a Data Radio Bearer on a given UE devices (for LTE-only simulation). | |
void | ActivateDataRadioBearer (Ptr< NetDevice > ueDevice, EpsBearer bearer) |
Activate a Data Radio Bearer on a UE device (for LTE-only simulation). | |
uint8_t | ActivateDedicatedEpsBearer (NetDeviceContainer ueDevices, EpsBearer bearer, Ptr< EpcTft > tft) |
Activate a dedicated EPS bearer on a given set of UE devices. | |
uint8_t | ActivateDedicatedEpsBearer (Ptr< NetDevice > ueDevice, EpsBearer bearer, Ptr< EpcTft > tft) |
Activate a dedicated EPS bearer on a given UE device. | |
void | AddX2Interface (NodeContainer enbNodes) |
Create an X2 interface between all the eNBs in a given set. | |
void | AddX2Interface (Ptr< Node > enbNode1, Ptr< Node > enbNode2) |
Create an X2 interface between two eNBs. | |
int64_t | AssignStreams (NetDeviceContainer c, int64_t stream) |
Assign a fixed random variable stream number to the random variables used. | |
void | Attach (NetDeviceContainer ueDevices) |
Enables automatic attachment of a set of UE devices to a suitable cell using Idle mode initial cell selection procedure. | |
void | Attach (NetDeviceContainer ueDevices, Ptr< NetDevice > enbDevice) |
Manual attachment of a set of UE devices to the network via a given eNodeB. | |
void | Attach (Ptr< NetDevice > ueDevice) |
Enables automatic attachment of a UE device to a suitable cell using Idle mode initial cell selection procedure. | |
void | Attach (Ptr< NetDevice > ueDevice, Ptr< NetDevice > enbDevice, uint8_t componentCarrierId=0) |
Manual attachment of a UE device to the network via a given eNodeB. | |
void | AttachToClosestEnb (NetDeviceContainer ueDevices, NetDeviceContainer enbDevices) |
Manual attachment of a set of UE devices to the network via the closest eNodeB (with respect to distance) among those in the set. | |
void | AttachToClosestEnb (Ptr< NetDevice > ueDevice, NetDeviceContainer enbDevices) |
Manual attachment of a UE device to the network via the closest eNodeB (with respect to distance) among those in the set. | |
void | DeActivateDedicatedEpsBearer (Ptr< NetDevice > ueDevice, Ptr< NetDevice > enbDevice, uint8_t bearerId) |
Manually trigger dedicated bearer de-activation at specific simulation time. | |
void | DoDispose () override |
Destructor implementation. | |
void | EnableDlMacTraces () |
Enable trace sinks for DL MAC layer. | |
void | EnableDlPhyTraces () |
Enable trace sinks for DL PHY layer. | |
void | EnableDlRxPhyTraces () |
Enable trace sinks for DL reception PHY layer. | |
void | EnableDlTxPhyTraces () |
Enable trace sinks for DL transmission PHY layer. | |
void | EnableLogComponents () |
Enables full-blown logging for major components of the LENA architecture. | |
void | EnableMacTraces () |
Enable trace sinks for MAC layer. | |
void | EnablePdcpTraces () |
Enable trace sinks for PDCP layer. | |
void | EnablePhyTraces () |
Enable trace sinks for PHY layer. | |
void | EnableRlcTraces () |
Enable trace sinks for RLC layer. | |
void | EnableTraces () |
Enables trace sinks for PHY, MAC, RLC and PDCP. | |
void | EnableUlMacTraces () |
Enable trace sinks for UL MAC layer. | |
void | EnableUlPhyTraces () |
Enable trace sinks for UL PHY layer. | |
void | EnableUlRxPhyTraces () |
Enable trace sinks for UL reception PHY layer. | |
void | EnableUlTxPhyTraces () |
Enable trace sinks for UL transmission PHY layer. | |
Ptr< SpectrumChannel > | GetDownlinkSpectrumChannel () const |
std::string | GetEnbComponentCarrierManagerType () const |
std::string | GetFfrAlgorithmType () const |
std::string | GetHandoverAlgorithmType () const |
Ptr< RadioBearerStatsCalculator > | GetPdcpStats () |
Ptr< RadioBearerStatsCalculator > | GetRlcStats () |
std::string | GetSchedulerType () const |
std::string | GetUeComponentCarrierManagerType () const |
Ptr< SpectrumChannel > | GetUplinkSpectrumChannel () const |
void | HandoverRequest (Time hoTime, Ptr< NetDevice > ueDev, Ptr< NetDevice > sourceEnbDev, Ptr< NetDevice > targetEnbDev) |
Manually trigger an X2-based handover. | |
void | HandoverRequest (Time hoTime, Ptr< NetDevice > ueDev, Ptr< NetDevice > sourceEnbDev, uint16_t targetCellId) |
Manually trigger an X2-based handover. | |
NetDeviceContainer | InstallEnbDevice (NodeContainer c) |
Create a set of eNodeB devices. | |
NetDeviceContainer | InstallUeDevice (NodeContainer c) |
Create a set of UE devices. | |
void | SetEnbAntennaModelAttribute (std::string n, const AttributeValue &v) |
Set an attribute for the eNodeB antenna model to be created. | |
void | SetEnbAntennaModelType (std::string type) |
Set the type of antenna model to be used by eNodeB devices. | |
void | SetEnbComponentCarrierManagerAttribute (std::string n, const AttributeValue &v) |
Set an attribute for the enb component carrier manager to be created. | |
void | SetEnbComponentCarrierManagerType (std::string type) |
Set the type of carrier component algorithm to be used by eNodeB devices. | |
void | SetEnbDeviceAttribute (std::string n, const AttributeValue &v) |
Set an attribute for the eNodeB devices (LteEnbNetDevice) to be created. | |
void | SetEpcHelper (Ptr< EpcHelper > h) |
Set the EpcHelper to be used to setup the EPC network in conjunction with the setup of the LTE radio access network. | |
void | SetFadingModel (std::string type) |
Set the type of fading model to be used in both DL and UL. | |
void | SetFadingModelAttribute (std::string n, const AttributeValue &v) |
Set an attribute for the fading model to be created (both DL and UL). | |
void | SetFfrAlgorithmAttribute (std::string n, const AttributeValue &v) |
Set an attribute for the FFR algorithm to be created. | |
void | SetFfrAlgorithmType (std::string type) |
Set the type of FFR algorithm to be used by eNodeB devices. | |
void | SetHandoverAlgorithmAttribute (std::string n, const AttributeValue &v) |
Set an attribute for the handover algorithm to be created. | |
void | SetHandoverAlgorithmType (std::string type) |
Set the type of handover algorithm to be used by eNodeB devices. | |
void | SetPathlossModelAttribute (std::string n, const AttributeValue &v) |
Set an attribute for the path loss models to be created. | |
void | SetPathlossModelType (TypeId type) |
Set the type of path loss model to be used for both DL and UL channels. | |
void | SetSchedulerAttribute (std::string n, const AttributeValue &v) |
Set an attribute for the scheduler to be created. | |
void | SetSchedulerType (std::string type) |
Set the type of scheduler to be used by eNodeB devices. | |
void | SetSpectrumChannelAttribute (std::string n, const AttributeValue &v) |
Set an attribute for the spectrum channel to be created (both DL and UL). | |
void | SetSpectrumChannelType (std::string type) |
Set the type of spectrum channel to be used in both DL and UL. | |
void | SetUeAntennaModelAttribute (std::string n, const AttributeValue &v) |
Set an attribute for the UE antenna model to be created. | |
void | SetUeAntennaModelType (std::string type) |
Set the type of antenna model to be used by UE devices. | |
void | SetUeComponentCarrierManagerAttribute (std::string n, const AttributeValue &v) |
Set an attribute for the ue component carrier manager to be created. | |
void | SetUeComponentCarrierManagerType (std::string type) |
Set the type of Component Carrier Manager to be used by Ue devices. | |
void | SetUeDeviceAttribute (std::string n, const AttributeValue &v) |
Set an attribute for the UE devices (LteUeNetDevice) to be created. | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Member Functions | |
void | DoInitialize () override |
Initialize() implementation. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Private Member Functions | |
void | ChannelModelInitialization () |
Function that performs a channel model initialization of all component carriers. | |
void | DoComponentCarrierConfigure (uint32_t ulEarfcn, uint32_t dlEarfcn, uint16_t ulbw, uint16_t dlbw) |
Configure the component carriers. | |
void | DoDeActivateDedicatedEpsBearer (Ptr< NetDevice > ueDevice, Ptr< NetDevice > enbDevice, uint8_t bearerId) |
The actual function to trigger a manual bearer de-activation. | |
void | DoHandoverRequest (Ptr< NetDevice > ueDev, Ptr< NetDevice > sourceEnbDev, uint16_t targetCellId) |
The actual function to trigger a manual handover. | |
Ptr< NetDevice > | InstallSingleEnbDevice (Ptr< Node > n) |
Create an eNodeB device (LteEnbNetDevice) on the given node. | |
Ptr< NetDevice > | InstallSingleUeDevice (Ptr< Node > n) |
Create a UE device (LteUeNetDevice) on the given node. | |
Private Attributes | |
uint16_t | m_cellIdCounter |
Keep track of the number of cell ID allocated. | |
ObjectFactory | m_channelFactory |
Factory of both the downlink and uplink LTE channels. | |
std::map< uint8_t, ComponentCarrier > | m_componentCarrierPhyParams |
This contains all the information about each component carrier. | |
Ptr< SpectrumChannel > | m_downlinkChannel |
This function create the component carrier based on provided configuration parameters. | |
Ptr< Object > | m_downlinkPathlossModel |
The path loss model used in the downlink channel. | |
ObjectFactory | m_enbAntennaModelFactory |
Factory of antenna object for eNodeB. | |
ObjectFactory | m_enbComponentCarrierManagerFactory |
Factory of enb component carrier manager object. | |
ObjectFactory | m_enbNetDeviceFactory |
Factory of LteEnbNetDevice objects. | |
Ptr< EpcHelper > | m_epcHelper |
Helper which provides implementation of core network. | |
Ptr< SpectrumPropagationLossModel > | m_fadingModel |
The fading model used in both the downlink and uplink channels. | |
ObjectFactory | m_fadingModelFactory |
Factory of fading model object for both the downlink and uplink channels. | |
std::string | m_fadingModelType |
Name of fading model type, e.g., "ns3::TraceFadingLossModel". | |
bool | m_fadingStreamsAssigned |
True if a random variable stream number has been assigned for the fading model. | |
ObjectFactory | m_ffrAlgorithmFactory |
Factory of FFR (frequency reuse) algorithm object. | |
ObjectFactory | m_handoverAlgorithmFactory |
Factory of handover algorithm object. | |
uint64_t | m_imsiCounter |
Keep track of the number of IMSI allocated. | |
bool | m_isAnrEnabled |
The AnrEnabled attribute. | |
Ptr< MacStatsCalculator > | m_macStats |
Container of MAC layer statistics. | |
uint16_t | m_noOfCcs |
Number of component carriers that will be installed by default at eNodeB and UE devices. | |
ObjectFactory | m_pathlossModelFactory |
Factory of path loss model object. | |
Ptr< RadioBearerStatsCalculator > | m_pdcpStats |
Container of PDCP layer statistics. | |
Ptr< PhyRxStatsCalculator > | m_phyRxStats |
Container of PHY layer statistics related to reception. | |
Ptr< PhyStatsCalculator > | m_phyStats |
Container of PHY layer statistics. | |
Ptr< PhyTxStatsCalculator > | m_phyTxStats |
Container of PHY layer statistics related to transmission. | |
RadioBearerStatsConnector | m_radioBearerStatsConnector |
Connects RLC and PDCP statistics containers to appropriate trace sources. | |
Ptr< RadioBearerStatsCalculator > | m_rlcStats |
Container of RLC layer statistics. | |
ObjectFactory | m_schedulerFactory |
Factory of MAC scheduler object. | |
ObjectFactory | m_ueAntennaModelFactory |
Factory of antenna object for UE. | |
ObjectFactory | m_ueComponentCarrierManagerFactory |
Factory of ue component carrier manager object. | |
ObjectFactory | m_ueNetDeviceFactory |
Factory for LteUeNetDevice objects. | |
Ptr< SpectrumChannel > | m_uplinkChannel |
The uplink LTE channel used in the simulation. | |
Ptr< Object > | m_uplinkPathlossModel |
The path loss model used in the uplink channel. | |
bool | m_useCa |
The UseCa attribute. | |
bool | m_useIdealRrc |
The UseIdealRrc attribute. | |
bool | m_usePdschForCqiGeneration |
The UsePdschForCqiGeneration attribute. | |
Additional Inherited Members | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Creation and configuration of LTE entities.
Introspection did not find any typical Config paths.
One LteHelper instance is typically enough for an LTE simulation. To create it:
Ptr<LteHelper> lteHelper = CreateObject<LteHelper> ();
The general responsibility of the helper is to create various LTE objects and arrange them together to make the whole LTE system. The overall arrangement would look like the following:
Spetrum channels are created automatically: one for DL, and one for UL. eNodeB devices are created by calling InstallEnbDevice(), while UE devices are created by calling InstallUeDevice(). EPC helper can be set by using SetEpcHelper().
std::string
std::string
std::string
std::string
TypeId
std::string
std::string
No TraceSources are defined for this type.
Size of this type is 576 bytes (on a 64-bit architecture).
Definition at line 102 of file lte-helper.h.
ns3::LteHelper::LteHelper | ( | ) |
Definition at line 80 of file lte-helper.cc.
References ns3::IsotropicAntennaModel::GetTypeId(), ns3::LteEnbNetDevice::GetTypeId(), ns3::LteUeNetDevice::GetTypeId(), ns3::MultiModelSpectrumChannel::GetTypeId(), m_channelFactory, m_enbAntennaModelFactory, m_enbNetDeviceFactory, m_ueAntennaModelFactory, m_ueNetDeviceFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::SetTypeId().
|
override |
Definition at line 105 of file lte-helper.cc.
References NS_LOG_FUNCTION.
void ns3::LteHelper::ActivateDataRadioBearer | ( | NetDeviceContainer | ueDevices, |
EpsBearer | bearer | ||
) |
Activate a Data Radio Bearer on a given UE devices (for LTE-only simulation).
ueDevices | the set of UE devices |
bearer | the characteristics of the bearer to be activated |
Definition at line 1444 of file lte-helper.cc.
References ActivateDataRadioBearer(), ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), and NS_LOG_FUNCTION.
Referenced by ActivateDataRadioBearer(), LteRrcConnectionEstablishmentTestCase::Connect(), LteX2HandoverMeasuresTestCase::DoRun(), and LteX2HandoverTestCase::DoRun().
Activate a Data Radio Bearer on a UE device (for LTE-only simulation).
This method will schedule the actual activation the bearer so that it happens after the UE got connected.
ueDevice | the UE device |
bearer | the characteristics of the bearer to be activated |
Definition at line 1301 of file lte-helper.cc.
References ns3::DrbActivator::ActivateCallback(), ns3::Config::Connect(), m_epcHelper, ns3::MakeBoundCallback(), NS_ASSERT_MSG, and NS_LOG_FUNCTION.
uint8_t ns3::LteHelper::ActivateDedicatedEpsBearer | ( | NetDeviceContainer | ueDevices, |
EpsBearer | bearer, | ||
Ptr< EpcTft > | tft | ||
) |
Activate a dedicated EPS bearer on a given set of UE devices.
ueDevices | the set of UE devices |
bearer | the characteristics of the bearer to be activated |
tft | the Traffic Flow Template that identifies the traffic to go on this bearer |
Definition at line 1162 of file lte-helper.cc.
References ActivateDedicatedEpsBearer(), ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), and NS_LOG_FUNCTION.
Referenced by ActivateDedicatedEpsBearer(), LteX2HandoverMeasuresTestCase::DoRun(), and LteX2HandoverTestCase::DoRun().
uint8_t ns3::LteHelper::ActivateDedicatedEpsBearer | ( | Ptr< NetDevice > | ueDevice, |
EpsBearer | bearer, | ||
Ptr< EpcTft > | tft | ||
) |
Activate a dedicated EPS bearer on a given UE device.
ueDevice | the UE device |
bearer | the characteristics of the bearer to be activated |
tft | the Traffic Flow Template that identifies the traffic to go on this bearer. |
Definition at line 1176 of file lte-helper.cc.
References m_epcHelper, NS_ASSERT_MSG, and NS_LOG_FUNCTION.
void ns3::LteHelper::AddX2Interface | ( | NodeContainer | enbNodes | ) |
Create an X2 interface between all the eNBs in a given set.
enbNodes | the set of eNB nodes |
Definition at line 1321 of file lte-helper.cc.
References AddX2Interface(), ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), m_epcHelper, NS_ASSERT_MSG, and NS_LOG_FUNCTION.
Referenced by AddX2Interface(), LteX2HandoverMeasuresTestCase::DoRun(), and LteX2HandoverTestCase::DoRun().
Create an X2 interface between two eNBs.
enbNode1 | one eNB of the X2 interface |
enbNode2 | the other eNB of the X2 interface |
Definition at line 1337 of file lte-helper.cc.
References m_epcHelper, NS_LOG_FUNCTION, and NS_LOG_INFO.
int64_t ns3::LteHelper::AssignStreams | ( | NetDeviceContainer | c, |
int64_t | stream | ||
) |
Assign a fixed random variable stream number to the random variables used.
The InstallEnbDevice() or InstallUeDevice method should have previously been called by the user on the given devices.
If TraceFadingLossModel has been set as the fading model type, this method will also assign a stream number to it, if none has been assigned before.
If an EPC has been configured, streams will be assigned on the EPC nodes as well via EpcHelper::AssignStreams ().
c | NetDeviceContainer of the set of net devices for which the LteNetDevice should be modified to use a fixed stream |
stream | first stream index to use |
Definition at line 1575 of file lte-helper.cc.
References ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), m_epcHelper, m_fadingModel, and m_fadingStreamsAssigned.
Referenced by LteRrcConnectionEstablishmentTestCase::DoRun(), LteRrcConnectionEstablishmentErrorTestCase::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), and LteX2HandoverTestCase::DoRun().
void ns3::LteHelper::Attach | ( | NetDeviceContainer | ueDevices | ) |
Enables automatic attachment of a set of UE devices to a suitable cell using Idle mode initial cell selection procedure.
ueDevices | the set of UE devices to be attached |
By calling this, the UE will start the initial cell selection procedure at the beginning of simulation. In addition, the function also instructs each UE to immediately enter CONNECTED mode and activates the default EPS bearer.
If this function is called when the UE is in a situation where entering CONNECTED mode is not possible (e.g. before the simulation begin), then the UE will attempt to connect at the earliest possible time (e.g. after it camps to a suitable cell).
Note that this function can only be used in EPC-enabled simulation.
Definition at line 1047 of file lte-helper.cc.
References Attach(), ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), and NS_LOG_FUNCTION.
Referenced by Attach(), AttachToClosestEnb(), LteRrcConnectionEstablishmentTestCase::Connect(), LteX2HandoverMeasuresTestCase::DoRun(), and LteX2HandoverTestCase::DoRun().
void ns3::LteHelper::Attach | ( | NetDeviceContainer | ueDevices, |
Ptr< NetDevice > | enbDevice | ||
) |
Manual attachment of a set of UE devices to the network via a given eNodeB.
ueDevices | the set of UE devices to be attached |
enbDevice | the destination eNodeB device |
In addition, the function also instructs each UE to immediately enter CONNECTED mode and activates the default EPS bearer.
The function can be used in both LTE-only and EPC-enabled simulations. Note that this function will disable Idle mode initial cell selection procedure.
Definition at line 1089 of file lte-helper.cc.
References Attach(), ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), and NS_LOG_FUNCTION.
Enables automatic attachment of a UE device to a suitable cell using Idle mode initial cell selection procedure.
ueDevice | the UE device to be attached |
By calling this, the UE will start the initial cell selection procedure at the beginning of simulation. In addition, the function also instructs the UE to immediately enter CONNECTED mode and activates the default EPS bearer.
If this function is called when the UE is in a situation where entering CONNECTED mode is not possible (e.g. before the simulation begin), then the UE will attempt to connect at the earliest possible time (e.g. after it camps to a suitable cell).
Note that this function can only be used in EPC-enabled simulation.
Definition at line 1057 of file lte-helper.cc.
References ns3::EpcTft::Default(), m_epcHelper, ns3::EpsBearer::NGBR_VIDEO_TCP_DEFAULT, NS_ASSERT, NS_FATAL_ERROR, and NS_LOG_FUNCTION.
void ns3::LteHelper::Attach | ( | Ptr< NetDevice > | ueDevice, |
Ptr< NetDevice > | enbDevice, | ||
uint8_t | componentCarrierId = 0 |
||
) |
Manual attachment of a UE device to the network via a given eNodeB.
ueDevice | the UE device to be attached |
enbDevice | the destination eNodeB device |
componentCarrierId | the destination eNodeB component carrier |
In addition, the function also instructs the UE to immediately enter CONNECTED mode and activates the default EPS bearer.
The function can be used in both LTE-only and EPC-enabled simulations. Note that this function will disable Idle mode initial cell selection procedure.
Definition at line 1099 of file lte-helper.cc.
References ns3::EpcTft::Default(), m_epcHelper, ns3::EpsBearer::NGBR_VIDEO_TCP_DEFAULT, and NS_LOG_FUNCTION.
void ns3::LteHelper::AttachToClosestEnb | ( | NetDeviceContainer | ueDevices, |
NetDeviceContainer | enbDevices | ||
) |
Manual attachment of a set of UE devices to the network via the closest eNodeB (with respect to distance) among those in the set.
ueDevices | the set of UE devices to be attached |
enbDevices | the set of eNodeB devices to be considered |
This function finds among the eNodeB set the closest eNodeB for each UE, and then invokes manual attachment between the pair.
Users are encouraged to use automatic attachment (Idle mode cell selection) instead of this function.
Definition at line 1130 of file lte-helper.cc.
References AttachToClosestEnb(), ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), and NS_LOG_FUNCTION.
Referenced by AttachToClosestEnb().
void ns3::LteHelper::AttachToClosestEnb | ( | Ptr< NetDevice > | ueDevice, |
NetDeviceContainer | enbDevices | ||
) |
Manual attachment of a UE device to the network via the closest eNodeB (with respect to distance) among those in the set.
ueDevice | the UE device to be attached |
enbDevices | the set of eNodeB devices to be considered |
This function finds among the eNodeB set the closest eNodeB for the UE, and then invokes manual attachment between the pair.
Users are encouraged to use automatic attachment (Idle mode cell selection) instead of this function.
Definition at line 1140 of file lte-helper.cc.
References Attach(), ns3::NetDeviceContainer::Begin(), ns3::CalculateDistance(), ns3::NetDeviceContainer::End(), ns3::NetDeviceContainer::GetN(), NS_ASSERT, NS_ASSERT_MSG, and NS_LOG_FUNCTION.
|
private |
Function that performs a channel model initialization of all component carriers.
Definition at line 230 of file lte-helper.cc.
References ns3::ObjectFactory::Create(), ns3::Object::GetObject(), m_channelFactory, m_downlinkChannel, m_downlinkPathlossModel, m_fadingModel, m_fadingModelFactory, m_fadingModelType, m_noOfCcs, m_pathlossModelFactory, m_uplinkChannel, m_uplinkPathlossModel, NS_ASSERT_MSG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
Referenced by DoInitialize().
void ns3::LteHelper::DeActivateDedicatedEpsBearer | ( | Ptr< NetDevice > | ueDevice, |
Ptr< NetDevice > | enbDevice, | ||
uint8_t | bearerId | ||
) |
Manually trigger dedicated bearer de-activation at specific simulation time.
ueDevice | the UE on which dedicated bearer to be de-activated must be of the type LteUeNetDevice |
enbDevice | eNB, must be of the type LteEnbNetDevice |
bearerId | Bearer Identity which is to be de-activated |
Definition at line 1395 of file lte-helper.cc.
References DoDeActivateDedicatedEpsBearer(), m_epcHelper, NS_ASSERT_MSG, and NS_LOG_FUNCTION.
Referenced by ns3::LenaDeactivateBearerTestCase::DoRun().
|
private |
Configure the component carriers.
ulEarfcn | uplink EARFCN |
dlEarfcn | downlink EARFCN |
ulbw | uplink bandwidth for each CC |
dlbw | downlink bandwidth for each CC |
Definition at line 1425 of file lte-helper.cc.
References m_componentCarrierPhyParams, m_noOfCcs, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.
Referenced by InstallSingleEnbDevice(), and InstallSingleUeDevice().
|
private |
The actual function to trigger a manual bearer de-activation.
ueDevice | the UE on which bearer to be de-activated must be of the type LteUeNetDevice |
enbDevice | eNB, must be of the type LteEnbNetDevice |
bearerId | Bearer Identity which is to be de-activated |
This method is normally scheduled by DeActivateDedicatedEpsBearer() to run at a specific time when a manual bearer de-activation is desired by the simulation user.
Definition at line 1409 of file lte-helper.cc.
References NS_LOG_FUNCTION.
Referenced by DeActivateDedicatedEpsBearer().
|
overridevirtual |
Destructor implementation.
This method is called by Dispose() or by the Object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.
It is safe to call GetObject() from within this method.
Reimplemented from ns3::Object.
Definition at line 208 of file lte-helper.cc.
References ns3::Object::DoDispose(), m_componentCarrierPhyParams, m_downlinkChannel, m_uplinkChannel, and NS_LOG_FUNCTION.
|
private |
The actual function to trigger a manual handover.
ueDev | the UE that hands off, must be of the type LteUeNetDevice |
sourceEnbDev | source eNB, must be of the type LteEnbNetDevice (originally the UE is attached to this eNB) |
targetCellId | target CellId (the UE primary component carrier will be connected to this cell after the handover) |
This method is normally scheduled by HandoverRequest() to run at a specific time where a manual handover is desired by the simulation user.
Definition at line 1383 of file lte-helper.cc.
References NS_LOG_FUNCTION.
Referenced by HandoverRequest().
|
overrideprotectedvirtual |
Initialize() implementation.
This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.
Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.
Reimplemented from ns3::Object.
Definition at line 94 of file lte-helper.cc.
References ChannelModelInitialization(), ns3::Object::DoInitialize(), m_macStats, m_phyRxStats, m_phyStats, m_phyTxStats, and NS_LOG_FUNCTION.
void ns3::LteHelper::EnableDlMacTraces | ( | ) |
Enable trace sinks for DL MAC layer.
Definition at line 1676 of file lte-helper.cc.
References ns3::Config::Connect(), ns3::MacStatsCalculator::DlSchedulingCallback(), m_macStats, ns3::MakeBoundCallback(), and NS_LOG_FUNCTION_NOARGS.
Referenced by EnableMacTraces().
void ns3::LteHelper::EnableDlPhyTraces | ( | ) |
Enable trace sinks for DL PHY layer.
Definition at line 1692 of file lte-helper.cc.
References ns3::Config::Connect(), m_phyStats, ns3::MakeBoundCallback(), NS_LOG_FUNCTION_NOARGS, and ns3::PhyStatsCalculator::ReportCurrentCellRsrpSinrCallback().
Referenced by EnablePhyTraces().
void ns3::LteHelper::EnableDlRxPhyTraces | ( | ) |
Enable trace sinks for DL reception PHY layer.
Definition at line 1653 of file lte-helper.cc.
References ns3::Config::Connect(), ns3::PhyRxStatsCalculator::DlPhyReceptionCallback(), m_phyRxStats, and ns3::MakeBoundCallback().
Referenced by EnablePhyTraces().
void ns3::LteHelper::EnableDlTxPhyTraces | ( | ) |
Enable trace sinks for DL transmission PHY layer.
Definition at line 1637 of file lte-helper.cc.
References ns3::Config::Connect(), ns3::PhyTxStatsCalculator::DlPhyTransmissionCallback(), m_phyTxStats, and ns3::MakeBoundCallback().
Referenced by EnablePhyTraces().
void ns3::LteHelper::EnableLogComponents | ( | ) |
Enables full-blown logging for major components of the LENA architecture.
Definition at line 1454 of file lte-helper.cc.
References ns3::LOG_LEVEL_ALL, ns3::LOG_PREFIX_FUNC, ns3::LOG_PREFIX_NODE, ns3::LOG_PREFIX_TIME, ns3::LogComponentEnable(), and ns3::LogComponentEnableAll().
void ns3::LteHelper::EnableMacTraces | ( | ) |
Enable trace sinks for MAC layer.
Definition at line 1669 of file lte-helper.cc.
References EnableDlMacTraces(), and EnableUlMacTraces().
Referenced by EnableTraces().
void ns3::LteHelper::EnablePdcpTraces | ( | ) |
Enable trace sinks for PDCP layer.
Definition at line 1717 of file lte-helper.cc.
References ns3::RadioBearerStatsConnector::EnablePdcpStats(), m_pdcpStats, m_radioBearerStatsConnector, and NS_ASSERT_MSG.
Referenced by EnableTraces().
void ns3::LteHelper::EnablePhyTraces | ( | ) |
Enable trace sinks for PHY layer.
Definition at line 1626 of file lte-helper.cc.
References EnableDlPhyTraces(), EnableDlRxPhyTraces(), EnableDlTxPhyTraces(), EnableUlPhyTraces(), EnableUlRxPhyTraces(), and EnableUlTxPhyTraces().
Referenced by EnableTraces().
void ns3::LteHelper::EnableRlcTraces | ( | ) |
Enable trace sinks for RLC layer.
Definition at line 1566 of file lte-helper.cc.
References ns3::RadioBearerStatsConnector::EnableRlcStats(), m_radioBearerStatsConnector, m_rlcStats, and NS_ASSERT_MSG.
Referenced by EnableTraces().
void ns3::LteHelper::EnableTraces | ( | ) |
Enables trace sinks for PHY, MAC, RLC and PDCP.
To make sure all nodes are traced, traces should be enabled once all UEs and eNodeBs are in place and connected, just before starting the simulation.
Definition at line 1557 of file lte-helper.cc.
References EnableMacTraces(), EnablePdcpTraces(), EnablePhyTraces(), and EnableRlcTraces().
void ns3::LteHelper::EnableUlMacTraces | ( | ) |
Enable trace sinks for UL MAC layer.
Definition at line 1684 of file lte-helper.cc.
References ns3::Config::Connect(), m_macStats, ns3::MakeBoundCallback(), NS_LOG_FUNCTION_NOARGS, and ns3::MacStatsCalculator::UlSchedulingCallback().
Referenced by EnableMacTraces().
void ns3::LteHelper::EnableUlPhyTraces | ( | ) |
Enable trace sinks for UL PHY layer.
Definition at line 1701 of file lte-helper.cc.
References ns3::Config::Connect(), m_phyStats, ns3::MakeBoundCallback(), NS_LOG_FUNCTION_NOARGS, ns3::PhyStatsCalculator::ReportInterference(), and ns3::PhyStatsCalculator::ReportUeSinr().
Referenced by EnablePhyTraces().
void ns3::LteHelper::EnableUlRxPhyTraces | ( | ) |
Enable trace sinks for UL reception PHY layer.
Definition at line 1661 of file lte-helper.cc.
References ns3::Config::Connect(), m_phyRxStats, ns3::MakeBoundCallback(), and ns3::PhyRxStatsCalculator::UlPhyReceptionCallback().
Referenced by EnablePhyTraces().
void ns3::LteHelper::EnableUlTxPhyTraces | ( | ) |
Enable trace sinks for UL transmission PHY layer.
Definition at line 1645 of file lte-helper.cc.
References ns3::Config::Connect(), m_phyTxStats, ns3::MakeBoundCallback(), and ns3::PhyTxStatsCalculator::UlPhyTransmissionCallback().
Referenced by EnablePhyTraces().
Ptr< SpectrumChannel > ns3::LteHelper::GetDownlinkSpectrumChannel | ( | ) | const |
Definition at line 224 of file lte-helper.cc.
References m_downlinkChannel.
std::string ns3::LteHelper::GetEnbComponentCarrierManagerType | ( | ) | const |
Definition at line 355 of file lte-helper.cc.
References ns3::TypeId::GetName(), ns3::ObjectFactory::GetTypeId(), and m_enbComponentCarrierManagerFactory.
Referenced by GetTypeId().
std::string ns3::LteHelper::GetFfrAlgorithmType | ( | ) | const |
Definition at line 313 of file lte-helper.cc.
References ns3::TypeId::GetName(), ns3::ObjectFactory::GetTypeId(), and m_ffrAlgorithmFactory.
Referenced by GetTypeId().
std::string ns3::LteHelper::GetHandoverAlgorithmType | ( | ) | const |
Definition at line 334 of file lte-helper.cc.
References ns3::TypeId::GetName(), ns3::ObjectFactory::GetTypeId(), and m_handoverAlgorithmFactory.
Referenced by GetTypeId().
Ptr< RadioBearerStatsCalculator > ns3::LteHelper::GetPdcpStats | ( | ) |
Definition at line 1726 of file lte-helper.cc.
References m_pdcpStats.
Ptr< RadioBearerStatsCalculator > ns3::LteHelper::GetRlcStats | ( | ) |
Definition at line 1711 of file lte-helper.cc.
References m_rlcStats.
std::string ns3::LteHelper::GetSchedulerType | ( | ) | const |
Definition at line 300 of file lte-helper.cc.
References ns3::TypeId::GetName(), ns3::ObjectFactory::GetTypeId(), and m_schedulerFactory.
Referenced by GetTypeId().
|
static |
Register this type.
Definition at line 111 of file lte-helper.cc.
References GetEnbComponentCarrierManagerType(), GetFfrAlgorithmType(), GetHandoverAlgorithmType(), GetSchedulerType(), ns3::FriisPropagationLossModel::GetTypeId(), GetUeComponentCarrierManagerType(), m_isAnrEnabled, m_noOfCcs, m_useCa, m_useIdealRrc, m_usePdschForCqiGeneration, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeStringAccessor(), ns3::MakeStringChecker(), ns3::MakeTypeIdAccessor(), ns3::MakeTypeIdChecker(), ns3::MakeUintegerAccessor(), ns3::MAX_NO_CC, ns3::MIN_NO_CC, SetEnbComponentCarrierManagerType(), SetFadingModel(), SetFfrAlgorithmType(), SetHandoverAlgorithmType(), ns3::TypeId::SetParent(), SetPathlossModelType(), SetSchedulerType(), and SetUeComponentCarrierManagerType().
std::string ns3::LteHelper::GetUeComponentCarrierManagerType | ( | ) | const |
Definition at line 376 of file lte-helper.cc.
References ns3::TypeId::GetName(), ns3::ObjectFactory::GetTypeId(), and m_ueComponentCarrierManagerFactory.
Referenced by GetTypeId().
Ptr< SpectrumChannel > ns3::LteHelper::GetUplinkSpectrumChannel | ( | ) | const |
Definition at line 218 of file lte-helper.cc.
References m_uplinkChannel.
void ns3::LteHelper::HandoverRequest | ( | Time | hoTime, |
Ptr< NetDevice > | ueDev, | ||
Ptr< NetDevice > | sourceEnbDev, | ||
Ptr< NetDevice > | targetEnbDev | ||
) |
Manually trigger an X2-based handover.
hoTime | when the handover shall be initiated |
ueDev | the UE that hands off, must be of the type LteUeNetDevice |
sourceEnbDev | source eNB, must be of the type LteEnbNetDevice (originally the UE is attached to this eNB) |
targetEnbDev | target eNB, must be of the type LteEnbNetDevice (the UE would be connected to this eNB after the handover) |
Definition at line 1346 of file lte-helper.cc.
References DoHandoverRequest(), m_epcHelper, NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().
Referenced by LteX2HandoverTestCase::DoRun().
void ns3::LteHelper::HandoverRequest | ( | Time | hoTime, |
Ptr< NetDevice > | ueDev, | ||
Ptr< NetDevice > | sourceEnbDev, | ||
uint16_t | targetCellId | ||
) |
Manually trigger an X2-based handover.
hoTime | when the handover shall be initiated |
ueDev | the UE that hands off, must be of the type LteUeNetDevice |
sourceEnbDev | source eNB, must be of the type LteEnbNetDevice (originally the UE is attached to this eNB) |
targetCellId | target CellId (the UE primary component carrier will be connected to this cell after the handover) |
Definition at line 1365 of file lte-helper.cc.
References DoHandoverRequest(), m_epcHelper, NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().
NetDeviceContainer ns3::LteHelper::InstallEnbDevice | ( | NodeContainer | c | ) |
Create a set of eNodeB devices.
c | the node container where the devices are to be installed |
Definition at line 485 of file lte-helper.cc.
References ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), ns3::Object::Initialize(), InstallSingleEnbDevice(), and NS_LOG_FUNCTION.
Referenced by LteRrcConnectionEstablishmentTestCase::DoRun(), LteRrcConnectionEstablishmentErrorTestCase::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), LteX2HandoverTestCase::DoRun(), and ns3::LteHexGridEnbTopologyHelper::SetPositionAndInstallEnbDevice().
Create an eNodeB device (LteEnbNetDevice) on the given node.
n | the node where the device is to be installed |
Definition at line 514 of file lte-helper.cc.
References ns3::ObjectFactory::Create(), DoComponentCarrierConfigure(), ns3::LteEnbPhy::GenerateCtrlCqiReport(), ns3::LteEnbPhy::GenerateDataCqiReport(), ns3::EnumValue::Get(), ns3::LteSpectrumValueHelper::GetCarrierFrequency(), m_cellIdCounter, m_componentCarrierPhyParams, m_downlinkChannel, m_downlinkPathlossModel, m_enbAntennaModelFactory, m_enbComponentCarrierManagerFactory, m_enbNetDeviceFactory, m_epcHelper, m_ffrAlgorithmFactory, m_handoverAlgorithmFactory, m_isAnrEnabled, m_noOfCcs, m_schedulerFactory, m_uplinkChannel, m_uplinkPathlossModel, m_useCa, m_useIdealRrc, ns3::MakeCallback(), NS_ABORT_MSG_IF, NS_ASSERT, NS_ASSERT_MSG, NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, NS_LOG_WARN, ns3::LteEnbPhy::PhyPduReceived(), ns3::LteNetDevice::Receive(), ns3::LteEnbPhy::ReceiveLteControlMessageList(), ns3::LteEnbPhy::ReportInterference(), ns3::LteEnbPhy::ReportUlHarqFeedback(), ns3::LteEnbRrc::RLC_SM_ALWAYS, ns3::LteEnbRrc::RLC_UM_ALWAYS, ns3::ObjectBase::SetAttributeFailSafe(), and ns3::LteSpectrumPhy::UpdateSinrPerceived().
Referenced by InstallEnbDevice().
Create a UE device (LteUeNetDevice) on the given node.
n | the node where the device is to be installed |
Definition at line 833 of file lte-helper.cc.
References ns3::Mac64Address::Allocate(), ns3::ObjectFactory::Create(), DoComponentCarrierConfigure(), ns3::LteUePhy::EnqueueDlHarqFeedback(), ns3::LteUePhy::GenerateCtrlCqiReport(), ns3::LteUePhy::GenerateMixedCqiReport(), m_componentCarrierPhyParams, m_downlinkChannel, m_epcHelper, m_imsiCounter, m_noOfCcs, m_ueAntennaModelFactory, m_ueComponentCarrierManagerFactory, m_ueNetDeviceFactory, m_uplinkChannel, m_useIdealRrc, m_usePdschForCqiGeneration, ns3::MakeCallback(), NS_ABORT_MSG_IF, NS_ASSERT_MSG, NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::LteUePhy::PhyPduReceived(), ns3::LteNetDevice::Receive(), ns3::LteUePhy::ReceiveLteControlMessageList(), ns3::LteUePhy::ReceivePss(), ns3::LteUePhy::ReportDataInterference(), ns3::LteUePhy::ReportInterference(), ns3::LteUePhy::ReportRsReceivedPower(), and ns3::LteSpectrumPhy::UpdateSinrPerceived().
Referenced by InstallUeDevice().
NetDeviceContainer ns3::LteHelper::InstallUeDevice | ( | NodeContainer | c | ) |
Create a set of UE devices.
c | the node container where the devices are to be installed |
Definition at line 500 of file lte-helper.cc.
References ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), InstallSingleUeDevice(), and NS_LOG_FUNCTION.
Referenced by LteRrcConnectionEstablishmentTestCase::DoRun(), LteRrcConnectionEstablishmentErrorTestCase::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), and LteX2HandoverTestCase::DoRun().
void ns3::LteHelper::SetEnbAntennaModelAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
Set an attribute for the eNodeB antenna model to be created.
n | the name of the attribute. |
v | the value of the attribute |
Definition at line 426 of file lte-helper.cc.
References m_enbAntennaModelFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
Referenced by ns3::LteHexGridEnbTopologyHelper::SetPositionAndInstallEnbDevice().
void ns3::LteHelper::SetEnbAntennaModelType | ( | std::string | type | ) |
Set the type of antenna model to be used by eNodeB devices.
type | type of antenna model, must be a type name of any class inheriting from ns3::AntennaModel, for example: "ns3::IsotropicAntennaModel" |
Definition at line 419 of file lte-helper.cc.
References m_enbAntennaModelFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::SetTypeId().
void ns3::LteHelper::SetEnbComponentCarrierManagerAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
Set an attribute for the enb component carrier manager to be created.
n | the name of the attribute |
v | the value of the attribute |
Definition at line 369 of file lte-helper.cc.
References m_enbComponentCarrierManagerFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
void ns3::LteHelper::SetEnbComponentCarrierManagerType | ( | std::string | type | ) |
Set the type of carrier component algorithm to be used by eNodeB devices.
type | type of carrier component manager |
Definition at line 361 of file lte-helper.cc.
References m_enbComponentCarrierManagerFactory, NS_LOG_FUNCTION, ns3::Object::ObjectFactory, and ns3::ObjectFactory::SetTypeId().
Referenced by GetTypeId().
void ns3::LteHelper::SetEnbDeviceAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
Set an attribute for the eNodeB devices (LteEnbNetDevice) to be created.
n | the name of the attribute. |
v | the value of the attribute |
Definition at line 412 of file lte-helper.cc.
References m_enbNetDeviceFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
Set the EpcHelper to be used to setup the EPC network in conjunction with the setup of the LTE radio access network.
h | a pointer to the EpcHelper to be used |
Definition at line 285 of file lte-helper.cc.
References m_epcHelper, and NS_LOG_FUNCTION.
Referenced by LteX2HandoverMeasuresTestCase::DoRun(), and LteX2HandoverTestCase::DoRun().
void ns3::LteHelper::SetFadingModel | ( | std::string | type | ) |
Set the type of fading model to be used in both DL and UL.
type | type of fading model, must be a type name of any class inheriting from ns3::SpectrumPropagationLossModel, for example: "ns3::TraceFadingLossModel" |
Definition at line 454 of file lte-helper.cc.
References m_fadingModelFactory, m_fadingModelType, NS_LOG_FUNCTION, ns3::Object::ObjectFactory, and ns3::ObjectFactory::SetTypeId().
Referenced by GetTypeId().
void ns3::LteHelper::SetFadingModelAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
Set an attribute for the fading model to be created (both DL and UL).
n | the name of the attribute |
v | the value of the attribute |
Definition at line 466 of file lte-helper.cc.
References m_fadingModelFactory, and ns3::ObjectFactory::Set().
void ns3::LteHelper::SetFfrAlgorithmAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
Set an attribute for the FFR algorithm to be created.
n | the name of the attribute |
v | the value of the attribute |
Definition at line 327 of file lte-helper.cc.
References m_ffrAlgorithmFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
Referenced by ns3::LteHexGridEnbTopologyHelper::SetPositionAndInstallEnbDevice().
void ns3::LteHelper::SetFfrAlgorithmType | ( | std::string | type | ) |
Set the type of FFR algorithm to be used by eNodeB devices.
type | type of FFR algorithm, must be a type name of any class inheriting from ns3::LteFfrAlgorithm, for example: "ns3::LteFrNoOpAlgorithm" |
Equivalent with setting the FfrAlgorithm
attribute.
Definition at line 319 of file lte-helper.cc.
References m_ffrAlgorithmFactory, NS_LOG_FUNCTION, ns3::Object::ObjectFactory, and ns3::ObjectFactory::SetTypeId().
Referenced by GetTypeId().
void ns3::LteHelper::SetHandoverAlgorithmAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
Set an attribute for the handover algorithm to be created.
n | the name of the attribute |
v | the value of the attribute |
Definition at line 348 of file lte-helper.cc.
References m_handoverAlgorithmFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
Referenced by LteX2HandoverMeasuresTestCase::DoRun().
void ns3::LteHelper::SetHandoverAlgorithmType | ( | std::string | type | ) |
Set the type of handover algorithm to be used by eNodeB devices.
type | type of handover algorithm, must be a type name of any class inheriting from ns3::LteHandoverAlgorithm, for example: "ns3::NoOpHandoverAlgorithm" |
Equivalent with setting the HandoverAlgorithm
attribute.
Definition at line 340 of file lte-helper.cc.
References m_handoverAlgorithmFactory, NS_LOG_FUNCTION, ns3::Object::ObjectFactory, and ns3::ObjectFactory::SetTypeId().
Referenced by LteX2HandoverMeasuresTestCase::DoRun(), LteX2HandoverTestCase::DoRun(), and GetTypeId().
void ns3::LteHelper::SetPathlossModelAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
Set an attribute for the path loss models to be created.
n | the name of the attribute |
v | the value of the attribute |
Definition at line 405 of file lte-helper.cc.
References m_pathlossModelFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
void ns3::LteHelper::SetPathlossModelType | ( | TypeId | type | ) |
Set the type of path loss model to be used for both DL and UL channels.
type | type of path loss model, must be a type name of any class inheriting from ns3::PropagationLossModel, for example: "ns3::FriisPropagationLossModel" |
Definition at line 397 of file lte-helper.cc.
References m_pathlossModelFactory, NS_LOG_FUNCTION, ns3::Object::ObjectFactory, and ns3::ObjectFactory::SetTypeId().
Referenced by GetTypeId().
void ns3::LteHelper::SetSchedulerAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
Set an attribute for the scheduler to be created.
n | the name of the attribute |
v | the value of the attribute |
Definition at line 306 of file lte-helper.cc.
References m_schedulerFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
void ns3::LteHelper::SetSchedulerType | ( | std::string | type | ) |
Set the type of scheduler to be used by eNodeB devices.
type | type of scheduler, must be a type name of any class inheriting from ns3::FfMacScheduler, for example: "ns3::PfFfMacScheduler" |
Equivalent with setting the Scheduler
attribute.
Definition at line 292 of file lte-helper.cc.
References m_schedulerFactory, NS_LOG_FUNCTION, ns3::Object::ObjectFactory, and ns3::ObjectFactory::SetTypeId().
Referenced by LteX2HandoverMeasuresTestCase::DoRun(), LteX2HandoverTestCase::DoRun(), and GetTypeId().
void ns3::LteHelper::SetSpectrumChannelAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
Set an attribute for the spectrum channel to be created (both DL and UL).
n | the name of the attribute |
v | the value of the attribute |
Definition at line 479 of file lte-helper.cc.
References m_channelFactory, and ns3::ObjectFactory::Set().
void ns3::LteHelper::SetSpectrumChannelType | ( | std::string | type | ) |
Set the type of spectrum channel to be used in both DL and UL.
type | type of spectrum channel model, must be a type name of any class inheriting from ns3::SpectrumChannel, for example: "ns3::MultiModelSpectrumChannel" |
Definition at line 472 of file lte-helper.cc.
References m_channelFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::SetTypeId().
void ns3::LteHelper::SetUeAntennaModelAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
Set an attribute for the UE antenna model to be created.
n | the name of the attribute |
v | the value of the attribute |
Definition at line 447 of file lte-helper.cc.
References m_ueAntennaModelFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
void ns3::LteHelper::SetUeAntennaModelType | ( | std::string | type | ) |
Set the type of antenna model to be used by UE devices.
type | type of antenna model, must be a type name of any class inheriting from ns3::AntennaModel, for example: "ns3::IsotropicAntennaModel" |
Definition at line 440 of file lte-helper.cc.
References m_ueAntennaModelFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::SetTypeId().
void ns3::LteHelper::SetUeComponentCarrierManagerAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
Set an attribute for the ue component carrier manager to be created.
n | the name of the attribute |
v | the value of the attribute |
Definition at line 390 of file lte-helper.cc.
References m_ueComponentCarrierManagerFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
void ns3::LteHelper::SetUeComponentCarrierManagerType | ( | std::string | type | ) |
Set the type of Component Carrier Manager to be used by Ue devices.
type | type of UE Component Carrier Manager |
Definition at line 382 of file lte-helper.cc.
References m_ueComponentCarrierManagerFactory, NS_LOG_FUNCTION, ns3::Object::ObjectFactory, and ns3::ObjectFactory::SetTypeId().
Referenced by GetTypeId().
void ns3::LteHelper::SetUeDeviceAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
Set an attribute for the UE devices (LteUeNetDevice) to be created.
n | the name of the attribute. |
v | the value of the attribute |
Definition at line 433 of file lte-helper.cc.
References m_ueNetDeviceFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
|
private |
Keep track of the number of cell ID allocated.
Increases by one every time a new eNodeB is installed (by InstallSingleEnbDevice()). The first eNodeB will have a cell ID of 1. The maximum number of eNodeB is 65535.
Definition at line 825 of file lte-helper.h.
Referenced by InstallSingleEnbDevice().
|
private |
Factory of both the downlink and uplink LTE channels.
Definition at line 778 of file lte-helper.h.
Referenced by LteHelper(), ChannelModelInitialization(), SetSpectrumChannelAttribute(), and SetSpectrumChannelType().
|
private |
This contains all the information about each component carrier.
Definition at line 855 of file lte-helper.h.
Referenced by DoComponentCarrierConfigure(), DoDispose(), InstallSingleEnbDevice(), and InstallSingleUeDevice().
|
private |
This function create the component carrier based on provided configuration parameters.
The downlink LTE channel used in the simulation.
Definition at line 749 of file lte-helper.h.
Referenced by ChannelModelInitialization(), DoDispose(), GetDownlinkSpectrumChannel(), InstallSingleEnbDevice(), and InstallSingleUeDevice().
The path loss model used in the downlink channel.
Definition at line 753 of file lte-helper.h.
Referenced by ChannelModelInitialization(), and InstallSingleEnbDevice().
|
private |
Factory of antenna object for eNodeB.
Definition at line 770 of file lte-helper.h.
Referenced by LteHelper(), InstallSingleEnbDevice(), SetEnbAntennaModelAttribute(), and SetEnbAntennaModelType().
|
private |
Factory of enb component carrier manager object.
Definition at line 764 of file lte-helper.h.
Referenced by GetEnbComponentCarrierManagerType(), InstallSingleEnbDevice(), SetEnbComponentCarrierManagerAttribute(), and SetEnbComponentCarrierManagerType().
|
private |
Factory of LteEnbNetDevice objects.
Definition at line 768 of file lte-helper.h.
Referenced by LteHelper(), InstallSingleEnbDevice(), and SetEnbDeviceAttribute().
Helper which provides implementation of core network.
Initially empty (i.e., LTE-only simulation without any core network) and then might be set using SetEpcHelper().
Definition at line 812 of file lte-helper.h.
Referenced by ActivateDataRadioBearer(), ActivateDedicatedEpsBearer(), AddX2Interface(), AssignStreams(), Attach(), DeActivateDedicatedEpsBearer(), HandoverRequest(), InstallSingleEnbDevice(), InstallSingleUeDevice(), and SetEpcHelper().
|
private |
The fading model used in both the downlink and uplink channels.
Definition at line 785 of file lte-helper.h.
Referenced by AssignStreams(), and ChannelModelInitialization().
|
private |
Factory of fading model object for both the downlink and uplink channels.
Definition at line 783 of file lte-helper.h.
Referenced by ChannelModelInitialization(), SetFadingModel(), and SetFadingModelAttribute().
|
private |
Name of fading model type, e.g., "ns3::TraceFadingLossModel".
Definition at line 781 of file lte-helper.h.
Referenced by ChannelModelInitialization(), and SetFadingModel().
|
private |
True if a random variable stream number has been assigned for the fading model.
Used to prevent such assignment to be done more than once.
Definition at line 790 of file lte-helper.h.
Referenced by AssignStreams().
|
private |
Factory of FFR (frequency reuse) algorithm object.
Definition at line 760 of file lte-helper.h.
Referenced by GetFfrAlgorithmType(), InstallSingleEnbDevice(), SetFfrAlgorithmAttribute(), and SetFfrAlgorithmType().
|
private |
Factory of handover algorithm object.
Definition at line 762 of file lte-helper.h.
Referenced by GetHandoverAlgorithmType(), InstallSingleEnbDevice(), SetHandoverAlgorithmAttribute(), and SetHandoverAlgorithmType().
|
private |
Keep track of the number of IMSI allocated.
Increases by one every time a new UE is installed (by InstallSingleUeDevice()). The first UE will have an IMSI of 1. The maximum number of UE is 2^64 (~4.2e9).
Definition at line 819 of file lte-helper.h.
Referenced by InstallSingleUeDevice().
|
private |
The AnrEnabled
attribute.
Activate or deactivate Automatic Neighbour Relation function.
Definition at line 836 of file lte-helper.h.
Referenced by GetTypeId(), and InstallSingleEnbDevice().
|
private |
Container of MAC layer statistics.
Definition at line 799 of file lte-helper.h.
Referenced by DoInitialize(), EnableDlMacTraces(), and EnableUlMacTraces().
|
private |
Number of component carriers that will be installed by default at eNodeB and UE devices.
Definition at line 860 of file lte-helper.h.
Referenced by ChannelModelInitialization(), DoComponentCarrierConfigure(), GetTypeId(), InstallSingleEnbDevice(), and InstallSingleUeDevice().
|
private |
Factory of path loss model object.
Definition at line 776 of file lte-helper.h.
Referenced by ChannelModelInitialization(), SetPathlossModelAttribute(), and SetPathlossModelType().
|
private |
Container of PDCP layer statistics.
Definition at line 803 of file lte-helper.h.
Referenced by EnablePdcpTraces(), and GetPdcpStats().
|
private |
Container of PHY layer statistics related to reception.
Definition at line 797 of file lte-helper.h.
Referenced by DoInitialize(), EnableDlRxPhyTraces(), and EnableUlRxPhyTraces().
|
private |
Container of PHY layer statistics.
Definition at line 793 of file lte-helper.h.
Referenced by DoInitialize(), EnableDlPhyTraces(), and EnableUlPhyTraces().
|
private |
Container of PHY layer statistics related to transmission.
Definition at line 795 of file lte-helper.h.
Referenced by DoInitialize(), EnableDlTxPhyTraces(), and EnableUlTxPhyTraces().
|
private |
Connects RLC and PDCP statistics containers to appropriate trace sources.
Definition at line 805 of file lte-helper.h.
Referenced by EnablePdcpTraces(), and EnableRlcTraces().
|
private |
Container of RLC layer statistics.
Definition at line 801 of file lte-helper.h.
Referenced by EnableRlcTraces(), and GetRlcStats().
|
private |
Factory of MAC scheduler object.
Definition at line 758 of file lte-helper.h.
Referenced by GetSchedulerType(), InstallSingleEnbDevice(), SetSchedulerAttribute(), and SetSchedulerType().
|
private |
Factory of antenna object for UE.
Definition at line 774 of file lte-helper.h.
Referenced by LteHelper(), InstallSingleUeDevice(), SetUeAntennaModelAttribute(), and SetUeAntennaModelType().
|
private |
Factory of ue component carrier manager object.
Definition at line 766 of file lte-helper.h.
Referenced by GetUeComponentCarrierManagerType(), InstallSingleUeDevice(), SetUeComponentCarrierManagerAttribute(), and SetUeComponentCarrierManagerType().
|
private |
Factory for LteUeNetDevice objects.
Definition at line 772 of file lte-helper.h.
Referenced by LteHelper(), InstallSingleUeDevice(), and SetUeDeviceAttribute().
|
private |
The uplink LTE channel used in the simulation.
Definition at line 751 of file lte-helper.h.
Referenced by ChannelModelInitialization(), DoDispose(), GetUplinkSpectrumChannel(), InstallSingleEnbDevice(), and InstallSingleUeDevice().
The path loss model used in the uplink channel.
Definition at line 755 of file lte-helper.h.
Referenced by ChannelModelInitialization(), and InstallSingleEnbDevice().
|
private |
The UseCa
attribute.
If true, Carrier Aggregation is enabled. Hence, the helper will expect a valid component carrier map If it is false, the component carrier will be created within the LteHelper this is to maintain the backwards compatibility with user script
Definition at line 850 of file lte-helper.h.
Referenced by GetTypeId(), and InstallSingleEnbDevice().
|
private |
The UseIdealRrc
attribute.
If true, LteRrcProtocolIdeal will be used for RRC signaling. If false, LteRrcProtocolReal will be used.
Definition at line 831 of file lte-helper.h.
Referenced by GetTypeId(), InstallSingleEnbDevice(), and InstallSingleUeDevice().
|
private |
The UsePdschForCqiGeneration
attribute.
If true, DL-CQI will be calculated from PDCCH as signal and PDSCH as interference. If false, DL-CQI will be calculated from PDCCH as signal and PDCCH as interference.
Definition at line 842 of file lte-helper.h.
Referenced by GetTypeId(), and InstallSingleUeDevice().