ParameterListIterator_t Derived Type

  1. ParameterList.f90
  2. ParameterList
  3. ParameterListIterator_t

type, public :: ParameterListIterator_t

Finalization Procedures

Type-Bound Procedures


Finalization Procedures

final :: ParameterListIterator_Final

  • private subroutine ParameterListIterator_Final(this)

    Free the dictionary iterator

    Arguments

    Type IntentOptional AttributesName
    type(ParameterListIterator_t), intent(inout) :: this

Type-Bound Procedures

procedure, public, non_overridable :: GetKey => ParameterListIterator_GetKey

  • private function ParameterListIterator_GetKey(this) result(Key)

    Return the Key of the current Entry

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Return Value character(len=:), allocatable

procedure, public, non_overridable :: Init => ParameterListIterator_Init

  • private subroutine ParameterListIterator_Init(this, DataBase)

    Associate the iterator with a dictionary and rewind to the first position

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(inout) :: this
    type(ParameterRootEntry_t), intent(in), target:: DataBase(:)

procedure, public, non_overridable :: Begin => ParameterListIterator_Begin

  • private subroutine ParameterListIterator_Begin(this)

    Rewind the iterator to the first dictionary position

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(inout) :: this

procedure, public, non_overridable :: End => ParameterListIterator_End

  • private subroutine ParameterListIterator_End(this)

    Fast forward to the last dictionary position (HasFinished = .true.)

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(inout) :: this

procedure, public, non_overridable :: Next => ParameterListIterator_Next

  • private subroutine ParameterListIterator_Next(this)

    The iterator points to the next associated entry

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(inout) :: this

procedure, public, non_overridable :: HasFinished => ParameterListIterator_HasFinished

  • private function ParameterListIterator_HasFinished(this) result(HasFinished)

    Check if Iterator has reached the end of the dictionary

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(inout) :: this

    Return Value logical

procedure, public, non_overridable :: GetShape => ParameterListIterator_GetShape

  • private function ParameterListIterator_GetShape(this, Shape) result(FPLerror)

    Return an allocatable array with the shape of the contained value

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    integer(kind=I4P), intent(inout), allocatable:: Shape(:)

    Shape of the stored value

    Return Value integer(kind=I4P)

    Error flag

procedure, public, non_overridable :: GetDimensions => ParameterListIterator_GetDimensions

  • private function ParameterListIterator_GetDimensions(this) result(Dimensions)

    Return an allocatable array with the shape of the contained value

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator

    Return Value integer(kind=I4P)

    Dimensions of the stored value

procedure, public, non_overridable :: DataSizeInBytes => ParameterListIterator_DataSizeInBytes

  • private function ParameterListIterator_DataSizeInBytes(this) result(DataSizeInBytes)

    Return the data size in bytes of the value associated with Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator

    Return Value integer(kind=I4P)

    Size in bytes

procedure, public, non_overridable :: GetSubList => ParameterListIterator_GetSublist

  • private function ParameterListIterator_GetSublist(this, Sublist) result(FPLerror)

    Return a Unlimited polymorphic pointer to a Value given the Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List
    type(ParameterList_t), intent(inout), pointer:: Sublist

    Wrapper

    Return Value integer(kind=I4P)

    Error flag

procedure, public, non_overridable :: isSubList => ParameterListIterator_isSubList

  • private function ParameterListIterator_isSubList(this) result(isSubList)

    Check if a Key is a SubList

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator

    Return Value logical

    Check if is a SubList

procedure, public, non_overridable :: toString => ParameterListIterator_toString

  • private function ParameterListIterator_toString(this, Separator) result(String)

    Return a scalar Value given the Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    character(len=1), intent(in), optional :: Separator

    Array values separator

    Return Value character(len=:), allocatable

    Returned value as string

procedure, public, non_overridable :: Print => ParameterListIterator_Print

  • private recursive subroutine ParameterListIterator_Print(this, unit, prefix, iostat, iomsg)

    Print the content of the DataBase

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter Iterator
    integer(kind=I4P), intent(in), optional :: unit

    Logic unit.
    character(len=*), intent(in), optional :: prefix

    Prefixing string.
    integer(kind=I4P), intent(out), optional :: iostat

    IO error.
    character(len=*), intent(out), optional :: iomsg

    IO error message.

procedure, public, non_overridable :: Free => ParameterListIterator_Free

  • private subroutine ParameterListIterator_Free(this)

    Free the dictionary iterator

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(inout) :: this

generic, public :: Get => ParameterListIterator_Get0D, ParameterListIterator_Get1D, ParameterListIterator_Get2D, ParameterListIterator_Get3D, ParameterListIterator_Get4D, ParameterListIterator_Get5D, ParameterListIterator_Get6D, ParameterListIterator_Get7D

  • private function ParameterListIterator_Get0D(this, Value) result(FPLerror)

    Return a scalar Value given the Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(inout) :: Value

    Returned value

    Return Value integer(kind=I4P)

    Error flag

  • private function ParameterListIterator_Get1D(this, Value) result(FPLerror)

    Return a vector Value given the Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(inout) :: Value(:)

    Returned value

    Return Value integer(kind=I4P)

    Error flag

  • private function ParameterListIterator_Get2D(this, Value) result(FPLerror)

    Return an array Value given the Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(inout) :: Value(:,:)

    Returned value

    Return Value integer(kind=I4P)

    Error flag

  • private function ParameterListIterator_Get3D(this, Value) result(FPLerror)

    Return an array Value given the Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(inout) :: Value(:,:,:)

    Returned value

    Return Value integer(kind=I4P)

    Error flag

  • private function ParameterListIterator_Get4D(this, Value) result(FPLerror)

    Return an array Value given the Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(inout) :: Value(:,:,:,:)

    Returned value

    Return Value integer(kind=I4P)

    Error flag

  • private function ParameterListIterator_Get5D(this, Value) result(FPLerror)

    Return an array Value given the Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(inout) :: Value(:,:,:,:,:)

    Returned value

    Return Value integer(kind=I4P)

    Error flag

  • private function ParameterListIterator_Get6D(this, Value) result(FPLerror)

    Return an array Value given the Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(inout) :: Value(:,:,:,:,:,:)

    Returned value

    Return Value integer(kind=I4P)

    Error flag

  • private function ParameterListIterator_Get7D(this, Value) result(FPLerror)

    Return an array Value given the Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(inout) :: Value(:,:,:,:,:,:,:)

    Returned value

    Return Value integer(kind=I4P)

    Error flag

generic, public :: isOfDataType => ParameterListIterator_isOfDataType0D, ParameterListIterator_isOfDataType1D, ParameterListIterator_isOfDataType2D, ParameterListIterator_isOfDataType3D, ParameterListIterator_isOfDataType4D, ParameterListIterator_isOfDataType5D, ParameterListIterator_isOfDataType6D, ParameterListIterator_isOfDataType7D

  • private function ParameterListIterator_isOfDataType0D(this, Mold) result(isOfDataType)

    Check if the data type of Mold agrees with the value associated with Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Mold

    Mold

    Return Value logical

    Check if has the same type

  • private function ParameterListIterator_isOfDataType1D(this, Mold) result(isOfDataType)

    Check if the data type of Mold agrees with the value associated with Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Mold(1:)

    Mold

    Return Value logical

    Check if has the same type

  • private function ParameterListIterator_isOfDataType2D(this, Mold) result(isOfDataType)

    Check if the data type of Mold agrees with the value associated with Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Mold(1:,1:)

    Mold

    Return Value logical

    Check if has the same type

  • private function ParameterListIterator_isOfDataType3D(this, Mold) result(isOfDataType)

    Check if the data type of Mold agrees with the value associated with Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Mold(1:,1:,1:)

    Mold

    Return Value logical

    Check if has the same type

  • private function ParameterListIterator_isOfDataType4D(this, Mold) result(isOfDataType)

    Check if the data type of Mold agrees with the value associated with Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Mold(1:,1:,1:,1:)

    Mold

    Return Value logical

    Check if has the same type

  • private function ParameterListIterator_isOfDataType5D(this, Mold) result(isOfDataType)

    Check if the data type of Mold agrees with the value associated with Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Mold(1:,1:,1:,1:,1:)

    Mold

    Return Value logical

    Check if has the same type

  • private function ParameterListIterator_isOfDataType6D(this, Mold) result(isOfDataType)

    Check if the data type of Mold agrees with the value associated with Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Mold(1:,1:,1:,1:,1:,1:)

    Mold

    Return Value logical

    Check if has the same type

  • private function ParameterListIterator_isOfDataType7D(this, Mold) result(isOfDataType)

    Check if the data type of Mold agrees with the value associated with Key

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Mold(1:,1:,1:,1:,1:,1:,1:)

    Mold

    Return Value logical

    Check if has the same type

generic, public :: isAssignable => ParameterListIterator_isAssignable0D, ParameterListIterator_isAssignable1D, ParameterListIterator_isAssignable2D, ParameterListIterator_isAssignable3D, ParameterListIterator_isAssignable4D, ParameterListIterator_isAssignable5D, ParameterListIterator_isAssignable6D, ParameterListIterator_isAssignable7D

  • private function ParameterListIterator_isAssignable0D(this, Value) result(isAssignable)

    Check if a stored variable is Assignable to Value

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Value

    Value

    Return Value logical

    Check if is assignable

  • private function ParameterListIterator_isAssignable1D(this, Value) result(isAssignable)

    Check if a stored variable is Assignable to Value

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Value(1:)

    Value

    Return Value logical

    Check if is assignable

  • private function ParameterListIterator_isAssignable2D(this, Value) result(isAssignable)

    Check if a stored variable is Assignable to Value

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Value(1:,1:)

    Value

    Return Value logical

    Check if is assignable

  • private function ParameterListIterator_isAssignable3D(this, Value) result(isAssignable)

    Check if a stored variable is Assignable to Value

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Value(1:,1:,1:)

    Value

    Return Value logical

    Check if is assignable

  • private function ParameterListIterator_isAssignable4D(this, Value) result(isAssignable)

    Check if a stored variable is Assignable to Value

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Value(1:,1:,1:,1:)

    Value

    Return Value logical

    Check if is assignable

  • private function ParameterListIterator_isAssignable5D(this, Value) result(isAssignable)

    Check if a stored variable is Assignable to Value

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Value(1:,1:,1:,1:,1:)

    Value

    Return Value logical

    Check if is assignable

  • private function ParameterListIterator_isAssignable6D(this, Value) result(isAssignable)

    Check if a stored variable is Assignable to Value

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Value(1:,1:,1:,1:,1:,1:)

    Value

    Return Value logical

    Check if is assignable

  • private function ParameterListIterator_isAssignable7D(this, Value) result(isAssignable)

    Check if a stored variable is Assignable to Value

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(in) :: this

    Parameter List Iterator
    class(*), intent(in) :: Value(1:,1:,1:,1:,1:,1:,1:)

    Value

    Return Value logical

    Check if is assignable

generic, public :: Assignment(=) => ParameterListIterator_Assignment

  • private subroutine ParameterListIterator_Assignment(this, ParameterListIterator)

    Dictionary iterator Assignment

    Arguments

    Type IntentOptional AttributesName
    class(ParameterListIterator_t), intent(inout) :: this
    type(ParameterListIterator_t), intent(in) :: ParameterListIterator

All Derived Types

Circle_t CircleWrapper_t DimensionsWrapper0D_DLCA_t DimensionsWrapper0D_I1P_t DimensionsWrapper0D_I2P_t DimensionsWrapper0D_I4P_t DimensionsWrapper0D_I8P_t DimensionsWrapper0D_L_t DimensionsWrapper0D_R4P_t DimensionsWrapper0D_R8P_t DimensionsWrapper0D_t DimensionsWrapper1D_DLCA_t DimensionsWrapper1D_I1P_t DimensionsWrapper1D_I2P_t DimensionsWrapper1D_I4P_t DimensionsWrapper1D_I8P_t DimensionsWrapper1D_L_t DimensionsWrapper1D_R4P_t DimensionsWrapper1D_R8P_t DimensionsWrapper1D_t DimensionsWrapper2D_DLCA_t DimensionsWrapper2D_I1P_t DimensionsWrapper2D_I2P_t DimensionsWrapper2D_I4P_t DimensionsWrapper2D_I8P_t DimensionsWrapper2D_L_t DimensionsWrapper2D_R4P_t DimensionsWrapper2D_R8P_t DimensionsWrapper2D_t DimensionsWrapper3D_DLCA_t DimensionsWrapper3D_I1P_t DimensionsWrapper3D_I2P_t DimensionsWrapper3D_I4P_t DimensionsWrapper3D_I8P_t DimensionsWrapper3D_L_t DimensionsWrapper3D_R4P_t DimensionsWrapper3D_R8P_t DimensionsWrapper3D_t DimensionsWrapper4D_DLCA_t DimensionsWrapper4D_I1P_t DimensionsWrapper4D_I2P_t DimensionsWrapper4D_I4P_t DimensionsWrapper4D_I8P_t DimensionsWrapper4D_L_t DimensionsWrapper4D_R4P_t DimensionsWrapper4D_R8P_t DimensionsWrapper4D_t DimensionsWrapper5D_DLCA_t DimensionsWrapper5D_I1P_t DimensionsWrapper5D_I2P_t DimensionsWrapper5D_I4P_t DimensionsWrapper5D_I8P_t DimensionsWrapper5D_L_t DimensionsWrapper5D_R4P_t DimensionsWrapper5D_R8P_t DimensionsWrapper5D_t DimensionsWrapper6D_DLCA_t DimensionsWrapper6D_I1P_t DimensionsWrapper6D_I2P_t DimensionsWrapper6D_I4P_t DimensionsWrapper6D_I8P_t DimensionsWrapper6D_L_t DimensionsWrapper6D_R4P_t DimensionsWrapper6D_R8P_t DimensionsWrapper6D_t DimensionsWrapper7D_DLCA_t DimensionsWrapper7D_I1P_t DimensionsWrapper7D_I2P_t DimensionsWrapper7D_I4P_t DimensionsWrapper7D_I8P_t DimensionsWrapper7D_L_t DimensionsWrapper7D_R4P_t DimensionsWrapper7D_R8P_t DimensionsWrapper7D_t DimensionsWrapper_t EntryListIterator_t ParameterEntry_t ParameterEntryDictionary_t ParameterList_t ParameterListIterator_t ParameterRootEntry_t WrapperFactory_t WrapperFactoryList_t