Class: TAssertionFailureException

Declaration: Assertions.h

Taxonomy Categories:

Member Functions:

TAssertionFailureException
~TAssertionFailureException
operator=
GetAssertionMessage
operator<<=
operator>>=
operator==
Throw

Interface Category:

API.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

Exception thrown by TExceptionAssertionHandler. It stores a copy of the message passed to the Assertion function.

Instantiation:

Always allocate on the stack.

Deriving Classes:

Clients should use this class directly.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TAssertionFailureException::TAssertionFailureException

TAssertionFailureException ()
TAssertionFailureException (const char * message)
TAssertionFailureException (const TAssertionFailureException & other)

Interface Category:

API.

Purpose:

Default constructor.
Constructor which takes assertion message.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const char * message -The message passed to Assertion.
const TAssertionFailureException & other -The exception to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAssertionFailureException::~TAssertionFailureException

virtual ~ TAssertionFailureException ()

Interface Category:

API.

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: TAssertionFailureException::operator=

TAssertionFailureException & operator =(const TAssertionFailureException & other)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TAssertionFailureException & other -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: TAssertionFailureException::GetAssertionMessage

void GetAssertionMessage (char message []) const

Interface Category:

API.

Purpose:

Copies the message that was passed to the Assertion function to the given string.

Calling Context:

Called by clients.

Parameters:

char message [] -The string where the message will be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAssertionFailureException::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -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: TAssertionFailureException::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -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: TAssertionFailureException::operator==

virtual bool operator ==(const TStandardException & other) const

Interface Category:

API.

Purpose:

Compares the given exception with this exception.

Calling Context:

Call this function directly.

Parameters:

const TStandardException & other -The exception object to use in comparison.

Return Value:

Returns true if the given exception object is the same as this exception.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAssertionFailureException::Throw

virtual void Throw () const

Interface Category:

API.

Purpose:

Throws this exception object.

Calling Context:

Called when this exception is to be thrown.

Parameters:

Takes no parameters.

Return Value:

None.

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.