A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ns3::LteSimpleHelper Class Reference

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)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. 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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. 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
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

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)
 This method is called only once by Object::Initialize. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. 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
 

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 41 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 58 of file lte-simple-helper.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

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

References 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

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 49 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 63 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
cthe node container where the devices are to be installed
Returns
the NetDeviceContainer with the newly created devices

Definition at line 96 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.

+ Here is the call graph for this function:

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

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

References ns3::Node::AddDevice(), ns3::Mac48Address::Allocate(), ns3::ObjectFactory::Create(), m_enbDeviceFactory, m_enbMac, m_enbPdcp, m_enbRlc, m_enbRrc, m_lteRlcEntityType, m_phyChannel, ns3::MakeCallback(), NS_LOG_FUNCTION, ns3::LteTestMac::Receive(), and RLC_UM.

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(), m_lteRlcEntityType, m_phyChannel, m_ueDeviceFactory, m_ueMac, m_uePdcp, m_ueRlc, m_ueRrc, ns3::MakeCallback(), NS_LOG_FUNCTION, ns3::LteTestMac::Receive(), and RLC_UM.

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
cthe node container where the devices are to be installed
Returns
the NetDeviceContainer with the newly created devices

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

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

+ Here is the call 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(), 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 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(), 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 InstallSingleUeDevice().

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