collections_mod::c_get_logical Interface Reference

Gets a specific logical element out of the list, stack, queue or map with the corresponding key. More...

Private Member Functions
logical function	list_get_logical (specificlist, i)
	Retrieves the element at index i from the list. More...
logical function	stack_get_logical (specificstack, i)
	Gets a specific element from the stack at index specified. More...
logical function	queue_get_logical (specificqueue, i)
	Returns a specific queue element at an index. More...
logical function	map_get_logical (specificmap, key)
	Gets a specific element out of the map with the corresponding key. More...
logical function	hashmap_get_logical (specificmap, key)
	Gets a specific element out of the hashmap with the corresponding key. More...
logical function	mapentry_get_logical (mapentry_item)
	Retrieves the logical value from a map entry. More...

Detailed Description

Gets a specific logical element out of the list, stack, queue or map with the corresponding key.

This has a time complexity of O(n)

Parameters

collection	The specific list, stack, queue or map involved
key	String look up key

Returns

Logical value associated with the key or raises an error if none exists

Definition at line 409 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_get_logical()

logical function collections_mod::c_get_logical::hashmap_get_logical ( type(hashmap_type), intent(inout)  specificmap, character(len=*), intent(in)  key  )

private

Gets a specific element out of the hashmap with the corresponding key.

Do not call directly from external module, this is called via the appropriate interface

Parameters

specificmap	The specific hashmap involved
key	Look up key

Returns

Logical value associated with the key or raises an error if none is found

Definition at line 1756 of file collections.F90.

    type(hashmap_type), intent(inout) :: specificmap
    character(len=*), intent(in) :: key
    logical :: hashmap_get_logical
 
    class(*), pointer :: generic
 
    generic=>hashmap_get_generic(specificmap, key)
    if (.not. associated(generic)) call log_log(log_error, "Can not find logical entry with key '"//trim(key)//"'")
    hashmap_get_logical=conv_to_logical(generic, .false.)

list_get_logical()

logical function collections_mod::c_get_logical::list_get_logical ( type(list_type), intent(inout)  specificlist, integer, intent(in)  i  )

private

Retrieves the element at index i from the list.

Do not call directly from external module, this is called via the appropriate interface

Parameters

specificlist	The specific list involved
i	Index to look up

Returns

Logical data in the list or raises an error if none is found

Definition at line 3099 of file collections.F90.

    type(list_type), intent(inout) :: specificlist
    integer, intent(in) :: i
    logical :: list_get_logical
 
    class(*), pointer :: generic
 
    generic=>list_get_generic(specificlist, i)
    if (.not. associated(generic)) call log_log(log_error, "Can not get logical from list at index "//trim(conv_to_string(i)))
    list_get_logical=conv_to_logical(generic, .false.)

map_get_logical()

logical function collections_mod::c_get_logical::map_get_logical ( type(map_type), intent(inout)  specificmap, character(len=*), intent(in)  key  )

private

Gets a specific element out of the map with the corresponding key.

Do not call directly from external module, this is called via the appropriate interface

Parameters

specificmap	The specific map involved
key	Look up key

Returns

Logical value associated with the key or raises an error if none is found

Definition at line 1118 of file collections.F90.

    type(map_type), intent(inout) :: specificmap
    character(len=*), intent(in) :: key
    logical :: map_get_logical
 
    class(*), pointer :: generic
 
    generic=>map_get_generic(specificmap, key)
    if (.not. associated(generic)) call log_log(log_error, "Can not find logical entry with key '"//trim(key)//"'")
    map_get_logical=conv_to_logical(generic, .false.)

mapentry_get_logical()

logical function collections_mod::c_get_logical::mapentry_get_logical ( type(mapentry_type), intent(in)  mapentry_item )

private

Retrieves the logical value from a map entry.

Parameters

mapentry_item

The map entry to retrieve the logical value from

Definition at line 3366 of file collections.F90.

    type(mapentry_type), intent(in) :: mapentry_item
    logical :: mapentry_get_logical
 
    class(*), pointer :: generic
 
    generic=>mapentry_item%value
    if (.not. associated(generic)) call log_log(log_error, "Can not get logical from map entry")
    mapentry_get_logical=conv_to_logical(generic, .false.)

queue_get_logical()

logical function collections_mod::c_get_logical::queue_get_logical ( type(queue_type), intent(inout)  specificqueue, integer, intent(in)  i  )

private

Returns a specific queue element at an index.

Do not call directly from external module, this is called via the appropriate interface

Parameters

specificqueue	The specific queue involved
i	The index to look up

Returns

Logical element at i or raises an error if none is found

Definition at line 2705 of file collections.F90.

    type(queue_type), intent(inout) :: specificqueue
    integer, intent(in) :: i
    logical :: queue_get_logical
 
    class(*), pointer :: generic
 
    generic=>queue_get_generic(specificqueue, i)
    if (.not. associated(generic)) call log_log(log_error, "Can not get logical from queue at index "//trim(conv_to_string(i)))
    queue_get_logical=conv_to_logical(generic, .false.)

stack_get_logical()

logical function collections_mod::c_get_logical::stack_get_logical ( type(stack_type), intent(inout)  specificstack, integer, intent(in)  i  )

private

Gets a specific element from the stack at index specified.

Do not call directly from external module, this is called via the appropriate interface

Parameters

specificstack	The specific stack involved
i	The index to retrieve the element at

Returns

Logical data or raises an error if none is found

Definition at line 2409 of file collections.F90.

    type(stack_type), intent(inout) :: specificstack
    integer, intent(in) :: i
    logical :: stack_get_logical
 
    class(*), pointer :: generic
 
    generic=>stack_get_generic(specificstack, i)
    if (.not. associated(generic)) call log_log(log_error, "Can not get logical from stack at index "//trim(conv_to_string(i)))
    stack_get_logical=conv_to_logical(generic, .false.)

---

The documentation for this interface was generated from the following file:

• model_core/src/utils/collections.F90