SpectrumValueTestCase Class Reference

Spectrum Value Test. More...

Inheritance diagram for SpectrumValueTestCase:

Collaboration diagram for SpectrumValueTestCase:

Public Member Functions
	SpectrumValueTestCase (SpectrumValue a, SpectrumValue b, std::string name)
	Constructor.
	~SpectrumValueTestCase () override
void	DoRun () override
	Implementation to actually run this TestCase.
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
bool	MoreOrLessEqual (SpectrumValue x, SpectrumValue y)
	Check that two SpectrumValue are equal within a tolerance.

Private Attributes
SpectrumValue	m_a
	first SpectrumValue
SpectrumValue	m_b
	second SpectrumValue

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...
using	instead = Duration
Static Public Attributes inherited from ns3::TestCase
static constexpr auto	EXTENSIVE = Duration::EXTENSIVE
static constexpr auto	QUICK = Duration::QUICK
static constexpr auto	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 Value Test.

Definition at line 42 of file spectrum-value-test.cc.

Constructor & Destructor Documentation

SpectrumValueTestCase()

SpectrumValueTestCase::SpectrumValueTestCase	(	SpectrumValue	a,
		SpectrumValue	b,
		std::string	name
	)

Constructor.

Parameters

a	first SpectrumValue
b	second SpectrumValue
name	test name

Definition at line 68 of file spectrum-value-test.cc.

~SpectrumValueTestCase()

SpectrumValueTestCase::~SpectrumValueTestCase ( )

override

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

Member Function Documentation

DoRun()

void SpectrumValueTestCase::DoRun ( )

overridevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 87 of file spectrum-value-test.cc.

References ns3::SpectrumValue::GetSpectrumModel(), m_a, m_b, NS_TEST_ASSERT_MSG_SPECTRUM_MODEL_EQ_TOL, NS_TEST_ASSERT_MSG_SPECTRUM_VALUE_EQ_TOL, and TOLERANCE.

Here is the call graph for this function:

MoreOrLessEqual()

bool SpectrumValueTestCase::MoreOrLessEqual ( SpectrumValue  x, SpectrumValue  y  )

private

Check that two SpectrumValue are equal within a tolerance.

Parameters

x	first SpectrumValue
y	second SpectrumValue

Returns

true if the two values are within the tolerance

Definition at line 80 of file spectrum-value-test.cc.

References ns3::Norm(), and TOLERANCE.

Here is the call graph for this function:

Member Data Documentation

m_a

SpectrumValue SpectrumValueTestCase::m_a

private

first SpectrumValue

Definition at line 64 of file spectrum-value-test.cc.

Referenced by DoRun().

m_b

SpectrumValue SpectrumValueTestCase::m_b

private

second SpectrumValue

Definition at line 65 of file spectrum-value-test.cc.

Referenced by DoRun().

---

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

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