Class: TTestSequence

Declaration: TestCollection.h

Taxonomy Categories:

Member Functions:

Interface Category:

Developer Tool Programmer Interface.

Inherits From:

TTestCollection

Inherited By:

None.

Purpose:

A derived class of TTestCollection that implements a test that contains a sequence of subtests. These subtests are always executed in a fixed order (first to last). Derive TTestSequence if you have a group of related tests that must be executed in a fixed order. The default behavior is to halt on a subtest failure.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is a framework class. To use it, derive it and override the SetupSubtests function to instantiate each of your subtests and add them to the sequence in the correct order using the AdoptFirstTest and AdoptLastTest functions.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTestSequence::TTestSequence

TTestSequence ()
TTestSequence (const TTestSequence &)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and Runtest.
Called to copy an object.

Parameters:

Takes no parameters.
const TTestSequence & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTestSequence::operator=

TTestSequence & operator =(const TTestSequence &)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TTestSequence & -A const reference to the right-hand side object.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTestSequence::~TTestSequence

virtual ~ TTestSequence ()

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTestSequence::operator<<=

virtual TStream & operator <<= (TStream & source)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & source -The stream the object is streamed in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTestSequence::operator>>=

virtual TStream & operator >>=(TStream & destination) const

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & destination -The stream the object is streamed out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTestSequence::AdoptFirstTest

virtual void AdoptFirstTest (TTest * subTest)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Adds a subtest to the start of the TTestSequence's collection of subtests so that the subtest is executed first.

Calling Context:

Call this function directly.

Parameters:

TTest * subTest -The subtest to be added.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

The caller must not delete the subtest after calling AdoptFirstTest.

Member Function: TTestSequence::AdoptLastTest

virtual void AdoptLastTest (TTest * subTest)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Adds a subtest to the end of the TTestSequence's collection of subtests so that the subtest is executed last.

Calling Context:

Call this function directly.

Parameters:

TTest * subTest -The subtest to be added.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

The caller must not delete the subtest after calling AdoptFirstTest.

Member Function: TTestSequence::GetNewSubtests

virtual TCollectionOf < TTest > & GetNewSubtests () const

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Returns the collection of subtests. Clients and derived classes should not call or override this function.

Calling Context:

Called by Test framework. Do not call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a collection of subtests.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.