FTMultiIndexTable 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)

public function className(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)

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 initMultiIndexTableWithSize(self, N)

Arguments

public function MultiIndexTableContainsKeys(self, keys) result(r)

Arguments

Return Value logical

public subroutine addObjectToMultiIndexTableForKeys(self, obj, keys)

Arguments

public function objectInMultiIndexTableForKeys(self, keys) result(r)

Arguments

Return Value class(FTObject), POINTER

public subroutine printMultiIndexTableDescription(self, iUnit)

Arguments

public function MultiIndexTableSize(self)

Arguments

Return Value integer