Creation and configuration of LTE entities. More...

#include "lte-simple-helper.h"

Inheritance diagram for ns3::LteSimpleHelper:

Collaboration diagram for ns3::LteSimpleHelper:

Public Member Functions
	LteSimpleHelper (void)

virtual	~LteSimpleHelper (void)

virtual void	DoDispose (void)
	Destructor implementation. More...

void	EnableDlPdcpTraces (void)
	Enable trace sinks for DL PDCP layer. More...

void	EnableDlRlcTraces (void)
	Enable trace sinks for DL RLC layer. More...

void	EnableLogComponents (void)
	Enables logging for all components of the LENA architecture. More...

void	EnablePdcpTraces (void)
	Enable trace sinks for PDCP layer. More...

void	EnableRlcTraces (void)
	Enable trace sinks for RLC layer. More...

void	EnableTraces (void)
	Enables trace sinks for MAC, RLC and PDCP. More...

void	EnableUlPdcpTraces (void)
	Enable trace sinks for UL PDCP layer. More...

void	EnableUlRlcTraces (void)
	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...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Implement the GetInstanceTypeId method defined in ObjectBase. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) 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 erros. 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 (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

Public Attributes
Ptr< LteTestMac >	m_enbMac

Ptr< LteTestRrc >	m_enbRrc

Ptr< LteTestMac >	m_ueMac

Ptr< LteTestRrc >	m_ueRrc

Protected Member Functions
virtual void	DoInitialize (void)
	Initialize() implementation. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	NotifyNewAggregate (void)
	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 (void)
	Notifier called once the ObjectBase is fully constructed. More...

Private Types
enum	LteRlcEntityType_t { RLC_UM = 1, RLC_AM = 2 }

Private Member Functions
Ptr< NetDevice >	InstallSingleEnbDevice (Ptr< Node > n)

Ptr< NetDevice >	InstallSingleUeDevice (Ptr< Node > n)

Private Attributes
ObjectFactory	m_enbDeviceFactory

Ptr< LtePdcp >	m_enbPdcp

Ptr< LteRlc >	m_enbRlc

enum ns3::LteSimpleHelper::LteRlcEntityType_t	m_lteRlcEntityType

Ptr< SimpleChannel >	m_phyChannel

ObjectFactory	m_ueDeviceFactory

Ptr< LtePdcp >	m_uePdcp

Ptr< LteRlc >	m_ueRlc

Additional Inherited Members
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Creation and configuration of LTE entities.

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

Member Enumeration Documentation

enum ns3::LteSimpleHelper::LteRlcEntityType_t

private

Enumerator
RLC_UM
RLC_AM

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

Constructor & Destructor Documentation

ns3::LteSimpleHelper::LteSimpleHelper ( void )

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:

ns3::LteSimpleHelper::~LteSimpleHelper ( void )

virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::LteSimpleHelper::DoDispose ( void )

virtual

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 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 79 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:

void ns3::LteSimpleHelper::DoInitialize ( void )

protectedvirtual

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:

void ns3::LteSimpleHelper::EnableDlPdcpTraces ( void )

Enable trace sinks for DL PDCP layer.

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

References NS_LOG_FUNCTION_NOARGS.

Referenced by EnablePdcpTraces().

Here is the caller graph for this function:

void ns3::LteSimpleHelper::EnableDlRlcTraces ( void )

Enable trace sinks for DL RLC layer.

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

References NS_LOG_FUNCTION_NOARGS.

Referenced by EnableRlcTraces().

Here is the caller graph for this function:

void ns3::LteSimpleHelper::EnableLogComponents ( void )

Enables logging for all components of the LENA architecture.

Definition at line 217 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:

void ns3::LteSimpleHelper::EnablePdcpTraces ( void )

Enable trace sinks for PDCP layer.

Definition at line 314 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:

void ns3::LteSimpleHelper::EnableRlcTraces ( void )

Enable trace sinks for RLC layer.

Definition at line 242 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:

void ns3::LteSimpleHelper::EnableTraces ( void )

Enables trace sinks for MAC, RLC and PDCP.

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

References EnablePdcpTraces(), and EnableRlcTraces().

Here is the call graph for this function:

void ns3::LteSimpleHelper::EnableUlPdcpTraces ( void )

Enable trace sinks for UL PDCP layer.

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

References NS_LOG_FUNCTION_NOARGS.

Referenced by EnablePdcpTraces().

Here is the caller graph for this function:

void ns3::LteSimpleHelper::EnableUlRlcTraces ( void )

Enable trace sinks for UL RLC layer.

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

References NS_LOG_FUNCTION_NOARGS.

Referenced by EnableRlcTraces().

Here is the caller graph for this function:

TypeId ns3::LteSimpleHelper::GetTypeId ( void )

static

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

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

Here is the call graph for this function:

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

create a set of eNB devices

Parameters

c	the node container where the devices are to be installed

Returns: the NetDeviceContainer with the newly created devices

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

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

Referenced by LteRlcUmE2eTestCase::DoRun(), and LteRlcAmE2eTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr< NetDevice > ns3::LteSimpleHelper::InstallSingleEnbDevice ( Ptr< Node > n )

private

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

References ns3::Node::AddDevice(), ns3::Mac48Address::Allocate(), ns3::ObjectFactory::Create(), ns3::LteTestMac::GetLteMacSapProvider(), ns3::LteRlc::GetLteMacSapUser(), ns3::LteRlc::GetLteRlcSapProvider(), m_enbDeviceFactory, m_enbMac, m_enbPdcp, m_enbRlc, m_enbRrc, m_lteRlcEntityType, m_phyChannel, ns3::MakeCallback(), NS_LOG_FUNCTION, ns3::LteTestMac::Receive(), RLC_UM, ns3::LteTestMac::SetDevice(), ns3::LteRlc::SetLcId(), ns3::LteRlc::SetLteMacSapProvider(), ns3::LteTestMac::SetLteMacSapUser(), ns3::LteRlc::SetLteRlcSapUser(), and ns3::LteRlc::SetRnti().

Referenced by InstallEnbDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

Ptr< NetDevice > ns3::LteSimpleHelper::InstallSingleUeDevice ( Ptr< Node > n )

private

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

References ns3::Node::AddDevice(), ns3::Mac48Address::Allocate(), ns3::ObjectFactory::Create(), ns3::LteTestMac::GetLteMacSapProvider(), ns3::LteRlc::GetLteMacSapUser(), ns3::LteRlc::GetLteRlcSapProvider(), m_lteRlcEntityType, m_phyChannel, m_ueDeviceFactory, m_ueMac, m_uePdcp, m_ueRlc, m_ueRrc, ns3::MakeCallback(), NS_LOG_FUNCTION, ns3::LteTestMac::Receive(), RLC_UM, ns3::LteTestMac::SetDevice(), ns3::LteRlc::SetLcId(), ns3::LteRlc::SetLteMacSapProvider(), ns3::LteTestMac::SetLteMacSapUser(), ns3::LteRlc::SetLteRlcSapUser(), and ns3::LteRlc::SetRnti().

Referenced by InstallUeDevice().

Here is the call graph for this function:

Here is the caller graph for this function:

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

create a set of UE devices

Parameters

c	the node container where the devices are to be installed

Returns: the NetDeviceContainer with the newly created devices

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

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

Referenced by LteRlcUmE2eTestCase::DoRun(), and LteRlcAmE2eTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

ObjectFactory ns3::LteSimpleHelper::m_enbDeviceFactory

private

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

Referenced by InstallSingleEnbDevice(), and LteSimpleHelper().

Ptr<LteTestMac> ns3::LteSimpleHelper::m_enbMac

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

Referenced by DoDispose(), LteRlcUmE2eTestCase::DoRun(), LteRlcAmE2eTestCase::DoRun(), and InstallSingleEnbDevice().

Ptr<LtePdcp> ns3::LteSimpleHelper::m_enbPdcp

private

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

Referenced by InstallSingleEnbDevice().

Ptr<LteRlc> ns3::LteSimpleHelper::m_enbRlc

private

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

Referenced by InstallSingleEnbDevice().

Ptr<LteTestRrc> ns3::LteSimpleHelper::m_enbRrc

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

Referenced by LteRlcUmE2eTestCase::DoRun(), LteRlcAmE2eTestCase::DoRun(), and InstallSingleEnbDevice().

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

private

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

Ptr<SimpleChannel> ns3::LteSimpleHelper::m_phyChannel

private

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

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

ObjectFactory ns3::LteSimpleHelper::m_ueDeviceFactory

private

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

Referenced by InstallSingleUeDevice(), and LteSimpleHelper().

Ptr<LteTestMac> ns3::LteSimpleHelper::m_ueMac

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

Referenced by DoDispose(), LteRlcUmE2eTestCase::DoRun(), LteRlcAmE2eTestCase::DoRun(), and InstallSingleUeDevice().

Ptr<LtePdcp> ns3::LteSimpleHelper::m_uePdcp

private

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

Referenced by InstallSingleUeDevice().

Ptr<LteRlc> ns3::LteSimpleHelper::m_ueRlc

private

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

Referenced by InstallSingleUeDevice().

Ptr<LteTestRrc> ns3::LteSimpleHelper::m_ueRrc

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

Referenced by LteRlcUmE2eTestCase::DoRun(), LteRlcAmE2eTestCase::DoRun(), and InstallSingleUeDevice().

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

src/lte/test/lte-simple-helper.h
src/lte/test/lte-simple-helper.cc

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation