A Discrete-Event Network Simulator
API
TvHelperDistributionTestCase Class Reference

This test verifies the accuracy of the private GetRandomNumTransmitters() method in the TvSpectrumTransmitterHelper class. More...

+ Inheritance diagram for TvHelperDistributionTestCase:
+ Collaboration diagram for TvHelperDistributionTestCase:

Public Member Functions

 TvHelperDistributionTestCase (uint32_t maxNumTransmitters)
 Constructor. More...
 
 ~TvHelperDistributionTestCase () override
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor. More...
 
std::string GetName () const
 
TestCaseoperator= (const TestCase &)=delete
 

Private Member Functions

void DoRun () override
 Implementation to actually run this TestCase. More...
 

Static Private Member Functions

static std::string Name (uint32_t maxNumTransmitters)
 Build the test name. More...
 

Private Attributes

uint32_t m_maxNumTransmitters
 Maximum number of transmitters. 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 TestCase. More...
 
bool IsStatusFailure () const
 Check if any tests failed. More...
 
bool IsStatusSuccess () 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 () const
 Check if this run should assert on failure. More...
 
bool MustContinueOnFailure () 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

This test verifies the accuracy of the private GetRandomNumTransmitters() method in the TvSpectrumTransmitterHelper class.

The method generates a random number corresponding to the number of TV transmitters to create based on the given location density (low, medium, or high) and maximum possible number of TV channels. Low density will generate a transmitter for between one (a single transmitter) and one third of the number of possible channels, medium density will generate a transmitter for between one third and two thirds, and high density will generate a transmitter for between two thirds and all of the possible channels. In this test, it is verified that the lower (1) and upper (max number of possible channels input) bounds are not exceeded and that the number of transmitters to be generated does not overlap between adjacent densities. For example, given 60 possible channels, for low density between 1 and 20 transmitters can be created, for medium density between 21 and 40 transmitters can be created, and for high density between 41 and 60 transmitters can be created (all inclusive). This is tested with various cases.

Definition at line 48 of file tv-helper-distribution-test.cc.

Constructor & Destructor Documentation

◆ TvHelperDistributionTestCase()

TvHelperDistributionTestCase::TvHelperDistributionTestCase ( uint32_t  maxNumTransmitters)

Constructor.

Parameters
maxNumTransmittersmaximum number of transmitters.

Definition at line 78 of file tv-helper-distribution-test.cc.

◆ ~TvHelperDistributionTestCase()

TvHelperDistributionTestCase::~TvHelperDistributionTestCase ( )
override

Definition at line 84 of file tv-helper-distribution-test.cc.

Member Function Documentation

◆ DoRun()

void TvHelperDistributionTestCase::DoRun ( )
overrideprivatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 89 of file tv-helper-distribution-test.cc.

References ns3::TvSpectrumTransmitterHelper::GetRandomNumTransmitters(), m_maxNumTransmitters, NS_LOG_FUNCTION, NS_TEST_ASSERT_MSG_GT, and NS_TEST_ASSERT_MSG_LT.

+ Here is the call graph for this function:

◆ Name()

std::string TvHelperDistributionTestCase::Name ( uint32_t  maxNumTransmitters)
staticprivate

Build the test name.

Parameters
maxNumTransmittersmaximum number of transmitters.
Returns
The test name

Definition at line 71 of file tv-helper-distribution-test.cc.

Member Data Documentation

◆ m_maxNumTransmitters

uint32_t TvHelperDistributionTestCase::m_maxNumTransmitters
private

Maximum number of transmitters.

Definition at line 67 of file tv-helper-distribution-test.cc.

Referenced by DoRun().


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