A Discrete-Event Network Simulator
API
ns3::LteSimpleHelper Class Reference

A simplified version of LteHelper, that is used for creation and configuration of LTE entities for testing purposes when just a limited LteHelper functionality is wanted. More...

#include "lte-simple-helper.h"

+ Inheritance diagram for ns3::LteSimpleHelper:
+ Collaboration diagram for ns3::LteSimpleHelper:

Public Member Functions

 LteSimpleHelper ()
 
 ~LteSimpleHelper () override
 
void DoDispose () override
 Destructor implementation. More...
 
void EnableDlPdcpTraces ()
 Enable trace sinks for DL PDCP layer. More...
 
void EnableDlRlcTraces ()
 Enable trace sinks for DL RLC layer. More...
 
void EnableLogComponents ()
 Enables logging for all components of the LENA architecture. More...
 
void EnablePdcpTraces ()
 Enable trace sinks for PDCP layer. More...
 
void EnableRlcTraces ()
 Enable trace sinks for RLC layer. More...
 
void EnableTraces ()
 Enables trace sinks for MAC, RLC and PDCP. More...
 
void EnableUlPdcpTraces ()
 Enable trace sinks for UL PDCP layer. More...
 
void EnableUlRlcTraces ()
 Enable trace sinks for UL RLC layer. More...
 
NetDeviceContainer InstallEnbDevice (NodeContainer c)
 create a set of eNB devices More...
 
NetDeviceContainer InstallUeDevice (NodeContainer c)
 create a set of UE devices More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Public Attributes

Ptr< LteTestMacm_enbMac
 ENB MAC. More...
 
Ptr< LteTestRrcm_enbRrc
 ENB RRC. More...
 
Ptr< LteTestMacm_ueMac
 UE MAC. More...
 
Ptr< LteTestRrcm_ueRrc
 UE RRC. More...
 

Protected Member Functions

void DoInitialize () override
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Types

enum  LteRlcEntityType_t { RLC_UM = 1 , RLC_AM = 2 }
 LteRlcEntityType_t enumeration. More...
 

Private Member Functions

Ptr< NetDeviceInstallSingleEnbDevice (Ptr< Node > n)
 Install single ENB device. More...
 
Ptr< NetDeviceInstallSingleUeDevice (Ptr< Node > n)
 Install single UE device. More...
 

Private Attributes

ObjectFactory m_enbDeviceFactory
 ENB device factory. More...
 
Ptr< LtePdcpm_enbPdcp
 ENB PDCP. More...
 
Ptr< LteRlcm_enbRlc
 ENB RLC. More...
 
enum ns3::LteSimpleHelper::LteRlcEntityType_t m_lteRlcEntityType
 RLC entity type. More...
 
Ptr< SimpleChannelm_phyChannel
 the physical channel More...
 
ObjectFactory m_ueDeviceFactory
 UE device factory. More...
 
Ptr< LtePdcpm_uePdcp
 UE PDCP. More...
 
Ptr< LteRlcm_ueRlc
 UE RLC. More...
 

Additional Inherited Members

Detailed Description

A simplified version of LteHelper, that is used for creation and configuration of LTE entities for testing purposes when just a limited LteHelper functionality is wanted.

Definition at line 47 of file lte-simple-helper.h.

Member Enumeration Documentation

◆ LteRlcEntityType_t

LteRlcEntityType_t enumeration.

Enumerator
RLC_UM 
RLC_AM 

Definition at line 159 of file lte-simple-helper.h.

Constructor & Destructor Documentation

◆ LteSimpleHelper()

ns3::LteSimpleHelper::LteSimpleHelper ( )

Definition at line 39 of file lte-simple-helper.cc.

References ns3::LteSimpleNetDevice::GetTypeId(), m_enbDeviceFactory, m_ueDeviceFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::SetTypeId().

+ Here is the call graph for this function:

◆ ~LteSimpleHelper()

ns3::LteSimpleHelper::~LteSimpleHelper ( )
override

Definition at line 56 of file lte-simple-helper.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::LteSimpleHelper::DoDispose ( void  )
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 77 of file lte-simple-helper.cc.

References ns3::Object::Dispose(), ns3::Object::DoDispose(), m_enbMac, m_phyChannel, m_ueMac, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoInitialize()

void ns3::LteSimpleHelper::DoInitialize ( void  )
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 47 of file lte-simple-helper.cc.

References ns3::Object::DoInitialize(), m_phyChannel, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ EnableDlPdcpTraces()

void ns3::LteSimpleHelper::EnableDlPdcpTraces ( )

Enable trace sinks for DL PDCP layer.

Definition at line 365 of file lte-simple-helper.cc.

References NS_LOG_FUNCTION_NOARGS.

Referenced by EnablePdcpTraces().

+ Here is the caller graph for this function:

◆ EnableDlRlcTraces()

void ns3::LteSimpleHelper::EnableDlRlcTraces ( )

Enable trace sinks for DL RLC layer.

Definition at line 290 of file lte-simple-helper.cc.

References NS_LOG_FUNCTION_NOARGS.

Referenced by EnableRlcTraces().

+ Here is the caller graph for this function:

◆ EnableLogComponents()

void ns3::LteSimpleHelper::EnableLogComponents ( )

Enables logging for all components of the LENA architecture.

Definition at line 212 of file lte-simple-helper.cc.

References ns3::LOG_LEVEL_ALL, ns3::LOG_PREFIX_FUNC, ns3::LOG_PREFIX_NODE, ns3::LOG_PREFIX_TIME, and ns3::LogComponentEnable().

+ Here is the call graph for this function:

◆ EnablePdcpTraces()

void ns3::LteSimpleHelper::EnablePdcpTraces ( )

Enable trace sinks for PDCP layer.

Definition at line 358 of file lte-simple-helper.cc.

References EnableDlPdcpTraces(), and EnableUlPdcpTraces().

Referenced by EnableTraces().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ EnableRlcTraces()

void ns3::LteSimpleHelper::EnableRlcTraces ( )

Enable trace sinks for RLC layer.

Definition at line 237 of file lte-simple-helper.cc.

References EnableDlRlcTraces(), and EnableUlRlcTraces().

Referenced by EnableTraces().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ EnableTraces()

void ns3::LteSimpleHelper::EnableTraces ( )

Enables trace sinks for MAC, RLC and PDCP.

Definition at line 229 of file lte-simple-helper.cc.

References EnablePdcpTraces(), and EnableRlcTraces().

+ Here is the call graph for this function:

◆ EnableUlPdcpTraces()

void ns3::LteSimpleHelper::EnableUlPdcpTraces ( )

Enable trace sinks for UL PDCP layer.

Definition at line 376 of file lte-simple-helper.cc.

References NS_LOG_FUNCTION_NOARGS.

Referenced by EnablePdcpTraces().

+ Here is the caller graph for this function:

◆ EnableUlRlcTraces()

void ns3::LteSimpleHelper::EnableUlRlcTraces ( )

Enable trace sinks for UL RLC layer.

Definition at line 347 of file lte-simple-helper.cc.

References NS_LOG_FUNCTION_NOARGS.

Referenced by EnableRlcTraces().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::LteSimpleHelper::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 62 of file lte-simple-helper.cc.

References m_lteRlcEntityType, ns3::MakeEnumChecker(), RLC_AM, RLC_UM, and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ InstallEnbDevice()

NetDeviceContainer ns3::LteSimpleHelper::InstallEnbDevice ( NodeContainer  c)

create a set of eNB devices

Parameters
cthe node container where the devices are to be installed
Returns
the NetDeviceContainer with the newly created devices

Definition at line 91 of file lte-simple-helper.cc.

References ns3::NodeContainer::Begin(), first::devices, ns3::NodeContainer::End(), ns3::Object::Initialize(), InstallSingleEnbDevice(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ InstallSingleEnbDevice()

◆ InstallSingleUeDevice()

◆ InstallUeDevice()

NetDeviceContainer ns3::LteSimpleHelper::InstallUeDevice ( NodeContainer  c)

create a set of UE devices

Parameters
cthe node container where the devices are to be installed
Returns
the NetDeviceContainer with the newly created devices

Definition at line 106 of file lte-simple-helper.cc.

References ns3::NodeContainer::Begin(), first::devices, ns3::NodeContainer::End(), InstallSingleUeDevice(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_enbDeviceFactory

ObjectFactory ns3::LteSimpleHelper::m_enbDeviceFactory
private

ENB device factory.

Definition at line 155 of file lte-simple-helper.h.

Referenced by LteSimpleHelper(), and InstallSingleEnbDevice().

◆ m_enbMac

Ptr<LteTestMac> ns3::LteSimpleHelper::m_enbMac

ENB MAC.

Definition at line 145 of file lte-simple-helper.h.

Referenced by DoDispose(), and InstallSingleEnbDevice().

◆ m_enbPdcp

Ptr<LtePdcp> ns3::LteSimpleHelper::m_enbPdcp
private

ENB PDCP.

Definition at line 149 of file lte-simple-helper.h.

Referenced by InstallSingleEnbDevice().

◆ m_enbRlc

Ptr<LteRlc> ns3::LteSimpleHelper::m_enbRlc
private

ENB RLC.

Definition at line 150 of file lte-simple-helper.h.

Referenced by InstallSingleEnbDevice().

◆ m_enbRrc

Ptr<LteTestRrc> ns3::LteSimpleHelper::m_enbRrc

ENB RRC.

Definition at line 142 of file lte-simple-helper.h.

Referenced by InstallSingleEnbDevice().

◆ m_lteRlcEntityType

enum ns3::LteSimpleHelper::LteRlcEntityType_t ns3::LteSimpleHelper::m_lteRlcEntityType
private

RLC entity type.

Referenced by GetTypeId(), InstallSingleEnbDevice(), and InstallSingleUeDevice().

◆ m_phyChannel

Ptr<SimpleChannel> ns3::LteSimpleHelper::m_phyChannel
private

the physical channel

Definition at line 139 of file lte-simple-helper.h.

Referenced by DoDispose(), DoInitialize(), InstallSingleEnbDevice(), and InstallSingleUeDevice().

◆ m_ueDeviceFactory

ObjectFactory ns3::LteSimpleHelper::m_ueDeviceFactory
private

UE device factory.

Definition at line 156 of file lte-simple-helper.h.

Referenced by LteSimpleHelper(), and InstallSingleUeDevice().

◆ m_ueMac

Ptr<LteTestMac> ns3::LteSimpleHelper::m_ueMac

UE MAC.

Definition at line 146 of file lte-simple-helper.h.

Referenced by DoDispose(), and InstallSingleUeDevice().

◆ m_uePdcp

Ptr<LtePdcp> ns3::LteSimpleHelper::m_uePdcp
private

UE PDCP.

Definition at line 152 of file lte-simple-helper.h.

Referenced by InstallSingleUeDevice().

◆ m_ueRlc

Ptr<LteRlc> ns3::LteSimpleHelper::m_ueRlc
private

UE RLC.

Definition at line 153 of file lte-simple-helper.h.

Referenced by InstallSingleUeDevice().

◆ m_ueRrc

Ptr<LteTestRrc> ns3::LteSimpleHelper::m_ueRrc

UE RRC.

Definition at line 143 of file lte-simple-helper.h.

Referenced by InstallSingleUeDevice().


The documentation for this class was generated from the following files: