FTStack Derived Type

type, public, extends(FTLinkedList) :: FTStack


Inherits

type~~ftstack~~InheritsGraph type~ftstack FTStack type~ftlinkedlist FTLinkedList type~ftstack->type~ftlinkedlist type~ftlinkedlistrecord FTLinkedListRecord type~ftlinkedlist->type~ftlinkedlistrecord head, tail type~ftobject FTObject type~ftlinkedlist->type~ftobject type~ftlinkedlistrecord->type~ftlinkedlistrecord next, previous type~ftlinkedlistrecord->type~ftobject recordObject type~ftlinkedlistrecord->type~ftobject

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

procedure, public :: add

  • public subroutine add(self, obj)

    Arguments

    Type IntentOptional Attributes Name
    class(FTLinkedList) :: self
    class(FTObject), POINTER :: obj

procedure, public :: remove => removeObject

procedure, public :: reverse => reverseLinkedList

procedure, public :: removeRecord => removeLinkedListRecord

procedure, public :: count => numberOfRecords

procedure, public :: description => FTLinkedListDescription

  • public function FTLinkedListDescription(self)

    Arguments

    Type IntentOptional Attributes Name
    class(FTLinkedList) :: self

    Return Value character(len=DESCRIPTION_CHARACTER_LENGTH)

procedure, public :: allObjects => allLinkedListObjects

procedure, public :: removeAllObjects => removeAllLinkedListObjects

procedure, public :: addObjectsFromList

procedure, public :: makeCircular

  • public subroutine makeCircular(self, circular)

    Arguments

    Type IntentOptional Attributes Name
    class(FTLinkedList) :: self
    logical :: circular

procedure, public :: isCircular

  • public function isCircular(self)

    Arguments

    Type IntentOptional Attributes Name
    class(FTLinkedList) :: self

    Return Value logical

procedure, public :: insertObjectAfterRecord

procedure, public :: insertObjectAfterObject

procedure, public :: init => initFTStack

procedure, public :: printDescription => printStackDescription

  • public subroutine printStackDescription(self, iUnit)

    Arguments

    Type IntentOptional 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 IntentOptional Attributes Name
    class(FTStack) :: self

    Return Value character(len=CLASS_NAME_CHARACTER_LENGTH)

procedure, public :: push

  • public subroutine push(self, obj)

    Arguments

    Type IntentOptional Attributes Name
    class(FTStack) :: self
    class(FTObject), POINTER :: obj

procedure, public :: pop

  • public subroutine pop(self, p)

    Arguments

    Type IntentOptional Attributes Name
    class(FTStack) :: self
    class(FTObject), POINTER :: p

procedure, public :: peek

  • public function peek(self)

    Arguments

    Type IntentOptional Attributes Name
    class(FTStack) :: self

    Return Value class(FTObject), POINTER