memorysethandlermodule Module Reference

Data Types
type	eventhandlerdatatype
interface	set_handler_iface

Functions/Subroutines
subroutine, public	mem_register_handler (var_name, mem_path, handler, ctx)
	Register the event handler and context for this variable. More...
subroutine, public	on_memory_set (var_name, mem_path, status)
	Triggers the calling of the side effect handler for this variable. More...

Variables
type(listtype)	handler_list

Function/Subroutine Documentation

mem_register_handler()

subroutine, public memorysethandlermodule::mem_register_handler	(	character(len=*), intent(in)	var_name,
		character(len=*), intent(in)	mem_path,
		procedure(set_handler_iface), pointer	handler,
		class(*), pointer	ctx
	)

The event handler and its ctx are called whenever the trigger is given by calling on_set_memory(). This allows to handle side effects, e.g. when a variable is from outside a class (the context) such as happens with the BMI.

Parameters

[in]	var_name	the variable name
[in]	mem_path	the memory path
	handler	called after memory is set
	ctx	the context with which the handler should be called

Definition at line 39 of file MemorySetHandler.f90.

    character(len=*), intent(in) :: var_name !< the variable name
    character(len=*), intent(in) :: mem_path !< the memory path
    procedure(set_handler_iface), pointer :: handler !< called after memory is set
    class(*), pointer :: ctx !< the context with which the handler should be called
    ! local
    integer(I4B) :: handler_idx
    class(EventHandlerDataType), pointer :: handler_data => null()
    class(*), pointer :: handler_data_genptr
    type(MemoryType), pointer :: mt
    logical(LGP) :: found
 
    ! first store the handler data
    allocate (handler_data)
    handler_data%handler => handler
    handler_data%handlerContext => ctx
 
    handler_data_genptr => handler_data
    call handler_list%Add(handler_data_genptr)
 
    ! this is the index for the current handler
    handler_idx = handler_list%Count()
 
    ! now set it to the memory item
    mt => null()
    found = .false.
    call get_from_memorylist(var_name, mem_path, mt, found)
    mt%set_handler_idx = handler_idx
 

Here is the call graph for this function:

on_memory_set()

subroutine, public memorysethandlermodule::on_memory_set	(	character(len=*), intent(in)	var_name,
		character(len=*), intent(in)	mem_path,
		integer(i4b), intent(out)	status
	)

The handler can be set by calling mem_register_handler(). When the status contains an error code, the program should be stopped because the data in memory is no longer consistent...

Parameters

[in]	var_name	the variable name
[in]	mem_path	the memory path
[out]	status	status: 0 for success, -1 when failed

Definition at line 76 of file MemorySetHandler.f90.

    character(len=*), intent(in) :: var_name !< the variable name
    character(len=*), intent(in) :: mem_path !< the memory path
    integer(I4B), intent(out) :: status !< status: 0 for success, -1 when failed
    ! local
    type(MemoryType), pointer :: mt
    logical(LGP) :: found
    class(*), pointer :: handler_data_genptr => null()
    class(EventHandlerDataType), pointer :: evt_handler_data => null()
 
    ! get the handler data and cast
    mt => null()
    found = .false.
    call get_from_memorylist(var_name, mem_path, mt, found)
    if (mt%set_handler_idx == 0) then
      ! nothing to be done
      status = 0
      return
    end if
 
    handler_data_genptr => handler_list%GetItem(mt%set_handler_idx)
    select type (handler_data_genptr)
    class is (eventhandlerdatatype)
      evt_handler_data => handler_data_genptr
    end select
 
    ! call the function
    call evt_handler_data%handler(evt_handler_data%handlerContext, status)

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

handler_list

type(listtype) memorysethandlermodule::handler_list

private

Definition at line 20 of file MemorySetHandler.f90.

  type(ListType) :: handler_list