FTObject Derived Type

type, public :: FTObject


Inherited by

type~~ftobject~~InheritedByGraph type~ftobject FTObject type~ftdata FTData type~ftdata->type~ftobject type~ftdictionary FTDictionary type~ftdictionary->type~ftobject type~ftlinkedlist FTLinkedList type~ftdictionary->type~ftlinkedlist entries type~ftexception FTException type~ftexception->type~ftobject type~ftexception->type~ftdictionary infoDictionary_ type~ftkeyobjectpair FTKeyObjectPair type~ftkeyobjectpair->type~ftobject valueObject type~ftkeyobjectpair->type~ftobject type~ftlinkedlist->type~ftobject type~ftlinkedlistrecord FTLinkedListRecord type~ftlinkedlist->type~ftlinkedlistrecord head, tail type~ftlinkedlistiterator FTLinkedListIterator type~ftlinkedlistiterator->type~ftobject type~ftlinkedlistiterator->type~ftlinkedlist list type~ftlinkedlistiterator->type~ftlinkedlistrecord current type~ftlinkedlistrecord->type~ftobject recordObject type~ftlinkedlistrecord->type~ftobject type~ftlinkedlistrecord->type~ftlinkedlistrecord next, previous type~ftmultiindextable FTMultiIndexTable type~ftmultiindextable->type~ftobject type~ftmultiindextable->type~ftlinkedlist table type~ftmutableobjectarray FTMutableObjectArray type~ftmutableobjectarray->type~ftobject type~ftobjectpointerwrapper FTObjectPointerWrapper type~ftmutableobjectarray->type~ftobjectpointerwrapper array type~ftobjectpointerwrapper->type~ftobject object type~ftsparsematrix FTSparseMatrix type~ftsparsematrix->type~ftobject type~ftsparsematrix->type~ftlinkedlistiterator iterator type~ftlinkedlistptr FTLinkedListPtr type~ftsparsematrix->type~ftlinkedlistptr table type~ftstringset FTStringSet type~ftstringset->type~ftobject type~ftstringset->type~ftdictionary dict type~ftvalue FTValue type~ftvalue->type~ftobject type~matrixdata MatrixData type~matrixdata->type~ftobject object type~matrixdata->type~ftobject type~multiindexmatrixdata MultiIndexMatrixData type~multiindexmatrixdata->type~ftobject object type~multiindexmatrixdata->type~ftobject type~ftlinkedlistptr->type~ftlinkedlist list type~ftstack FTStack type~ftstack->type~ftlinkedlist type~ftvaluedictionary FTValueDictionary type~ftvaluedictionary->type~ftdictionary

Finalization Procedures

final :: destructFTObject


Type-Bound Procedures

procedure, public :: init => initFTObject

procedure, public :: description => FTObjectDescription

  • 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

    Type IntentOptional Attributes Name
    class(FTObject) :: self

    Return Value character(len=DESCRIPTION_CHARACTER_LENGTH)

procedure, public :: printDescription => printFTObjectDescription

procedure, public :: className

  • public function className(self) result(s)

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

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(FTObject) :: self

    Return Value character(len=CLASS_NAME_CHARACTER_LENGTH)

procedure, public, non_overridable :: copy => copyFTObject

  • 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

    Type IntentOptional Attributes Name
    class(FTObject), intent(in) :: self

    Return Value class(FTObject), POINTER

procedure, public, non_overridable :: retain => retainFTObject

  • public subroutine retainFTObject(self)

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

    Arguments

    Type IntentOptional Attributes Name
    class(FTObject) :: self

procedure, public, non_overridable :: isUnreferenced

  • 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()

    Read more…

    Arguments

    Type IntentOptional Attributes Name
    class(FTObject) :: self

    Return Value logical

procedure, public, non_overridable :: refCount

  • public function refCount(self)

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

    Arguments

    Type IntentOptional Attributes Name
    class(FTObject) :: self

    Return Value integer