Class: TCopyTestOf

Declaration: CopyTest.h

Taxonomy Categories:

Member Functions:

Interface Category:

Developer Tool Programmer Interface.

Inherits From:

TBaseCopyTest

Inherited By:

testClass

Purpose:

A template class derived from TBaseCopyTest. It tests the copying of the target using the global Copy function.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TCopyTestOf 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 TCopyTestOf and overload the SetupComparator function to specify which comparator to use for the test and the CreateNewTarget function to create the target. The TCopyTestOf 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: TCopyTestOf::~TCopyTestOf

virtual ~ TCopyTestOf ()

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

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

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TCopyTestOf < 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: TCopyTestOf::operator=

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

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TCopyTestOf < 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: TCopyTestOf::GetTargetClassNameAsString

virtual const char * GetTargetClassNameAsString () const

Interface Category:

Developer Tool Programmer Interface.

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: TCopyTestOf::CreateNewTarget

virtual void * CreateNewTarget () const

Interface Category:

Developer Tool Programmer Interface.

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: TCopyTestOf::DeleteTarget

virtual void DeleteTarget (void *) const

Interface Category:

Developer Tool Programmer Interface.

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 * -The target object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCopyTestOf::CopyTarget

virtual void * CopyTarget ()

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Casts the target to the target class and calls the global Copy function with the target.

Calling Context:

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

Parameters:

Takes no parameters.

Return Value:

Returns the copy of the target.

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.