collections_mod::c_pop_string Interface Reference

Pops a string off the stack or queue. More...

Private Member Functions
character(len=string_length) function	stack_pop_string (specificstack)
	Pops an element off the stack (LIFO) More...
character(len=string_length) function	queue_pop_string (specificqueue)
	Pops the queue element off the head of the queue (FIFO) More...

Detailed Description

Pops a string off the stack or queue.

This has a time complexity of O(1)

Parameters

collection

The specific stack or queue involved

Returns

String which has been popped off the collection or raises and error if none is found

Definition at line 176 of file collections.F90.

Member Function/Subroutine Documentation

queue_pop_string()

character(len=string_length) function collections_mod::c_pop_string::queue_pop_string ( type(queue_type), intent(inout)  specificqueue )

private

Pops the queue element off the head of the queue (FIFO)

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

Parameters

specificqueue

The specific queue involved

Returns

String element at head of the queue or raises an error if there is none

Definition at line 2575 of file collections.F90.

    type(queue_type), intent(inout) :: specificqueue
    character(len=STRING_LENGTH) :: queue_pop_string
 
    class(*), pointer :: generic
 
    generic=>queue_pop_generic(specificqueue)
    if (.not. associated(generic)) call log_log(log_error, "Can not pop string from queue")
    queue_pop_string=conv_to_string(generic, .false., string_length)

stack_pop_string()

character(len=string_length) function collections_mod::c_pop_string::stack_pop_string ( type(stack_type), intent(inout)  specificstack )

private

Pops an element off the stack (LIFO)

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

Parameters

specificstack

The specific stack involved

Returns

String data of the last element added to the stack or raises an error if none is found

Definition at line 2279 of file collections.F90.

    type(stack_type), intent(inout) :: specificstack
    character(len=STRING_LENGTH) :: stack_pop_string
 
    class(*), pointer :: generic
 
    generic=>stack_pop_generic(specificstack)
    if (.not. associated(generic)) call log_log(log_error, "Can not pop string from stack")
    stack_pop_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