collections_mod::c_get_integer Interface Reference

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

Private Member Functions
integer function	list_get_int (specificlist, i)
	Retrieves the element at index i from the list. More...
integer function	stack_get_int (specificstack, i)
	Gets a specific element from the stack at index specified. More...
integer function	queue_get_int (specificqueue, i)
	Returns a specific queue element at an index. More...
integer function	map_get_int (specificmap, key)
	Gets a specific element out of the map with the corresponding key. More...
integer function	hashmap_get_int (specificmap, key)
	Gets a specific element out of the hashmap with the corresponding key. More...
integer function	mapentry_get_int (mapentry_item)
	Retrieves the integer value from a map entry. More...

Detailed Description

Gets a specific integer 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

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

Definition at line 378 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_get_int()

integer function collections_mod::c_get_integer::hashmap_get_int ( 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

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

Definition at line 1695 of file collections.F90.

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

list_get_int()

integer function collections_mod::c_get_integer::list_get_int ( 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

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

Definition at line 3038 of file collections.F90.

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

map_get_int()

integer function collections_mod::c_get_integer::map_get_int ( 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

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

Definition at line 1057 of file collections.F90.

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

mapentry_get_int()

integer function collections_mod::c_get_integer::mapentry_get_int ( type(mapentry_type), intent(in)  mapentry_item )

private

Retrieves the integer value from a map entry.

Parameters

mapentry_item

The map entry to retrieve the integer value from

Definition at line 3320 of file collections.F90.

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

queue_get_int()

integer function collections_mod::c_get_integer::queue_get_int ( 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

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

Definition at line 2644 of file collections.F90.

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

stack_get_int()

integer function collections_mod::c_get_integer::stack_get_int ( 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

Integer data or raises an error if none is found

Definition at line 2348 of file collections.F90.

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

---

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

• model_core/src/utils/collections.F90