FTStringSet 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 initFTStringSet(self, FTStringSetSize)

Designated initializer. Initializes the amount of storage, but the FTStringSet remains empty.

Arguments

public subroutine initWithStrings(self, strings)

initializer. Initializes the amount of storage from the strings passed Usage CLASS(FTStringSet) :: FTStringSet CHARACTER(LEN=) :: strings(:) CALL FTStringSet % initWithStrings(strings)

Arguments

public subroutine AddString(self, str)

AddString adds a string to the set if it is not already present

Arguments

public function containsString(self, str)

containsString returns .TRUE. if the set contains the string, .FALSE. otherwise.

Arguments

Return Value logical

public function strings(self) result(s)

strings returns a pointer to an array of strings that are in the set. Deallocate this array when done with it.

Arguments

Return Value character(len=FTDICT_KWD_STRING_LENGTH), DIMENSION(:), POINTER

public function unionWithSet(self, set) result(newSet)

unionWithSet returns a pointer to a new set that is the union of two sets. the new set has reference count of 1. Release when done.

Arguments

Return Value type(FTStringSet), POINTER

public function intersectionWithSet(self, set) result(newSet)

intersectionWithSet returns a pointer to a new set that is the intersection of two sets. the new set has reference count of 1. Release when done.

Arguments

Return Value type(FTStringSet), POINTER

public function setFromDifference(self, set) result(newSet)

setFromDifference returns a pointer to a new set that is the difference of two sets. $$A - B = \{x: x \in A \;\rm{ and }\; x\notin B\}$$ the new set has reference count of 1. Release when done.

Arguments

Return Value type(FTStringSet), POINTER

public function isEmpty(self)

Arguments

Return Value logical

public function stringCount(self)

Arguments

Return Value integer

public subroutine printFTStringSet(self, iUnit)

Arguments

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