FTException Derived Type

public subroutine initFTObject(self)

Generic Name: init()

Arguments

public function FTObjectDescription(self)

Returns a character string of length DESCRIPTION_CHARACTER_LENGTH that represents the object. the base class implementation returns an empty string. Note that if the description is too long, the expected string will be truncated. In general, one wants to use printDescription.

Arguments

Return Value character(len=DESCRIPTION_CHARACTER_LENGTH)

private function copyFTObject(self) result(copy)

Base class implementation of the assignment function. Call this from within any subclasses copy assignment function. All FTObject's implementation does is set the reference count to one, implying no additional ownership to the caller that is creating the copy.

Arguments

Return Value class(FTObject), POINTER

public subroutine retainFTObject(self)

Retain increases the reference count by one and implies ownership to the caller. ### Usage: CALL obj\ % retain()

Arguments

public function isUnreferenced(self)

Owners of objects should call isUnreferenced after releasing a pointer object. If true, the object should be deallocated and then set to point to NULL()

Arguments

Return Value logical

public function refCount(self)

Returns the reference count for the object. Normally this is done only for debugging purposes.

Arguments

Return Value integer

public subroutine initFTException(self, severity, exceptionName, infoDictionary)

The main initializer for the class

Arguments

public subroutine initWarningException(self, msg)

A convenience initializer for a warning error that includes the key "message" in the infoDictionary. Use this initializer as an example of how to write one's own exception.

Arguments

public subroutine initFatalException(self, msg)

A convenience initializer for a fatal error that includes the key "message" in the infoDictionary.Use this initializer as an example of how to write one's own exception.

Arguments

public subroutine initAssertionFailureException(self, msg, expectedValueObject, ObservedValueObject, level)

A convenience initializer for an assertion error that includes the keys:

Arguments

public subroutine setInfoDictionary(self, dict)

Sets and retains the exception infoDictionary

Arguments

public function infoDictionary(self)

Returns the exception's infoDictionary. Does not transfer ownership/reference count is unchanged.

Arguments

Return Value class(FTDictionary), POINTER

public function exceptionName(self)

Returns the string representing the name set for the exception.

Arguments

Return Value character(len=ERROR_MSG_STRING_LENGTH)

public function severity(self)

Returns the severity level of the exception.

Arguments

Return Value integer

public subroutine printFTExceptionDescription(self, iUnit)

A basic printing of the exception and the info held in the infoDictionary.

Arguments

public function exceptionClassName(self) result(s)

Class name returns a string with the name of the type of the object

Arguments

Return Value character(len=CLASS_NAME_CHARACTER_LENGTH)