FTStack Derived Type
type, public, extends(FTLinkedList) :: FTStack
Components
| Type | Visibility | Attributes | Name | Initial | |||
|---|---|---|---|---|---|---|---|
| class(FTLinkedListRecord), | public, | POINTER | :: | head | => | NULL() | |
| class(FTLinkedListRecord), | public, | POINTER | :: | tail | => | NULL() | |
| integer, | public | :: | nRecords | ||||
| logical, | public | :: | isCircular_ |
Type-Bound Procedures
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 :: add
-
public subroutine add(self, obj)
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self class(FTObject), POINTER :: obj
procedure, public :: remove => removeObject
-
public subroutine removeObject(self, obj)
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self class(FTObject), POINTER :: obj
procedure, public :: reverse => reverseLinkedList
-
public subroutine reverseLinkedList(self)
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self
procedure, public :: removeRecord => removeLinkedListRecord
-
public subroutine removeLinkedListRecord(self, listRecord)
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self class(FTLinkedListRecord), POINTER :: listRecord
procedure, public :: destruct => destructFTLinkedList
-
public subroutine destructFTLinkedList(self)
The destructor must only be called from within the destructors of subclasses It is automatically called by release().
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self
procedure, public :: count => numberOfRecords
-
public function numberOfRecords(self)
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self Return Value integer
procedure, public :: description => FTLinkedListDescription
-
public function FTLinkedListDescription(self)
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self Return Value character(len=DESCRIPTION_CHARACTER_LENGTH)
procedure, public :: allObjects => allLinkedListObjects
-
public function allLinkedListObjects(self) result(array)
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self Return Value class(FTMutableObjectArray), POINTER
procedure, public :: removeAllObjects => removeAllLinkedListObjects
-
public subroutine removeAllLinkedListObjects(self)
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self
procedure, public :: addObjectsFromList
-
public subroutine addObjectsFromList(self, list)
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self class(FTLinkedList), POINTER :: list
procedure, public :: makeCircular
-
public subroutine makeCircular(self, circular)
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self logical :: circular
procedure, public :: isCircular
-
public function isCircular(self)
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self Return Value logical
procedure, public :: insertObjectAfterRecord
-
public subroutine insertObjectAfterRecord(self, obj, after)
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self class(FTObject), POINTER :: obj class(FTLinkedListRecord), POINTER :: after
procedure, public :: insertObjectAfterObject
-
public subroutine insertObjectAfterObject(self, obj, after)
Arguments
Type Intent Optional Attributes Name class(FTLinkedList) :: self class(FTObject), POINTER :: obj class(FTObject), POINTER :: after
procedure, public :: init => initFTStack
-
public subroutine initFTStack(self)
Public, generic name: init()
Read more… Arguments
Type Intent Optional Attributes Name class(FTStack) :: self
procedure, public :: printDescription => printStackDescription
-
public subroutine printStackDescription(self, iUnit)
Arguments
Type Intent Optional Attributes Name class(FTStack) :: self integer :: iUnit
procedure, public :: className => stackClassName
-
public function stackClassName(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(FTStack) :: self Return Value character(len=CLASS_NAME_CHARACTER_LENGTH)