A Discrete-Event Network Simulator
API
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. More...
 
virtual ~SpectrumValueTestCase ()
 
virtual void DoRun (void)
 Implementation to actually run this TestCase. More...
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor. More...
 
std::string GetName (void) const
 
TestCaseoperator= (const TestCase &)=delete
 

Private Member Functions

bool MoreOrLessEqual (SpectrumValue x, SpectrumValue y)
 Check that two SpectrumValue are equal withing a tolerance. More...
 

Private Attributes

SpectrumValue m_a
 first SpectrumValue More...
 
SpectrumValue m_b
 second SpectrumValue More...
 

Additional Inherited Members

- Public Types inherited from ns3::TestCase
enum  TestDuration { QUICK = 1 , EXTENSIVE = 2 , TAKES_FOREVER = 3 }
 How long the test takes to execute. More...
 
- Protected Member Functions inherited from ns3::TestCase
 TestCase (std::string name)
 Constructor. More...
 
void AddTestCase (TestCase *testCase, TestDuration duration=QUICK)
 Add an individual child TestCase to this test suite. More...
 
TestCaseGetParent () const
 Get the parent of this TestCsse. More...
 
bool IsStatusFailure (void) const
 Check if any tests failed. More...
 
bool IsStatusSuccess (void) const
 Check if all tests passed. More...
 
void SetDataDir (std::string directory)
 Set the data directory where reference trace files can be found. More...
 
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. More...
 
bool MustAssertOnFailure (void) const
 Check if this run should assert on failure. More...
 
bool MustContinueOnFailure (void) const
 Check if this run should continue on failure. More...
 
std::string CreateDataDirFilename (std::string filename)
 Construct the full path to a file in the data directory. More...
 
std::string CreateTempDirFilename (std::string filename)
 Construct the full path to a file in a temporary directory. More...
 

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
afirst SpectrumValue
bsecond SpectrumValue
nametest name

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

◆ ~SpectrumValueTestCase()

SpectrumValueTestCase::~SpectrumValueTestCase ( )
virtual

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

Member Function Documentation

◆ DoRun()

void SpectrumValueTestCase::DoRun ( void  )
virtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 90 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 withing a tolerance.

Parameters
xfirst SpectrumValue
ysecond SpectrumValue
Returns
true if the two values are withing the tolerance

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

References ns3::Norm(), TOLERANCE, and sample-rng-plot::x.

+ 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: