A Discrete-Event Network Simulator
API

MPI specialization of ns3::ExampleTestSuite. More...

+ Inheritance diagram for MpiTestSuite:
+ Collaboration diagram for MpiTestSuite:

Public Member Functions

 MpiTestSuite (const std::string name, const std::string program, const std::string dataDir, const int ranks, const std::string args="", const TestDuration duration=QUICK)
 Constructor. More...
 
- Public Member Functions inherited from ns3::TestSuite
 TestSuite (std::string name, Type type=UNIT)
 Construct a new test suite. More...
 
TestSuite::Type GetTestType (void)
 get the kind of test this test suite implements 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
 

Additional Inherited Members

- Public Types inherited from ns3::TestSuite
enum  Type {
  ALL = 0 , UNIT , SYSTEM , EXAMPLE ,
  PERFORMANCE
}
 Type of test. More...
 
- 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

MPI specialization of ns3::ExampleTestSuite.

Definition at line 103 of file mpi-test-suite.cc.

Constructor & Destructor Documentation

◆ MpiTestSuite()

MpiTestSuite::MpiTestSuite ( const std::string  name,
const std::string  program,
const std::string  dataDir,
const int  ranks,
const std::string  args = "",
const TestDuration  duration = QUICK 
)
inline

Constructor.

Parameters
[in]nameThe test case name, typically the program name and summary of the arguments, such as my-example-foo
[in]programThe actual example program names, such as my-example
[in]dataDirThe location of the reference file. This is normally provided by the symbol NS_TEST_SOURCEDIR in the module-examples-test-suite.cc file. The reference file should be named after the test case name, for example my-example-foo.log. If you use the --update argument to test.py or test-runner the reference file will be created with the correct name.
[in]argsAny additional arguments to the program.
[in]ranksThe number of ranks to use
[in]durationAmount of time this test takes to execute (defaults to QUICK).

Definition at line 112 of file mpi-test-suite.cc.

References ns3::TestCase::AddTestCase().

+ Here is the call graph for this function:

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