Class: TFlattenResurrectTestOf

Declaration: FlattenResurrectTest.h

Taxonomy Categories:

Member Functions:

Interface Category:

Developer Tool Programmer Interface.

Inherits From:

TBaseFlattenResurrectTest

Inherited By:

testClass

Purpose:

A template class derived from TBaseFlattenResurrectTest. It tests the flattening and resurrecting of the target using the global Flatten and Resurrect functions.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TFlattenResurrectTestOf can be used directly only if the target and comparator are set outside the test before running the test. Otherwise, clients should create a derived class of TFlattenResurrectTestOf and overload the SetupComparator function to specify which comparator to use for the test and the CreateNewTarget function to create the target. The TFlattenResurrectTestOf macros can be used to create your derived class and define all the functions you need to override.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TFlattenResurrectTestOf::~TFlattenResurrectTestOf

virtual ~ TFlattenResurrectTestOf ()

Interface Category:

Developer Tool Programmer Interfacer

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: TFlattenResurrectTestOf::TFlattenResurrectTestOf

TFlattenResurrectTestOf ()
TFlattenResurrectTestOf (const TFlattenResurrectTestOf < AType > & that)

Interface Category:

Developer Tool Programmer Interfacer

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TFlattenResurrectTestOf < AType > & that -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFlattenResurrectTestOf::operator=

TFlattenResurrectTestOf < AType > & operator =(const TFlattenResurrectTestOf < AType > & that)

Interface Category:

Developer Tool Programmer Interfacer

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TFlattenResurrectTestOf < AType > & that -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: TFlattenResurrectTestOf::GetTargetClassNameAsString

virtual const char * GetTargetClassNameAsString () const

Interface Category:

Developer Tool Programmer Interfacer

Purpose:

Returns the name of the target class.

Calling Context:

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

Parameters:

Takes no parameters.

Return Value:

Returns the name of the target class.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFlattenResurrectTestOf::CreateNewTarget

virtual void * CreateNewTarget () const

Interface Category:

Developer Tool Programmer Interfacer

Purpose:

Returns a NIL pointer. Derived classes must overload CreateNewTarget to create the target object.

Calling Context:

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

Parameters:

Takes no parameters.

Return Value:

Returns a NIL pointer.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFlattenResurrectTestOf::DeleteTarget

virtual void DeleteTarget (void * ) const

Interface Category:

Developer Tool Programmer Interfacer

Purpose:

Deletes the given target object after casting it to the target class to invoke the correct destructor.

Calling Context:

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

Parameters:

void * target -The target object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFlattenResurrectTestOf::FlattenTarget

virtual void FlattenTarget ()

Interface Category:

Developer Tool Programmer Interfacer

Purpose:

Casts the target to the target class and flattens it to the test stream.

Calling Context:

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

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFlattenResurrectTestOf::ResurrectTarget

virtual void * ResurrectTarget ()

Interface Category:

Developer Tool Programmer Interfacer

Purpose:

Resurrects the target from the test stream and returns the result.

Calling Context:

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

Parameters:

Takes no parameters.

Return Value:

Returns the resurrected target object.

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.