Testable Class Reference

A common testing interface for all plug-ins. More...

#include <Testable.h>

Inheritance diagram for Testable:

List of all members.

Public Member Functions
virtual bool	runOperationalTests (Progress *pProgress, std::ostream &failure)=0
virtual bool	runAllTests (Progress *pProgress, std::ostream &failure)=0
Protected Member Functions
virtual	~Testable ()

---

Detailed Description

A common testing interface for all plug-ins.

This class defines the generic testing interface to all plug-ins. This interface is used to verify plug-ins in an operational environment as well as to run a full suite of automated tests.

Definition at line 24 of file Testable.h.

---

Constructor & Destructor Documentation

virtual Testable::~Testable

(

)

[protected, virtual]

This should be destroyed by calling PlugInManagerServices::destroyPlugIn.

Definition at line 84 of file Testable.h.

---

Member Function Documentation

virtual bool Testable::runOperationalTests	(	Progress *	pProgress,
		std::ostream &	failure
	)			[pure virtual]

Executes operational tests generically.

This method is used to run basic tests and to make sure the plug-in is operating properly. Running this method on all plug-ins can be used to relatively quickly determine if the application has been installed properly and all plug-ins are operational.

Parameters:

	pProgress	On input, pProgress provides an object for the plug-in to update the progress of the testing. This allows the application to update the user with a progress dialog and to show current status.
	failure	On output, failure is an output stream in which the plug-in can record detailed formatted text about what went wrong in with the test. This parameter should not be used to record general status information. Nothing should be logged to this stream unless the tests failed and false is returned from the method.

Returns:

Returns true if the operational tests executed successfully; otherwise returns false.

Implemented in Nitf::TreParserShell.

virtual bool Testable::runAllTests	(	Progress *	pProgress,
		std::ostream &	failure
	)			[pure virtual]

Executes the full suite of tests.

This method is used to run a full set of tests and to make sure the plug-in is operating properly. This method can be called on all plug-ins to run a full set of tests and to determine if the current build works completely. This method is used more for automated testing during the development and formal testing process.

Parameters:

	pProgress	On input, pProgress provides an object for the plug-in to update the progress of the testing. This allows the application to update the user with a progress dialog and to show current status.
	failure	On output, failure is an output stream in which the plug-in can record detailed formatted text about what went wrong in with the test. This parameter should not be used to record general status information. Nothing should be logged to this stream unless the tests failed and false is returned from the method.

Returns:

Returns true if the all tests executed successfully; otherwise returns false.