A Discrete-Event Network Simulator
API
BasicCallbackTestCase Class Reference

Test the basic Callback mechanism. More...

+ Inheritance diagram for BasicCallbackTestCase:
+ Collaboration diagram for BasicCallbackTestCase:

Public Member Functions

 BasicCallbackTestCase ()
 
virtual ~BasicCallbackTestCase ()
 
void Target1 (void)
 Callback 1 target function. More...
 
int Target2 (void)
 Callback 2 target function. More...
 
void Target3 ([[maybe_unused]] double a)
 Callback 3 target function. More...
 
int Target4 ([[maybe_unused]] double a, [[maybe_unused]] int b)
 Callback 4 target function. 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

virtual void DoRun (void)
 Implementation to actually run this TestCase. More...
 
virtual void DoSetup (void)
 Implementation to do any local setup required for this TestCase. More...
 

Private Attributes

bool m_test1
 true if Target1 has been called, false otherwise. More...
 
bool m_test2
 true if Target2 has been called, false otherwise. More...
 
bool m_test3
 true if Target3 has been called, false otherwise. More...
 
bool m_test4
 true if Target4 has been called, false otherwise. 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

Test the basic Callback mechanism.

Definition at line 41 of file callback-test-suite.cc.

Constructor & Destructor Documentation

◆ BasicCallbackTestCase()

BasicCallbackTestCase::BasicCallbackTestCase ( )

Definition at line 133 of file callback-test-suite.cc.

◆ ~BasicCallbackTestCase()

virtual BasicCallbackTestCase::~BasicCallbackTestCase ( )
inlinevirtual

Definition at line 45 of file callback-test-suite.cc.

Member Function Documentation

◆ DoRun()

void BasicCallbackTestCase::DoRun ( void  )
privatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 150 of file callback-test-suite.cc.

References BasicCallbackTarget5(), BasicCallbackTarget6(), BasicCallbackTarget7(), gBasicCallbackTest5, gBasicCallbackTest6, gBasicCallbackTest7, m_test1, m_test2, m_test3, m_test4, NS_TEST_ASSERT_MSG_EQ, Target1(), Target2(), Target3(), and Target4().

+ Here is the call graph for this function:

◆ DoSetup()

void BasicCallbackTestCase::DoSetup ( void  )
privatevirtual

Implementation to do any local setup required for this TestCase.

Subclasses should override this method to perform any costly per-test setup before DoRun is invoked.

Reimplemented from ns3::TestCase.

Definition at line 138 of file callback-test-suite.cc.

References gBasicCallbackTest5, gBasicCallbackTest6, gBasicCallbackTest7, m_test1, m_test2, m_test3, and m_test4.

◆ Target1()

void BasicCallbackTestCase::Target1 ( void  )
inline

Callback 1 target function.

Definition at line 51 of file callback-test-suite.cc.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ Target2()

int BasicCallbackTestCase::Target2 ( void  )
inline

Callback 2 target function.

Returns
two.

Definition at line 59 of file callback-test-suite.cc.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ Target3()

void BasicCallbackTestCase::Target3 ( [[maybe_unused] ] double  a)
inline

Callback 3 target function.

Parameters
aA parameter (unused).

Definition at line 68 of file callback-test-suite.cc.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ Target4()

int BasicCallbackTestCase::Target4 ( [[maybe_unused] ] double  a,
[[maybe_unused] ] int  b 
)
inline

Callback 4 target function.

Parameters
aA parameter (unused).
bAnother parameter (unused).
Returns
four.

Definition at line 78 of file callback-test-suite.cc.

Referenced by DoRun().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_test1

bool BasicCallbackTestCase::m_test1
private

true if Target1 has been called, false otherwise.

Definition at line 88 of file callback-test-suite.cc.

Referenced by DoRun(), and DoSetup().

◆ m_test2

bool BasicCallbackTestCase::m_test2
private

true if Target2 has been called, false otherwise.

Definition at line 89 of file callback-test-suite.cc.

Referenced by DoRun(), and DoSetup().

◆ m_test3

bool BasicCallbackTestCase::m_test3
private

true if Target3 has been called, false otherwise.

Definition at line 90 of file callback-test-suite.cc.

Referenced by DoRun(), and DoSetup().

◆ m_test4

bool BasicCallbackTestCase::m_test4
private

true if Target4 has been called, false otherwise.

Definition at line 91 of file callback-test-suite.cc.

Referenced by DoRun(), and DoSetup().


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