Description

Base class for self tests.

Each test has a name and a functor that takes no arguments.

See also, selfTests, runSelfTestsAndExit.

Definition at line 19 of file SelfTest.h.

#include <Rose/CommandLine/SelfTest.h>

Inheritance diagram for Rose::CommandLine::SelfTest:

[legend]

Collaboration diagram for Rose::CommandLine::SelfTest:

[legend]

Public Types
typedef Sawyer::SharedPointer< SelfTest >	Ptr

Public Member Functions
virtual std::string	name () const =0
	Short name for test.

virtual bool	operator() ()=0
	The actual test.

Public Member Functions inherited from Sawyer::SharedObject
	SharedObject ()
	Default constructor.

	SharedObject (const SharedObject &)
	Copy constructor.

virtual	~SharedObject ()
	Virtual destructor.

SharedObject &	operator= (const SharedObject &)
	Assignment.

Member Typedef Documentation

◆ Ptr

typedef Sawyer::SharedPointer<SelfTest> Rose::CommandLine::SelfTest::Ptr

Definition at line 21 of file SelfTest.h.

Member Function Documentation

◆ name()

virtual std::string Rose::CommandLine::SelfTest::name ( ) const

pure virtual

Short name for test.

This can be a single word or multiple words, but short enough to easily fit on a single line of output. It should not be capitalized or punctuated since the returned string will be used in a larger diagnostic message.

◆ operator()()

virtual bool Rose::CommandLine::SelfTest::operator() ( )

pure virtual

The actual test.

This is the actual test to run. It should return true if successful, false if not successful.

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

SelfTest.h