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

This class implements a testing RRC entity. More...

#include "lte-test-entities.h"

+ Inheritance diagram for ns3::LteTestRrc:
+ Collaboration diagram for ns3::LteTestRrc:

Public Member Functions

 LteTestRrc ()
 
 ~LteTestRrc () override
 
void DoDispose () override
 Destructor implementation. More...
 
std::string GetDataReceived ()
 Get data received function. More...
 
LtePdcpSapUserGetLtePdcpSapUser ()
 Get the PDCP SAP user. More...
 
uint32_t GetRxBytes ()
 Get the receive bytes. More...
 
Time GetRxLastTime ()
 Get the last receive time. More...
 
uint32_t GetRxPdus ()
 Get the receive PDUs. More...
 
uint32_t GetTxBytes ()
 Get the transmit bytes. More...
 
Time GetTxLastTime ()
 Get the last transmit time. More...
 
uint32_t GetTxPdus ()
 Get the transmit PDUs. More...
 
void SendData (Time at, std::string dataToSend)
 Send data function. More...
 
void SetArrivalTime (Time arrivalTime)
 Set the arrival time. More...
 
void SetDevice (Ptr< NetDevice > device)
 Set the device. More...
 
void SetLtePdcpSapProvider (LtePdcpSapProvider *s)
 Set the PDCP SAP provider. More...
 
void SetPduSize (uint32_t pduSize)
 Set the PDU size. More...
 
void Start ()
 Start function. More...
 
void Stop ()
 Stop function. 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...
 

Private Member Functions

virtual void DoReceivePdcpSdu (LtePdcpSapUser::ReceivePdcpSduParameters params)
 Interface forwarded by LtePdcpSapUser. More...
 

Private Attributes

Time m_arrivalTime
 next arrival time More...
 
Ptr< NetDevicem_device
 the device More...
 
EventId m_nextPdu
 next PDU event More...
 
LtePdcpSapProviderm_pdcpSapProvider
 PDCP SAP provider. More...
 
LtePdcpSapUserm_pdcpSapUser
 PDCP SAP user. More...
 
uint32_t m_pduSize
 PDU size. More...
 
std::string m_receivedData
 the received data More...
 
uint32_t m_rxBytes
 number of receive bytes More...
 
Time m_rxLastTime
 last reeive time More...
 
uint32_t m_rxPdus
 number of receive PDUs More...
 
uint32_t m_txBytes
 number of transmit bytes More...
 
Time m_txLastTime
 last transmit time More...
 
uint32_t m_txPdus
 number of transmit PDUs More...
 

Friends

class LtePdcpSpecificLtePdcpSapUser< LteTestRrc >
 allow LtePdcpSpecificLtePdcpSapUser<LteTestRrc> class friend access More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize ()
 Initialize() implementation. 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...
 

Detailed Description

This class implements a testing RRC entity.

Definition at line 39 of file lte-test-entities.h.

Constructor & Destructor Documentation

◆ LteTestRrc()

◆ ~LteTestRrc()

ns3::LteTestRrc::~LteTestRrc ( )
override

Definition at line 59 of file lte-test-entities.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::LteTestRrc::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 65 of file lte-test-entities.cc.

References m_pdcpSapUser, and NS_LOG_FUNCTION.

◆ DoReceivePdcpSdu()

void ns3::LteTestRrc::DoReceivePdcpSdu ( LtePdcpSapUser::ReceivePdcpSduParameters  params)
privatevirtual

Interface forwarded by LtePdcpSapUser.

PDCP SAP.

Parameters
paramsthe LtePdcpSapUser::ReceivePdcpSduParameters

Definition at line 158 of file lte-test-entities.cc.

References ns3::Packet::CopyData(), ns3::Packet::GetSize(), m_receivedData, m_rxBytes, m_rxLastTime, m_rxPdus, ns3::Simulator::Now(), NS_LOG_FUNCTION, and two-ray-to-three-gpp-ch-calibration::params.

+ Here is the call graph for this function:

◆ GetDataReceived()

std::string ns3::LteTestRrc::GetDataReceived ( )

Get data received function.

Returns
the received data string

Definition at line 90 of file lte-test-entities.cc.

References m_receivedData, and NS_LOG_FUNCTION.

◆ GetLtePdcpSapUser()

LtePdcpSapUser * ns3::LteTestRrc::GetLtePdcpSapUser ( )

Get the PDCP SAP user.

Returns
a pointer to the SAP user of the RLC

Definition at line 84 of file lte-test-entities.cc.

References m_pdcpSapUser.

◆ GetRxBytes()

uint32_t ns3::LteTestRrc::GetRxBytes ( )

Get the receive bytes.

Returns
the number of bytes received

Definition at line 119 of file lte-test-entities.cc.

References m_rxBytes, and NS_LOG_FUNCTION.

◆ GetRxLastTime()

Time ns3::LteTestRrc::GetRxLastTime ( )

Get the last receive time.

Returns
the time of the last receive

Definition at line 133 of file lte-test-entities.cc.

References m_rxLastTime, and NS_LOG_FUNCTION.

◆ GetRxPdus()

uint32_t ns3::LteTestRrc::GetRxPdus ( )

Get the receive PDUs.

Returns
the number of receive PDUS

Definition at line 112 of file lte-test-entities.cc.

References m_rxPdus, and NS_LOG_FUNCTION.

◆ GetTxBytes()

uint32_t ns3::LteTestRrc::GetTxBytes ( )

Get the transmit bytes.

Returns
the number of bytes transmitted

Definition at line 105 of file lte-test-entities.cc.

References m_txBytes, and NS_LOG_FUNCTION.

◆ GetTxLastTime()

Time ns3::LteTestRrc::GetTxLastTime ( )

Get the last transmit time.

Returns
the time of the last transmit

Definition at line 126 of file lte-test-entities.cc.

References m_txLastTime, and NS_LOG_FUNCTION.

◆ GetTxPdus()

uint32_t ns3::LteTestRrc::GetTxPdus ( )

Get the transmit PDUs.

Returns
the number of transmit PDUS

Definition at line 98 of file lte-test-entities.cc.

References m_txPdus, and NS_LOG_FUNCTION.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 37 of file lte-test-entities.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SendData()

void ns3::LteTestRrc::SendData ( Time  at,
std::string  dataToSend 
)

◆ SetArrivalTime()

void ns3::LteTestRrc::SetArrivalTime ( Time  arrivalTime)

Set the arrival time.

Parameters
arrivalTimethe arrival time

Definition at line 140 of file lte-test-entities.cc.

References m_arrivalTime, and NS_LOG_FUNCTION.

◆ SetDevice()

void ns3::LteTestRrc::SetDevice ( Ptr< NetDevice device)

Set the device.

Parameters
devicethe device

Definition at line 72 of file lte-test-entities.cc.

References m_device.

◆ SetLtePdcpSapProvider()

void ns3::LteTestRrc::SetLtePdcpSapProvider ( LtePdcpSapProvider s)

Set the PDCP SAP provider.

Parameters
sa pointer to the PDCP SAP provider

Definition at line 78 of file lte-test-entities.cc.

References m_pdcpSapProvider.

◆ SetPduSize()

void ns3::LteTestRrc::SetPduSize ( uint32_t  pduSize)

Set the PDU size.

Parameters
pduSizethe PDU size

Definition at line 147 of file lte-test-entities.cc.

References m_pduSize, and NS_LOG_FUNCTION.

◆ Start()

◆ Stop()

void ns3::LteTestRrc::Stop ( )

Stop function.

Definition at line 228 of file lte-test-entities.cc.

References ns3::EventId::Cancel(), m_nextPdu, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Friends And Related Function Documentation

◆ LtePdcpSpecificLtePdcpSapUser< LteTestRrc >

friend class LtePdcpSpecificLtePdcpSapUser< LteTestRrc >
friend

allow LtePdcpSpecificLtePdcpSapUser<LteTestRrc> class friend access

Definition at line 1 of file lte-test-entities.h.

Referenced by LteTestRrc().

Member Data Documentation

◆ m_arrivalTime

Time ns3::LteTestRrc::m_arrivalTime
private

next arrival time

Definition at line 158 of file lte-test-entities.h.

Referenced by SetArrivalTime(), and Start().

◆ m_device

Ptr<NetDevice> ns3::LteTestRrc::m_device
private

the device

Definition at line 161 of file lte-test-entities.h.

Referenced by SetDevice(), and Start().

◆ m_nextPdu

EventId ns3::LteTestRrc::m_nextPdu
private

next PDU event

Definition at line 157 of file lte-test-entities.h.

Referenced by Start(), and Stop().

◆ m_pdcpSapProvider

LtePdcpSapProvider* ns3::LteTestRrc::m_pdcpSapProvider
private

PDCP SAP provider.

Definition at line 146 of file lte-test-entities.h.

Referenced by SendData(), SetLtePdcpSapProvider(), and Start().

◆ m_pdcpSapUser

LtePdcpSapUser* ns3::LteTestRrc::m_pdcpSapUser
private

PDCP SAP user.

Definition at line 145 of file lte-test-entities.h.

Referenced by LteTestRrc(), DoDispose(), and GetLtePdcpSapUser().

◆ m_pduSize

uint32_t ns3::LteTestRrc::m_pduSize
private

PDU size.

Definition at line 159 of file lte-test-entities.h.

Referenced by SetPduSize(), and Start().

◆ m_receivedData

std::string ns3::LteTestRrc::m_receivedData
private

the received data

Definition at line 148 of file lte-test-entities.h.

Referenced by DoReceivePdcpSdu(), and GetDataReceived().

◆ m_rxBytes

uint32_t ns3::LteTestRrc::m_rxBytes
private

number of receive bytes

Definition at line 153 of file lte-test-entities.h.

Referenced by LteTestRrc(), DoReceivePdcpSdu(), and GetRxBytes().

◆ m_rxLastTime

Time ns3::LteTestRrc::m_rxLastTime
private

last reeive time

Definition at line 155 of file lte-test-entities.h.

Referenced by LteTestRrc(), DoReceivePdcpSdu(), and GetRxLastTime().

◆ m_rxPdus

uint32_t ns3::LteTestRrc::m_rxPdus
private

number of receive PDUs

Definition at line 152 of file lte-test-entities.h.

Referenced by LteTestRrc(), DoReceivePdcpSdu(), and GetRxPdus().

◆ m_txBytes

uint32_t ns3::LteTestRrc::m_txBytes
private

number of transmit bytes

Definition at line 151 of file lte-test-entities.h.

Referenced by LteTestRrc(), GetTxBytes(), SendData(), and Start().

◆ m_txLastTime

Time ns3::LteTestRrc::m_txLastTime
private

last transmit time

Definition at line 154 of file lte-test-entities.h.

Referenced by LteTestRrc(), GetTxLastTime(), and Start().

◆ m_txPdus

uint32_t ns3::LteTestRrc::m_txPdus
private

number of transmit PDUs

Definition at line 150 of file lte-test-entities.h.

Referenced by LteTestRrc(), GetTxPdus(), SendData(), and Start().


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