---

wxTestSuite Class Reference

An implementation of the wxITest interface that aggregates multiple sub-tests. More...

#include <TestSuite.h>

Inheritance diagram for wxTestSuite::

List of all members.

Public Methods
	wxTestSuite (const char *pszDescription)
virtual void	Delete ()
	Destroys and deallocates the test. More...
virtual	~wxTestSuite ()
virtual const char *	GetDescription ()
	Retreive a human readable description of this test. More...
virtual TestState	GetState ()
	Retreive the current TestState of this test. More...
virtual void	SetState (TestState newState)
	Assign a new state to this test. More...
virtual void	Run (wxITestRunner *pResult)
	Begin executing this test. More...
virtual void	Run (wxITestRunner *pResult, long unsigned nThreadId)
	Begin executing this test in a multi-threaded enviroment. More...
virtual bool	IsThreadSafe ()
	Determine if this test is intended to be thread-safe. More...
virtual int	GetNumSubTests ()
	Retreive the number of sub-tests for this test. More...
virtual void	GetSubTests (wxITest **pOutTests)
	Retreive the child-tests of this test. More...
virtual const wxITest *	GetParent () const
	Retreive the parent of this test. More...
virtual wxITest *	GetParent ()
	Retreive the parent of this test. More...
virtual void	SetParent (wxITest *pParent)
	Assign a new parent to this test. More...
virtual void	AddTest (wxITest *pTest)
	Adds a test to this wxTestSuite. More...

---

Detailed Description

An implementation of the wxITest interface that aggregates multiple sub-tests.

Definition at line 21 of file TestSuite.h.

---

Constructor & Destructor Documentation

wxTestSuite::wxTestSuite (  const char *    pszDescription )

virtual wxTestSuite::~wxTestSuite (    )  [virtual]

---

Member Function Documentation

virtual void wxTestSuite::Delete (    )  [virtual]

Destroys and deallocates the test. Reimplemented from wxITest.

virtual const char* wxTestSuite::GetDescription (    )  [virtual]

Retreive a human readable description of this test. Returns: A null terminated string that is the description of this test. Reimplemented from wxITest.

virtual TestState wxTestSuite::GetState (    )  [virtual]

Retreive the current TestState of this test. Returns: The current TestState of this test. Reimplemented from wxITest.

virtual void wxTestSuite::SetState (  TestState    newState )  [virtual]

Assign a new state to this test. This method is usually called by the test-runner after the test has completed. Returns: The current TestState of this test. Reimplemented from wxITest.

virtual void wxTestSuite::Run (  wxITestRunner *    pResult )  [virtual]

Begin executing this test. Parameters: pResult  The result object that will recieve the results of this test. Reimplemented from wxITest.

virtual void wxTestSuite::Run (  wxITestRunner *    pResult, long unsigned    nThreadId )  [virtual]

Begin executing this test in a multi-threaded enviroment. Parameters: pResult  The result object that will recieve the results of this test. nThreadId  The thread identifer of the thread in which this test is running. Reimplemented from wxITest.

virtual bool wxTestSuite::IsThreadSafe (    )  [virtual]

Determine if this test is intended to be thread-safe. This useful for test runners that may want to run the test in multiple threads simultaneously to test for resource conflicts and deadlocks. Reimplemented from wxITest.

virtual int wxTestSuite::GetNumSubTests (    )  [virtual]

Retreive the number of sub-tests for this test. Reimplemented from wxITest.

virtual void wxTestSuite::GetSubTests (  wxITest **    pOutTests )  [virtual]

Retreive the child-tests of this test. Parameters: pOutTests  A pointer to a buffer that will recieve pointers to the sub-tests. Reimplemented from wxITest.

virtual const wxITest* wxTestSuite::GetParent (    )  const [virtual]

Retreive the parent of this test. Returns: A pointer to the parent test of this test, or NULL if this test has no parent. Reimplemented from wxITest.

virtual wxITest* wxTestSuite::GetParent (    )  [virtual]

Retreive the parent of this test. Returns: A pointer to the parent test of this test, or NULL if this test has no parent. Reimplemented from wxITest.

virtual void wxTestSuite::SetParent (  wxITest *    pParent )  [virtual]

Assign a new parent to this test. Parameters: pParent  The test that is to be the parent of this test. Reimplemented from wxITest.

virtual void wxTestSuite::AddTest (  wxITest *    pTest )  [virtual]

Adds a test to this wxTestSuite. Parameters: pTest  The test to be added to this wxTestSuite.

---

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

• C:/marty/b3/wxTest/include/wxTest/TestSuite.h

---