A Discrete-Event Network Simulator
API
AttributeTestCase< T > Class Template Reference

Test case template used for generic Attribute Value types – used to make sure that Attributes work as expected. More...

+ Inheritance diagram for AttributeTestCase< T >:
+ Collaboration diagram for AttributeTestCase< T >:

Public Member Functions

 AttributeTestCase (std::string description)
 Constructor. More...
 
virtual ~AttributeTestCase ()
 
- 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 CheckGetCodePaths (Ptr< Object > p, std::string attributeName, std::string expectedString, T expectedValue)
 Check the attribute path and value. More...
 
virtual void DoRun (void)
 Implementation to actually run this TestCase. More...
 
void DoRun (void)
 Implementation to actually run this TestCase. More...
 
void DoRun (void)
 Implementation to actually run this TestCase. More...
 
void DoRun (void)
 Implementation to actually run this TestCase. More...
 
void DoRun (void)
 Implementation to actually run this TestCase. More...
 
void DoRun (void)
 Implementation to actually run this TestCase. More...
 
void DoRun (void)
 Implementation to actually run this TestCase. 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

template<typename T>
class AttributeTestCase< T >

Test case template used for generic Attribute Value types – used to make sure that Attributes work as expected.

Definition at line 471 of file attribute-test-suite.cc.

Constructor & Destructor Documentation

◆ AttributeTestCase()

template<typename T >
AttributeTestCase< T >::AttributeTestCase ( std::string  description)

Constructor.

Parameters
descriptionThe TestCase description.

Definition at line 495 of file attribute-test-suite.cc.

◆ ~AttributeTestCase()

template<typename T >
AttributeTestCase< T >::~AttributeTestCase
virtual

Definition at line 500 of file attribute-test-suite.cc.

Member Function Documentation

◆ CheckGetCodePaths()

template<typename T >
bool AttributeTestCase< T >::CheckGetCodePaths ( Ptr< Object p,
std::string  attributeName,
std::string  expectedString,
expectedValue 
)
private

Check the attribute path and value.

Parameters
pThe object to test.
attributeNameThe attribute name.
expectedStringThe expected attribute name.
expectedValueThe expected attribute value.
Returns
true if everything is as expected.

Definition at line 504 of file attribute-test-suite.cc.

References ns3::StringValue::Get(), and ns3::ObjectBase::GetAttributeFailSafe().

+ Here is the call graph for this function:

◆ DoRun() [1/7]

template<typename T >
virtual void AttributeTestCase< T >::DoRun ( void  )
privatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

◆ DoRun() [2/7]

void AttributeTestCase< BooleanValue >::DoRun ( void  )
privatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 532 of file attribute-test-suite.cc.

References NS_TEST_ASSERT_MSG_EQ, NS_TEST_ASSERT_MSG_NE, ns3::Config::SetDefault(), and ns3::Config::SetDefaultFailSafe().

+ Here is the call graph for this function:

◆ DoRun() [3/7]

void AttributeTestCase< IntegerValue >::DoRun ( void  )
privatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 624 of file attribute-test-suite.cc.

References NS_TEST_ASSERT_MSG_EQ, and NS_TEST_ASSERT_MSG_NE.

◆ DoRun() [4/7]

void AttributeTestCase< UintegerValue >::DoRun ( void  )
privatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 734 of file attribute-test-suite.cc.

References NS_TEST_ASSERT_MSG_EQ, and NS_TEST_ASSERT_MSG_NE.

◆ DoRun() [5/7]

void AttributeTestCase< DoubleValue >::DoRun ( void  )
privatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 805 of file attribute-test-suite.cc.

References NS_TEST_ASSERT_MSG_EQ, and NS_TEST_ASSERT_MSG_NE.

◆ DoRun() [6/7]

void AttributeTestCase< EnumValue >::DoRun ( void  )
privatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 831 of file attribute-test-suite.cc.

References NS_TEST_ASSERT_MSG_EQ, NS_TEST_ASSERT_MSG_NE, AttributeObjectTest::TEST_A, AttributeObjectTest::TEST_B, and AttributeObjectTest::TEST_C.

◆ DoRun() [7/7]

void AttributeTestCase< TimeValue >::DoRun ( void  )
privatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 902 of file attribute-test-suite.cc.

References NS_TEST_ASSERT_MSG_EQ, NS_TEST_ASSERT_MSG_NE, and ns3::Seconds().

+ Here is the call graph for this function:

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