Blame include/cppunit/TestSuite.h

Packit Service e31359
#ifndef CPPUNIT_TESTSUITE_H    // -*- C++ -*-
Packit Service e31359
#define CPPUNIT_TESTSUITE_H
Packit Service e31359
Packit Service e31359
#include <cppunit/Portability.h>
Packit Service e31359
Packit Service e31359
#if CPPUNIT_NEED_DLL_DECL
Packit Service e31359
#pragma warning( push )
Packit Service e31359
#pragma warning( disable: 4251 )  // X needs to have dll-interface to be used by clients of class Z
Packit Service e31359
#endif
Packit Service e31359
Packit Service e31359
#include <cppunit/TestComposite.h>
Packit Service e31359
#include <vector>
Packit Service e31359
Packit Service e31359
CPPUNIT_NS_BEGIN
Packit Service e31359
Packit Service e31359
Packit Service e31359
#if CPPUNIT_NEED_DLL_DECL
Packit Service e31359
//  template class CPPUNIT_API std::vector<Test *>;
Packit Service e31359
#endif
Packit Service e31359
Packit Service e31359
Packit Service e31359
/*! \brief A Composite of Tests.
Packit Service e31359
 * \ingroup CreatingTestSuite
Packit Service e31359
 *
Packit Service e31359
 * It runs a collection of test cases. Here is an example.
Packit Service e31359
 * \code
Packit Service e31359
 * CppUnit::TestSuite *suite= new CppUnit::TestSuite();
Packit Service e31359
 * suite->addTest(new CppUnit::TestCaller<MathTest> (
Packit Service e31359
 *                  "testAdd", testAdd));
Packit Service e31359
 * suite->addTest(new CppUnit::TestCaller<MathTest> (
Packit Service e31359
 *                  "testDivideByZero", testDivideByZero));
Packit Service e31359
 * \endcode
Packit Service e31359
 * Note that \link TestSuite TestSuites \endlink assume lifetime
Packit Service e31359
 * control for any tests added to them.
Packit Service e31359
 *
Packit Service e31359
 * TestSuites do not register themselves in the TestRegistry.
Packit Service e31359
 * \see Test 
Packit Service e31359
 * \see TestCaller
Packit Service e31359
 */
Packit Service e31359
class CPPUNIT_API TestSuite : public TestComposite
Packit Service e31359
{
Packit Service e31359
public:
Packit Service e31359
  /*! Constructs a test suite with the specified name.
Packit Service e31359
   */
Packit Service e31359
  TestSuite( std::string name = "" );
Packit Service e31359
Packit Service e31359
  ~TestSuite();
Packit Service e31359
Packit Service e31359
  /*! Adds the specified test to the suite.
Packit Service e31359
   * \param test Test to add. Must not be \c NULL.
Packit Service e31359
    */
Packit Service e31359
  void addTest( Test *test );
Packit Service e31359
Packit Service e31359
  /*! Returns the list of the tests (DEPRECATED).
Packit Service e31359
   * \deprecated Use getChildTestCount() & getChildTestAt() of the 
Packit Service e31359
   *             TestComposite interface instead.
Packit Service e31359
   * \return Reference on a vector that contains the tests of the suite.
Packit Service e31359
   */
Packit Service e31359
  const std::vector<Test *> &getTests() const;
Packit Service e31359
Packit Service e31359
  /*! Destroys all the tests of the suite.
Packit Service e31359
   */
Packit Service e31359
  virtual void deleteContents();
Packit Service e31359
Packit Service e31359
  int getChildTestCount() const;
Packit Service e31359
Packit Service e31359
  Test *doGetChildTestAt( int index ) const;
Packit Service e31359
Packit Service e31359
private:
Packit Service e31359
  std::vector<Test *> m_tests;
Packit Service e31359
};
Packit Service e31359
Packit Service e31359
Packit Service e31359
CPPUNIT_NS_END
Packit Service e31359
Packit Service e31359
#if CPPUNIT_NEED_DLL_DECL
Packit Service e31359
#pragma warning( pop )
Packit Service e31359
#endif
Packit Service e31359
Packit Service e31359
#endif // CPPUNIT_TESTSUITE_H