A Discrete-Event Network Simulator
API
ns3::MemberLteAsSapProvider< C > Class Template Reference

Template for the implementation of the LteAsSapProvider as a member of an owner class of type C to which all methods are forwarded. More...

#include "lte-as-sap.h"

+ Inheritance diagram for ns3::MemberLteAsSapProvider< C >:
+ Collaboration diagram for ns3::MemberLteAsSapProvider< C >:

Public Member Functions

 MemberLteAsSapProvider (C *owner)
 Constructor. More...
 
virtual void Connect (void)
 Tell the RRC entity to enter Connected mode. More...
 
virtual void Disconnect ()
 Tell the RRC entity to release the connection. More...
 
virtual void ForceCampedOnEnb (uint16_t cellId, uint32_t dlEarfcn)
 Force the RRC entity to stay camped on a certain eNodeB. More...
 
virtual void SendData (Ptr< Packet > packet, uint8_t bid)
 Send a data packet. More...
 
virtual void SetCsgWhiteList (uint32_t csgId)
 Set the selected Closed Subscriber Group subscription list to be used for cell selection. More...
 
virtual void StartCellSelection (uint32_t dlEarfcn)
 Initiate Idle mode cell selection procedure. More...
 
- Public Member Functions inherited from ns3::LteAsSapProvider
virtual ~LteAsSapProvider ()
 

Private Member Functions

 MemberLteAsSapProvider ()
 

Private Attributes

C * m_owner
 the owner class More...
 

Detailed Description

template<class C>
class ns3::MemberLteAsSapProvider< C >

Template for the implementation of the LteAsSapProvider as a member of an owner class of type C to which all methods are forwarded.

Definition at line 145 of file lte-as-sap.h.

Constructor & Destructor Documentation

◆ MemberLteAsSapProvider() [1/2]

template<class C >
ns3::MemberLteAsSapProvider< C >::MemberLteAsSapProvider ( C *  owner)

Constructor.

Parameters
ownerthe owner class

Definition at line 169 of file lte-as-sap.h.

◆ MemberLteAsSapProvider() [2/2]

template<class C >
ns3::MemberLteAsSapProvider< C >::MemberLteAsSapProvider ( )
private

Definition at line 175 of file lte-as-sap.h.

Member Function Documentation

◆ Connect()

template<class C >
void ns3::MemberLteAsSapProvider< C >::Connect ( void  )
virtual

Tell the RRC entity to enter Connected mode.

If this function is called when the UE is in a situation where connecting 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).

Implements ns3::LteAsSapProvider.

Definition at line 202 of file lte-as-sap.h.

◆ Disconnect()

template<class C >
void ns3::MemberLteAsSapProvider< C >::Disconnect ( )
virtual

Tell the RRC entity to release the connection.

Implements ns3::LteAsSapProvider.

Definition at line 216 of file lte-as-sap.h.

◆ ForceCampedOnEnb()

template<class C >
void ns3::MemberLteAsSapProvider< C >::ForceCampedOnEnb ( uint16_t  cellId,
uint32_t  dlEarfcn 
)
virtual

Force the RRC entity to stay camped on a certain eNodeB.

Parameters
cellIdthe cell ID identifying the eNodeB
dlEarfcnthe downlink carrier frequency (EARFCN)

Implements ns3::LteAsSapProvider.

Definition at line 195 of file lte-as-sap.h.

◆ SendData()

template<class C >
void ns3::MemberLteAsSapProvider< C >::SendData ( Ptr< Packet packet,
uint8_t  bid 
)
virtual

Send a data packet.

Parameters
packetthe packet
bidthe EPS bearer ID

Implements ns3::LteAsSapProvider.

Definition at line 209 of file lte-as-sap.h.

◆ SetCsgWhiteList()

template<class C >
void ns3::MemberLteAsSapProvider< C >::SetCsgWhiteList ( uint32_t  csgId)
virtual

Set the selected Closed Subscriber Group subscription list to be used for cell selection.

Parameters
csgIdidentity of the subscribed CSG

Implements ns3::LteAsSapProvider.

Definition at line 181 of file lte-as-sap.h.

◆ StartCellSelection()

template<class C >
void ns3::MemberLteAsSapProvider< C >::StartCellSelection ( uint32_t  dlEarfcn)
virtual

Initiate Idle mode cell selection procedure.

Parameters
dlEarfcnthe downlink carrier frequency (EARFCN)

Implements ns3::LteAsSapProvider.

Definition at line 188 of file lte-as-sap.h.

Member Data Documentation

◆ m_owner

template<class C>
C* ns3::MemberLteAsSapProvider< C >::m_owner
private

the owner class

Definition at line 165 of file lte-as-sap.h.


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