#include <lte-helper.h>
Public Types | |
enum | LteEpsBearerToRlcMapping_t { RLC_SM_ALWAYS = 1, RLC_UM_ALWAYS = 2, RLC_AM_ALWAYS = 3, PER_BASED = 4 } |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
static void | Cleanup (void) |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Protected Member Functions | |
virtual void | DoInitialize (void) |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
virtual void | NotifyNewAggregate (void) |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
Private Member Functions | |
void | DoHandoverRequest (Ptr< NetDevice > ueDev, Ptr< NetDevice > sourceEnbDev, Ptr< NetDevice > targetEnbDev) |
Ptr< NetDevice > | InstallSingleEnbDevice (Ptr< Node > n) |
Ptr< NetDevice > | InstallSingleUeDevice (Ptr< Node > n) |
Private Attributes | |
uint16_t | m_cellIdCounter |
ObjectFactory | m_channelFactory |
ObjectFactory | m_dlPathlossModelFactory |
Ptr< SpectrumChannel > | m_downlinkChannel |
Ptr< Object > | m_downlinkPathlossModel |
ObjectFactory | m_enbAntennaModelFactory |
ObjectFactory | m_enbNetDeviceFactory |
Ptr< EpcHelper > | m_epcHelper |
ObjectFactory | m_fadingModelFactory |
std::string | m_fadingModelType |
uint64_t | m_imsiCounter |
Ptr< MacStatsCalculator > | m_macStats |
Ptr< RadioBearerStatsCalculator > | m_pdcpStats |
Ptr< PhyRxStatsCalculator > | m_phyRxStats |
Ptr< PhyStatsCalculator > | m_phyStats |
Ptr< PhyTxStatsCalculator > | m_phyTxStats |
ObjectFactory | m_propagationModelFactory |
RadioBearerStatsConnector | m_radioBearerStatsConnector |
Ptr< RadioBearerStatsCalculator > | m_rlcStats |
ObjectFactory | m_schedulerFactory |
ObjectFactory | m_ueAntennaModelFactory |
ObjectFactory | m_ulPathlossModelFactory |
Ptr< SpectrumChannel > | m_uplinkChannel |
Ptr< Object > | m_uplinkPathlossModel |
bool | m_useIdealRrc |
Creation and configuration of LTE entities
Doxygen introspection did not find any typical Config paths.
No TraceSources are defined for this type.
Definition at line 55 of file lte-helper.h.
void ns3::LteHelper::ActivateDataRadioBearer | ( | NetDeviceContainer | ueDevices, |
EpsBearer | bearer | ||
) |
Call ActivateDataRadioBearer (ueDevice, bearer) for each UE device in a given set
ueDevices | the set of UE devices |
bearer |
Definition at line 773 of file lte-helper.cc.
References ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), and NS_LOG_FUNCTION.
Referenced by LenaFdMtFfMacSchedulerTestCase::DoRun(), LenaTtaFfMacSchedulerTestCase::DoRun(), and LenaTdMtFfMacSchedulerTestCase::DoRun().
Activate a Data Radio Bearer for a simplified LTE-only simulation without EPC. This method will schedule the actual activation of the bearer so that it happens after the UE got connected.
ueDevice | the device of the UE for which the radio bearer is to be activated |
bearer | the characteristics of the bearer to be activated |
Definition at line 705 of file lte-helper.cc.
References ns3::Config::Connect(), NS_ASSERT_MSG, and NS_LOG_FUNCTION.
void 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 629 of file lte-helper.cc.
References ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), and NS_LOG_FUNCTION.
void ns3::LteHelper::ActivateDedicatedEpsBearer | ( | Ptr< NetDevice > | ueDevice, |
EpsBearer | bearer, | ||
Ptr< EpcTft > | tft | ||
) |
Activate a dedicated EPS bearer on a given UE device
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 640 of file lte-helper.cc.
References 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 727 of file lte-helper.cc.
References ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), and NS_LOG_FUNCTION.
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 741 of file lte-helper.cc.
References 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 by this model. Return the number of streams (possibly zero) that have been assigned. The Install() method should have previously been called by the user.
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 837 of file lte-helper.cc.
References ns3::NetDeviceContainer::Begin(), and ns3::NetDeviceContainer::End().
void ns3::LteHelper::Attach | ( | NetDeviceContainer | ueDevices, |
Ptr< NetDevice > | enbDevice | ||
) |
Attach a set of UE devices to a single eNB device
ueDevices | |
enbDevice |
Definition at line 562 of file lte-helper.cc.
References ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), and NS_LOG_FUNCTION.
Referenced by AttachToClosestEnb(), LenaTtaFfMacSchedulerTestCase::DoRun(), LenaTdMtFfMacSchedulerTestCase::DoRun(), and LenaFdMtFfMacSchedulerTestCase::DoRun().
Attach a UE to the network
Attach a UE device to the network via a given eNB, and activate the default EPS bearer.
ueDevice | |
enbDevice |
Definition at line 572 of file lte-helper.cc.
References ns3::EpcTft::Default(), and NS_LOG_FUNCTION.
void ns3::LteHelper::AttachToClosestEnb | ( | NetDeviceContainer | ueDevices, |
NetDeviceContainer | enbDevices | ||
) |
Attach each UE in a set to the closest (w.r.t. distance) eNB among those in a set.
ueDevices | the set of UEs |
enbDevices | the set of eNBs |
Definition at line 597 of file lte-helper.cc.
References ns3::NetDeviceContainer::Begin(), ns3::NetDeviceContainer::End(), and NS_LOG_FUNCTION.
void ns3::LteHelper::AttachToClosestEnb | ( | Ptr< NetDevice > | ueDevice, |
NetDeviceContainer | enbDevices | ||
) |
Attach an UE ito the closest (w.r.t. distance) eNB among those in a set Will call LteHelper::Attach () passing to it the single eNB instance which resulted to be the closest to the UE
ueDevice | the UE |
enbDevices | the set of eNBs |
Definition at line 607 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.
|
virtual |
This method is called by Object::Dispose or by the object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overriden 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 166 of file lte-helper.cc.
References ns3::Object::DoDispose(), and NS_LOG_FUNCTION.
|
protectedvirtual |
This method is called only once by Object::Initialize. If the user calls Object::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 76 of file lte-helper.cc.
References ns3::SpectrumChannel::AddPropagationLossModel(), ns3::SpectrumChannel::AddSpectrumPropagationLossModel(), ns3::ObjectFactory::Create(), ns3::Object::DoInitialize(), ns3::Object::GetObject(), NS_ASSERT_MSG, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
void ns3::LteHelper::EnableDlMacTraces | ( | void | ) |
Enable trace sinks for DL MAC layer
Definition at line 1212 of file lte-helper.cc.
References ns3::Config::Connect(), and NS_LOG_FUNCTION_NOARGS.
Referenced by EnableMacTraces().
void ns3::LteHelper::EnableDlPhyTraces | ( | void | ) |
Enable trace sinks for DL PHY layer
Definition at line 1282 of file lte-helper.cc.
References ns3::Config::Connect(), and NS_LOG_FUNCTION_NOARGS.
Referenced by EnablePhyTraces().
void ns3::LteHelper::EnableDlRxPhyTraces | ( | void | ) |
Enable trace sinks for DL reception PHY layer
Definition at line 1152 of file lte-helper.cc.
References ns3::Config::Connect().
Referenced by EnablePhyTraces().
void ns3::LteHelper::EnableDlTxPhyTraces | ( | void | ) |
Enable trace sinks for DL transmission PHY layer
Definition at line 1138 of file lte-helper.cc.
References ns3::Config::Connect().
Referenced by EnablePhyTraces().
void ns3::LteHelper::EnableLogComponents | ( | void | ) |
Enables logging for all components of the LENA architecture
Definition at line 783 of file lte-helper.cc.
References ns3::TypeId::GetName(), ns3::ObjectFactory::GetTypeId(), and ns3::LogComponentEnable().
void ns3::LteHelper::EnableMacTraces | ( | void | ) |
Enable trace sinks for MAC layer
Definition at line 1204 of file lte-helper.cc.
References EnableDlMacTraces(), and EnableUlMacTraces().
Referenced by LenaFdMtFfMacSchedulerTestCase::DoRun(), LenaTtaFfMacSchedulerTestCase::DoRun(), LenaTdMtFfMacSchedulerTestCase::DoRun(), and EnableTraces().
void ns3::LteHelper::EnablePdcpTraces | ( | void | ) |
Enable trace sinks for PDCP layer
Definition at line 1339 of file lte-helper.cc.
References NS_ASSERT_MSG.
Referenced by EnableTraces().
void ns3::LteHelper::EnablePhyTraces | ( | void | ) |
Enable trace sinks for PHY layer
Definition at line 1127 of file lte-helper.cc.
References EnableDlPhyTraces(), EnableDlRxPhyTraces(), EnableDlTxPhyTraces(), EnableUlPhyTraces(), EnableUlRxPhyTraces(), and EnableUlTxPhyTraces().
Referenced by EnableTraces().
void ns3::LteHelper::EnableRlcTraces | ( | void | ) |
Enable trace sinks for RLC layer
Definition at line 829 of file lte-helper.cc.
References NS_ASSERT_MSG.
Referenced by LenaFdMtFfMacSchedulerTestCase::DoRun(), LenaTtaFfMacSchedulerTestCase::DoRun(), LenaTdMtFfMacSchedulerTestCase::DoRun(), and EnableTraces().
void ns3::LteHelper::EnableTraces | ( | void | ) |
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 820 of file lte-helper.cc.
References EnableMacTraces(), EnablePdcpTraces(), EnablePhyTraces(), and EnableRlcTraces().
void ns3::LteHelper::EnableUlMacTraces | ( | void | ) |
Enable trace sinks for UL MAC layer
Definition at line 1253 of file lte-helper.cc.
References ns3::Config::Connect(), and NS_LOG_FUNCTION_NOARGS.
Referenced by EnableMacTraces().
void ns3::LteHelper::EnableUlPhyTraces | ( | void | ) |
Enable trace sinks for UL PHY layer
Definition at line 1322 of file lte-helper.cc.
References ns3::Config::Connect(), and NS_LOG_FUNCTION_NOARGS.
Referenced by EnablePhyTraces().
void ns3::LteHelper::EnableUlRxPhyTraces | ( | void | ) |
Enable trace sinks for UL reception PHY layer
Definition at line 1159 of file lte-helper.cc.
References ns3::Config::Connect().
Referenced by EnablePhyTraces().
void ns3::LteHelper::EnableUlTxPhyTraces | ( | void | ) |
Enable trace sinks for UL transmission PHY layer
Definition at line 1145 of file lte-helper.cc.
References ns3::Config::Connect().
Referenced by EnablePhyTraces().
Ptr< RadioBearerStatsCalculator > ns3::LteHelper::GetPdcpStats | ( | void | ) |
Definition at line 1347 of file lte-helper.cc.
Ptr< RadioBearerStatsCalculator > ns3::LteHelper::GetRlcStats | ( | void | ) |
Definition at line 1333 of file lte-helper.cc.
Referenced by LenaFdMtFfMacSchedulerTestCase::DoRun(), LenaTtaFfMacSchedulerTestCase::DoRun(), and LenaTdMtFfMacSchedulerTestCase::DoRun().
void ns3::LteHelper::HandoverRequest | ( | Time | hoTime, |
Ptr< NetDevice > | ueDev, | ||
Ptr< NetDevice > | sourceEnbDev, | ||
Ptr< NetDevice > | targetEnbDev | ||
) |
Trigger an X2-based handover of a UE between two eNBs
hoTime | when the Handover is initiated |
ueDev | the UE that hands off |
enbDev1 | source eNB, originally the UE is attached to this eNB |
enbDev2 | target eNB, the UE is finally connected to this eNB |
Definition at line 750 of file lte-helper.cc.
References NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().
NetDeviceContainer ns3::LteHelper::InstallEnbDevice | ( | NodeContainer | c | ) |
create a set of eNB devices
c | the node container where the devices are to be installed |
Definition at line 285 of file lte-helper.cc.
References ns3::NetDeviceContainer::Add(), ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), ns3::Object::Initialize(), and NS_LOG_FUNCTION.
Referenced by LenaFdMtFfMacSchedulerTestCase::DoRun(), LenaTtaFfMacSchedulerTestCase::DoRun(), and LenaTdMtFfMacSchedulerTestCase::DoRun().
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 300 of file lte-helper.cc.
References ns3::NetDeviceContainer::Add(), ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), and NS_LOG_FUNCTION.
Referenced by LenaFdMtFfMacSchedulerTestCase::DoRun(), LenaTtaFfMacSchedulerTestCase::DoRun(), and LenaTdMtFfMacSchedulerTestCase::DoRun().
void ns3::LteHelper::SetEnbAntennaModelAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
set an attribute for the AntennaModel to be used for the eNBs
n | the name of the attribute |
v | the value of the attribute |
Definition at line 232 of file lte-helper.cc.
References NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
void ns3::LteHelper::SetEnbAntennaModelType | ( | std::string | type | ) |
type | the type of AntennaModel to be used for the eNBs |
Definition at line 225 of file lte-helper.cc.
References NS_LOG_FUNCTION, and ns3::ObjectFactory::SetTypeId().
void ns3::LteHelper::SetEnbDeviceAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
set an attribute for the LteEnbNetDevice to be created
n | the name of the attribute |
v | the value of the attribute |
Definition at line 217 of file lte-helper.cc.
References 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 176 of file lte-helper.cc.
References NS_LOG_FUNCTION.
void ns3::LteHelper::SetFadingModel | ( | std::string | model | ) |
type | the fading model to be used |
Definition at line 253 of file lte-helper.cc.
References NS_LOG_FUNCTION, and ns3::ObjectFactory::SetTypeId().
void ns3::LteHelper::SetFadingModelAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
set an attribute of the fading model
Definition at line 265 of file lte-helper.cc.
References ns3::ObjectFactory::Set().
void ns3::LteHelper::SetPathlossModelAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
set an attribute for the pathloss model to be created
n | the name of the attribute |
v | the value of the attribute |
Definition at line 209 of file lte-helper.cc.
References NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
void ns3::LteHelper::SetPathlossModelType | ( | std::string | type | ) |
type | the type of pathloss model to be used for the eNBs |
Definition at line 199 of file lte-helper.cc.
References NS_LOG_FUNCTION, and ns3::ObjectFactory::SetTypeId().
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 191 of file lte-helper.cc.
References NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
void ns3::LteHelper::SetSchedulerType | ( | std::string | type | ) |
type | the type of scheduler to be used for the eNBs |
Definition at line 183 of file lte-helper.cc.
References NS_LOG_FUNCTION, and ns3::ObjectFactory::SetTypeId().
Referenced by LenaFdMtFfMacSchedulerTestCase::DoRun(), LenaTtaFfMacSchedulerTestCase::DoRun(), and LenaTdMtFfMacSchedulerTestCase::DoRun().
void ns3::LteHelper::SetSpectrumChannelAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
set an attribute for the SpectrumChannel to be used for the UEs
n | the name of the attribute |
v | the value of the attribute |
Definition at line 278 of file lte-helper.cc.
References ns3::ObjectFactory::Set().
void ns3::LteHelper::SetSpectrumChannelType | ( | std::string | type | ) |
type | the type of SpectrumChannel to be used for the UEs |
Definition at line 271 of file lte-helper.cc.
References NS_LOG_FUNCTION, and ns3::ObjectFactory::SetTypeId().
void ns3::LteHelper::SetUeAntennaModelAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
set an attribute for the AntennaModel to be used for the UEs
n | the name of the attribute |
v | the value of the attribute |
Definition at line 246 of file lte-helper.cc.
References NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
void ns3::LteHelper::SetUeAntennaModelType | ( | std::string | type | ) |
type | the type of AntennaModel to be used for the UEs |
Definition at line 239 of file lte-helper.cc.
References NS_LOG_FUNCTION, and ns3::ObjectFactory::SetTypeId().