SpectrumInterferenceTestCase Class Reference

Spectrum Interference Test. More...

Inheritance diagram for SpectrumInterferenceTestCase:

Collaboration diagram for SpectrumInterferenceTestCase:

Public Member Functions
	SpectrumInterferenceTestCase (Ptr< SpectrumValue > s, uint32_t txBytes, bool rxCorrect, std::string name)
	Constructor.
	~SpectrumInterferenceTestCase () override
void	DoRun () override
	Implementation to actually run this TestCase.
void	RetrieveTestResult (SpectrumInterference *si)
	Retrieve the test results.
Public Member Functions inherited from ns3::TestCase
	TestCase (const TestCase &)=delete
virtual	~TestCase ()
	Destructor.
std::string	GetName () const
TestCase &	operator= (const TestCase &)=delete

Private Attributes
Ptr< const SpectrumModel >	m_mySpectrumModel
	Spectrum model pointer.
bool	m_rxCorrectKnownOutcome
	expected Rx bytes
Ptr< SpectrumValue >	m_s
	Spectrum value.
uint32_t	m_txBytes
	number of bytes to transmit

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

Spectrum Interference Test.

Definition at line 29 of file spectrum-interference-test.cc.

Constructor & Destructor Documentation

SpectrumInterferenceTestCase()

SpectrumInterferenceTestCase::SpectrumInterferenceTestCase	(	Ptr< SpectrumValue >	s,
		uint32_t	txBytes,
		bool	rxCorrect,
		std::string	name )

Constructor.

Parameters

s	Spectrum value
txBytes	number of bytes to transmit
rxCorrect	expected Rx bytes
name	test name

Definition at line 58 of file spectrum-interference-test.cc.

~SpectrumInterferenceTestCase()

SpectrumInterferenceTestCase::~SpectrumInterferenceTestCase ( )

override

Definition at line 70 of file spectrum-interference-test.cc.

Member Function Documentation

DoRun()

void SpectrumInterferenceTestCase::DoRun ( )

overridevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 75 of file spectrum-interference-test.cc.

References ns3::SpectrumInterference::AddSignal(), ns3::Create(), ns3::CreateObject(), ns3::Simulator::Destroy(), m_mySpectrumModel, m_s, m_txBytes, RetrieveTestResult(), ns3::Simulator::Run(), ns3::Simulator::Schedule(), ns3::Seconds(), ns3::SpectrumInterference::SetErrorModel(), ns3::SpectrumInterference::SetNoisePowerSpectralDensity(), and ns3::SpectrumInterference::StartRx().

Here is the call graph for this function:

RetrieveTestResult()

void SpectrumInterferenceTestCase::RetrieveTestResult

(

SpectrumInterference *

si

)

Retrieve the test results.

Parameters

si	SpectrumInterference instance

Definition at line 127 of file spectrum-interference-test.cc.

References ns3::SpectrumInterference::EndRx(), m_rxCorrectKnownOutcome, and NS_TEST_ASSERT_MSG_EQ.

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_mySpectrumModel

Ptr<const SpectrumModel> SpectrumInterferenceTestCase::m_mySpectrumModel

private

Spectrum model pointer.

Definition at line 55 of file spectrum-interference-test.cc.

Referenced by DoRun().

m_rxCorrectKnownOutcome

bool SpectrumInterferenceTestCase::m_rxCorrectKnownOutcome

private

expected Rx bytes

Definition at line 54 of file spectrum-interference-test.cc.

Referenced by RetrieveTestResult().

m_s

Ptr<SpectrumValue> SpectrumInterferenceTestCase::m_s

private

Spectrum value.

Definition at line 52 of file spectrum-interference-test.cc.

Referenced by DoRun().

m_txBytes

uint32_t SpectrumInterferenceTestCase::m_txBytes

private

number of bytes to transmit

Definition at line 53 of file spectrum-interference-test.cc.

Referenced by DoRun().

---

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

• src/spectrum/test/spectrum-interference-test.cc