collections_mod::c_get_string Interface Reference

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

Private Member Functions
character(len=string_length) function	list_get_string (specificlist, i)
	Retrieves the element at index i from the list. More...
character(len=string_length) function	stack_get_string (specificstack, i)
	Gets a specific element from the stack at index specified. More...
character(len=string_length) function	queue_get_string (specificqueue, i)
	Returns a specific queue element at an index. More...
character(len=string_length) function	map_get_string (specificmap, key)
	Gets a specific element out of the map with the corresponding key. More...
character(len=string_length) function	hashmap_get_string (specificmap, key)
	Gets a specific element out of the hashmap with the corresponding key. More...
character(len=string_length) function	hashset_get_string (specificset, index)
	Retrieves the key at index i from the set or empty string if index < list size. More...
character(len=string_length) function	mapentry_get_string (mapentry_item)
	Retrieves the string value from a map entry. More...

Detailed Description

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

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

Definition at line 388 of file collections.F90.

Member Function/Subroutine Documentation

hashmap_get_string()

character(len=string_length) function collections_mod::c_get_string::hashmap_get_string ( 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

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

Definition at line 1713 of file collections.F90.

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

hashset_get_string()

character(len=string_length) function collections_mod::c_get_string::hashset_get_string ( type(hashset_type), intent(inout)  specificset, integer, intent(in)  index  )

private

Retrieves the key at index i from the set or empty string if index < list size.

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

Parameters

specificset	The specific set involved
i	Index to look up

Returns

The corresponding key at this location or empty string if none is found

Definition at line 2078 of file collections.F90.

    type(hashset_type), intent(inout) :: specificset
    integer, intent(in) :: index
    class(*), pointer :: generic
 
    integer :: i, current_size, prev
 
    hashset_get_string=""
    if (.not. associated(specificset%set_ds) .or. index .gt. specificset%size) return
 
    current_size=0
    prev=0
    do i=1, hash_size
      current_size=current_size+list_size(specificset%set_ds(i))
      if (current_size .ge. index) then
        generic=>list_get_generic(specificset%set_ds(i), index-prev)        
        if (associated(generic)) then
          select type (generic)
          type is (setnode_type)
            hashset_get_string=generic%key
          end select
          return
        else
          call log_log(log_error, "Can not find hashset entry at index "//trim(conv_to_string(index)))
        end if
      end if
      prev=current_size
    end do

list_get_string()

character(len=string_length) function collections_mod::c_get_string::list_get_string ( 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

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

Definition at line 3056 of file collections.F90.

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

map_get_string()

character(len=string_length) function collections_mod::c_get_string::map_get_string ( 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

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

Definition at line 1075 of file collections.F90.

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

mapentry_get_string()

character(len=string_length) function collections_mod::c_get_string::mapentry_get_string ( type(mapentry_type), intent(in)  mapentry_item )

private

Retrieves the string value from a map entry.

Parameters

mapentry_item

The map entry to retrieve the string value from

Definition at line 3333 of file collections.F90.

    type(mapentry_type), intent(in) :: mapentry_item
    character(len=STRING_LENGTH) :: mapentry_get_string
 
    class(*), pointer :: generic
 
    generic=>mapentry_item%value
    if (.not. associated(generic)) call log_log(log_error, "Can not get string from map entry")
    mapentry_get_string=conv_to_string(generic, .false., string_length)

queue_get_string()

character(len=string_length) function collections_mod::c_get_string::queue_get_string ( 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

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

Definition at line 2662 of file collections.F90.

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

stack_get_string()

character(len=string_length) function collections_mod::c_get_string::stack_get_string ( 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

String data or raises an error if none is found

Definition at line 2366 of file collections.F90.

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

---

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

• model_core/src/utils/collections.F90