FTKeyObjectPair Derived Type
type, public, extends(FTObject) :: FTKeyObjectPair
Components
| Type | Visibility | Attributes | Name | Initial | |||
|---|---|---|---|---|---|---|---|
| character(len=FTDICT_KWD_STRING_LENGTH), | public | :: | keyString | ||||
| class(FTObject), | public, | POINTER | :: | valueObject | => | NULL() |
Type-Bound Procedures
procedure, public :: init => initFTObject
-
public subroutine initFTObject(self)
Generic Name: init()
Read more… Arguments
Type Intent Optional Attributes Name class(FTObject) :: self
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 Intent Optional 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 Intent Optional 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 Intent Optional 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 Intent Optional 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.
Read more… Arguments
Type Intent Optional Attributes Name class(FTObject) :: self Return Value integer
procedure, public :: initWithObjectAndKey
-
public subroutine initWithObjectAndKey(self, v, key)
Arguments
Type Intent Optional Attributes Name class(FTKeyObjectPair) :: self class(FTObject), POINTER :: v character(len=*) :: key
procedure, public :: destruct => destructFTKeyObjectPair
-
public subroutine destructFTKeyObjectPair(self)
Arguments
Type Intent Optional Attributes Name class(FTKeyObjectPair) :: self
procedure, public :: description => FTKeyObjectPairDescription
-
public function FTKeyObjectPairDescription(self)
Arguments
Type Intent Optional Attributes Name class(FTKeyObjectPair) :: self Return Value character(len=description_character_length)
procedure, public :: printDescription => printFTKeyObjectPairDescription
-
public subroutine printFTKeyObjectPairDescription(self, iUnit)
Arguments
Type Intent Optional Attributes Name class(FTKeyObjectPair) :: self integer :: iUnit
procedure, public :: key
-
public function key(self)
Arguments
Type Intent Optional Attributes Name class(FTKeyObjectPair) :: self Return Value character(len=ftdict_kwd_string_length)
procedure, public :: object
-
public function object(self)
Arguments
Type Intent Optional Attributes Name class(FTKeyObjectPair) :: self Return Value class(FTObject), POINTER