Testing the initial cell selection procedure by UE at IDLE state in the beginning of simulation. More...

#include "lte-test-cell-selection.h"

Inheritance diagram for LteCellSelectionTestCase:

Collaboration diagram for LteCellSelectionTestCase:

Classes
struct	UeSetup_t
	A set of input parameters for setting up a UE in the simulation. More...

Public Member Functions
	LteCellSelectionTestCase (std::string name, bool isEpcMode, bool isIdealRrc, double interSiteDistance, std::vector< UeSetup_t > ueSetupList)
	Creates an instance of the initial cell selection test case.

	~LteCellSelectionTestCase () override

Public Member Functions inherited from ns3::TestCase
	TestCase (const TestCase &)=delete

virtual	~TestCase ()
	Destructor.

std::string	GetName () const

TestCase &	operator= (const TestCase &)=delete

Private Member Functions
void	CheckPoint (Ptr< LteUeNetDevice > ueDev, uint16_t expectedCellId1, uint16_t expectedCellId2)
	Verifies if the given UE is attached to either of the given two cells and in a CONNECTED_NORMALLY state.

void	ConnectionEstablishedCallback (std::string context, uint64_t imsi, uint16_t cellId, uint16_t rnti)
	Connection established callback function.

void	DoRun () override
	Setup the simulation according to the configuration set by the class constructor, run it, and verify the result.

void	InitialCellSelectionEndErrorCallback (std::string context, uint64_t imsi, uint16_t cellId)
	Initial cell selection end error callback function.

void	InitialCellSelectionEndOkCallback (std::string context, uint64_t imsi, uint16_t cellId)
	Initial cell selection end ok callback function.

void	StateTransitionCallback (std::string context, uint64_t imsi, uint16_t cellId, uint16_t rnti, LteUeRrc::State oldState, LteUeRrc::State newState)
	State transition callback function.

Private Attributes
double	m_interSiteDistance
	inter site distance

bool	m_isEpcMode
	whether the LTE configuration in test is using EPC

bool	m_isIdealRrc
	whether the LTE is configured to use ideal RRC

std::vector< LteUeRrc::State >	m_lastState
	The current UE RRC state.

std::vector< UeSetup_t >	m_ueSetupList
	UE setup list.

Additional Inherited Members
Public Types inherited from ns3::TestCase
enum class	Duration { QUICK = 1 , EXTENSIVE = 2 , TAKES_FOREVER = 3 }
	How long the test takes to execute. More...

Static Public Attributes inherited from ns3::TestCase
static constexpr auto	QUICK = Duration::QUICK
	Deprecated test duration simple enums.

static constexpr auto	EXTENSIVE = Duration::EXTENSIVE

static constexpr auto	TAKES_FOREVER = Duration::TAKES_FOREVER

Protected Member Functions inherited from ns3::TestCase
	TestCase (std::string name)
	Constructor.

void	AddTestCase (TestCase *testCase, Duration duration=Duration::QUICK)
	Add an individual child TestCase to this test suite.

TestCase *	GetParent () const
	Get the parent of this TestCase.

bool	IsStatusFailure () const
	Check if any tests failed.

bool	IsStatusSuccess () const
	Check if all tests passed.

void	SetDataDir (std::string directory)
	Set the data directory where reference trace files can be found.

void	ReportTestFailure (std::string cond, std::string actual, std::string limit, std::string message, std::string file, int32_t line)
	Log the failure of this TestCase.

bool	MustAssertOnFailure () const
	Check if this run should assert on failure.

bool	MustContinueOnFailure () const
	Check if this run should continue on failure.

std::string	CreateDataDirFilename (std::string filename)
	Construct the full path to a file in the data directory.

std::string	CreateTempDirFilename (std::string filename)
	Construct the full path to a file in a temporary directory.

Detailed Description

Testing the initial cell selection procedure by UE at IDLE state in the beginning of simulation.

Definition at line 48 of file lte-test-cell-selection.h.

Constructor & Destructor Documentation

◆ LteCellSelectionTestCase()

LteCellSelectionTestCase::LteCellSelectionTestCase	(	std::string	name,
		bool	isEpcMode,
		bool	isIdealRrc,
		double	interSiteDistance,
		std::vector< UeSetup_t >	ueSetupList )

Creates an instance of the initial cell selection test case.

Parameters

name	name of this test
isEpcMode	set to true for setting up simulation with EPC enabled
isIdealRrc	if true, simulation uses Ideal RRC protocol, otherwise simulation uses Real RRC protocol
interSiteDistance	the distance between eNodeB in meters
ueSetupList	a list of UE configuration to be installed in the simulation

Definition at line 112 of file lte-test-cell-selection.cc.

References ns3::TestCase::GetName(), m_lastState, m_ueSetupList, NS_LOG_FUNCTION, and ns3::LteUeRrc::NUM_STATES.

Here is the call graph for this function:

◆ ~LteCellSelectionTestCase()

LteCellSelectionTestCase::~LteCellSelectionTestCase ( )

override

Definition at line 127 of file lte-test-cell-selection.cc.

References ns3::TestCase::GetName(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Function Documentation

◆ CheckPoint()

void LteCellSelectionTestCase::CheckPoint	(	Ptr< LteUeNetDevice >	ueDev,
		uint16_t	expectedCellId1,
		uint16_t	expectedCellId2 )

private

Verifies if the given UE is attached to either of the given two cells and in a CONNECTED_NORMALLY state.

Parameters

ueDev	the UE device
expectedCellId1	the first cell ID
expectedCellId2	the second cell ID

Definition at line 355 of file lte-test-cell-selection.cc.

References ns3::LteUeRrc::CONNECTED_NORMALLY, m_lastState, and NS_TEST_ASSERT_MSG_EQ.

Referenced by DoRun().

Here is the caller graph for this function:

◆ ConnectionEstablishedCallback()

void LteCellSelectionTestCase::ConnectionEstablishedCallback	(	std::string	context,
		uint64_t	imsi,
		uint16_t	cellId,
		uint16_t	rnti )

private

Connection established callback function.

Parameters

context	the context string
imsi	the IMSI
cellId	the cell ID
rnti	the RNTI

Definition at line 415 of file lte-test-cell-selection.cc.

References NS_LOG_FUNCTION.

Referenced by DoRun().

Here is the caller graph for this function:

◆ DoRun()

void LteCellSelectionTestCase::DoRun ( )

overrideprivatevirtual

Setup the simulation according to the configuration set by the class constructor, run it, and verify the result.

Implements ns3::TestCase.

Definition at line 133 of file lte-test-cell-selection.cc.

References ns3::NetDeviceContainer::Add(), ns3::Ipv4AddressHelper::Assign(), ns3::NetDeviceContainer::Begin(), ns3::NodeContainer::Begin(), CheckPoint(), ns3::Config::Connect(), ConnectionEstablishedCallback(), ns3::NodeContainer::Create(), ns3::CreateObject(), ns3::Simulator::Destroy(), ns3::NetDeviceContainer::End(), ns3::NodeContainer::End(), ns3::NetDeviceContainer::Get(), ns3::NodeContainer::Get(), ns3::NetDeviceContainer::GetN(), ns3::NodeContainer::GetN(), ns3::TestCase::GetName(), ns3::RngSeedManager::GetRun(), ns3::RngSeedManager::GetSeed(), ns3::Ipv4StaticRoutingHelper::GetStaticRouting(), InitialCellSelectionEndErrorCallback(), InitialCellSelectionEndOkCallback(), ns3::PointToPointHelper::Install(), m_interSiteDistance, m_isEpcMode, m_isIdealRrc, m_ueSetupList, ns3::MakeCallback(), ns3::MilliSeconds(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::Simulator::Run(), ns3::Simulator::Schedule(), ns3::Seconds(), ns3::Ipv4AddressHelper::SetBase(), ns3::PointToPointHelper::SetChannelAttribute(), ns3::PointToPointHelper::SetDeviceAttribute(), ns3::Config::SetGlobal(), StateTransitionCallback(), and ns3::Simulator::Stop().

Here is the call graph for this function:

◆ InitialCellSelectionEndErrorCallback()

void LteCellSelectionTestCase::InitialCellSelectionEndErrorCallback	(	std::string	context,
		uint64_t	imsi,
		uint16_t	cellId )

private

Initial cell selection end error callback function.

Parameters

context	the context string
imsi	the IMSI
cellId	the cell ID

Definition at line 407 of file lte-test-cell-selection.cc.

References NS_LOG_FUNCTION.

Referenced by DoRun().

Here is the caller graph for this function:

◆ InitialCellSelectionEndOkCallback()

void LteCellSelectionTestCase::InitialCellSelectionEndOkCallback	(	std::string	context,
		uint64_t	imsi,
		uint16_t	cellId )

private

Initial cell selection end ok callback function.

Parameters

context	the context string
imsi	the IMSI
cellId	the cell ID

Definition at line 399 of file lte-test-cell-selection.cc.

References NS_LOG_FUNCTION.

Referenced by DoRun().

Here is the caller graph for this function:

◆ StateTransitionCallback()

void LteCellSelectionTestCase::StateTransitionCallback	(	std::string	context,
		uint64_t	imsi,
		uint16_t	cellId,
		uint16_t	rnti,
		LteUeRrc::State	oldState,
		LteUeRrc::State	newState )

private

State transition callback function.

Parameters

context	the context string
imsi	the IMSI
cellId	the cell ID
rnti	the RNTI
oldState	the old state
newState	the new state

std::vector<UeSetup_t> LteCellSelectionTestCase::m_ueSetupList

private

UE setup list.

Definition at line 161 of file lte-test-cell-selection.h.

Referenced by LteCellSelectionTestCase(), and DoRun().

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

src/lte/test/lte-test-cell-selection.h
src/lte/test/lte-test-cell-selection.cc

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LteCellSelectionTestCase()

◆ ~LteCellSelectionTestCase()

Member Function Documentation

◆ CheckPoint()

◆ ConnectionEstablishedCallback()

◆ DoRun()

◆ InitialCellSelectionEndErrorCallback()

◆ InitialCellSelectionEndOkCallback()

◆ StateTransitionCallback()

Member Data Documentation

◆ m_interSiteDistance

◆ m_isEpcMode

◆ m_isIdealRrc

◆ m_lastState

◆ m_ueSetupList