CppUnit project page FAQ

Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 12]
oNMfcUi
oNQtUi
oNTextUi
oCAdditionalMessageAn additional Message for assertions.Provides a implicit constructor that takes a single string. This allow this class to be used as the message arguments in macros
oCAsserterA set of functions to help writing assertion macros.Here is an example of assertion, a simplified version of the actual assertion implemented in examples/cppunittest/XmlUniformiser.h:
oCassertion_traitsTraits used by CPPUNIT_ASSERT_EQUAL()
oCassertion_traits< double >Traits used by CPPUNIT_ASSERT_DOUBLES_EQUAL()
oCAutoRegisterRegistry(Implementation) Automatically adds a registry into another registry
oCAutoRegisterSuite(Implementation) Automatically register the test suite of the specified type
oCBriefTestProgressListenerTestListener that prints the name of each test before running it
oCCompilerOutputterOutputs a TestResultCollector in a compiler compatible format.Printing the test results in a compiler compatible format (assertion location has the same format as compiler error), allow you to use your IDE to jump to the assertion failure. Location format can be customized (see setLocationFormat() )
oCConcretTestFixtureFactoryConcret TestFixture factory (Implementation)
oCCppUnitTestPlugInTest plug-in interface.This class define the interface implemented by test plug-in. A pointer to that interface is returned by the function exported by the test plug-in
oCDefaultProtectorDefault protector that catch all exceptions (Implementation)
oCDynamicLibraryManagerManages dynamic libraries
oCDynamicLibraryManagerExceptionException thrown by DynamicLibraryManager when a failure occurs
oCExceptionExceptions thrown by failed assertions.Exception is an exception that serves descriptive strings through its what() method
oCExceptionTestCaseDecoratorExpected exception test case decorator
oCFunctor
oCITestRunnerDSPluginVtbl
oCMessageMessage associated to an Exception.A message is composed of two items:
oCMfcTestRunnerMFC test runner.Use this to launch the MFC TestRunner. Usually called from you CWinApp subclass:
oCOrthodox
oCOutputterAbstract outputter to print test result summary
oCPlugInManagerManges TestPlugIn
|\CPlugInInfo(INTERNAL) Information about a specific plug-in
oCPlugInParametersTest plug-ins parameters
oCProtectorProtects one or more test case run
oCProtectorChainProtector chain (Implementation). Implementation detail
|\CProtectFunctor
oCProtectorContextProtector context (Implementation). Implementation detail
oCProtectorGuardScoped protector push to TestResult
oCQtTestRunnerQT test runner.Here is an example of usage:
oCRepeatedTestDecorator that runs a test repeatedly
oCSourceLineRepresents a source line location.Used to capture the failure location in assertion
oCStringToolsTool functions to manipulate string
oCSynchronizedObjectBase class for synchronized object
|oCExclusiveZoneLocks a synchronization object in the current scope
|\CSynchronizationObjectAbstract synchronization object (mutex)
oCTestBase class for all test objects.All test objects should be a subclass of Test. Some test objects, TestCase for example, represent one individual test. Other test objects, such as TestSuite, are comprised of several tests
oCTestCallerGenerate a test case from a fixture method.A test caller provides access to a test case method on a test fixture class. Test callers are useful when you want to run an individual test or add it to a suite. Test Callers invoke only one Test (i.e. test method) on one Fixture of a TestFixture
oCTestCaseA single test object
oCTestCaseDecoratorDecorator for Test cases
oCTestCaseMethodFunctorFunctor to call test case method (Implementation)
oCTestCompositeA Composite of Tests
oCTestDecoratorDecorator for Tests
oCTestFactoryAbstract Test factory
oCTestFactoryRegistryRegistry for TestFactory.Notes that the registry DON'T assumes lifetime control for any registered tests anymore
oCTestFactoryRegistryList(INTERNAL) List of all TestFactoryRegistry
oCTestFailureRecord of a failed Test execution.A TestFailure collects a failed test together with the caught exception
oCTestFixtureWraps a test case with setUp and tearDown methods.A TestFixture is used to provide a common environment for a set of test cases
oCTestFixtureFactoryAbstract TestFixture factory (Implementation)
oCTestLeafA single test object
oCTestListenerListener for test progress and result.Implementing the Observer pattern a TestListener may be registered to a TestResult to obtain information on the testing progress. Use specialized sub classes of TestListener for text output (TextTestProgressListener). Do not use the Listener for the test result output, use a subclass of Outputter instead
oCTestNamerNames a test or a fixture suite
oCTestPathA List of Test representing a path to access a Test.The path can be converted to a string and resolved from a string with toString() and TestPath( Test *root, const std::string &pathAsString )
oCTestPlugInDefaultImplDefault implementation of test plug-in interface.Override getSuiteName() to specify the suite name. Default is "All Tests"
oCTestPlugInInterfaceAbstract TestPlugIn for DLL
oCTestResultManages TestListener.A single instance of this class is used when running the test. It is usually created by the test runner (TestRunner)
oCTestResultCollectorCollects test result.A TestResultCollector is a TestListener which collects the results of executing a test case. It is an instance of the Collecting Parameter pattern
oCTestRunnerGeneric test runner.The TestRunner assumes ownership of all added tests: you can not add test or suite that are local variable since they can't be deleted
|\CWrappingSuite(INTERNAL) Mutating test suite
oCTestSetUpDecorates a test by providing a specific setUp() and tearDown()
oCTestSuccessListenerTestListener that checks if any test case failed
oCTestSuiteA Composite of Tests.It runs a collection of test cases. Here is an example
oCTestSuiteBuilderContextType-sage context used when creating test suite in HelperMacros
oCTestSuiteBuilderContextBaseContext used when creating test suite in HelperMacros
oCTestSuiteFactoryTestFactory for TestFixture that implements a static suite() method
oCTextOutputterPrints a TestResultCollector to a text stream
oCTextTestProgressListenerTestListener that show the status of each TestCase test result
oCTextTestResultHolds printable test result (DEPRECATED).deprecated Use class TextTestProgressListener and TextOutputter instead
oCTextTestRunnerA text mode test runner.The test runner manage the life cycle of the added tests
oCXmlDocumentA XML Document
oCXmlElementA XML Element
oCXmlOutputterOutputs a TestResultCollector in XML format.Save the test result as a XML stream
\CXmlOutputterHookHook to customize Xml output

Send comments to:
CppUnit Developers