gtool_history_nmlinfo_internal::listsearch Interface Reference

Public Member Functions
subroutine	hstnmlinfolistsearch (gthstnml_list, name, previous, next, err)

Detailed Description

Definition at line 59 of file gtool_history_nmlinfo_internal.f90.

Member Function/Subroutine Documentation

hstnmlinfolistsearch()

subroutine gtool_history_nmlinfo_internal::listsearch::hstnmlinfolistsearch	(	type(gthst_nmlinfo_entry), pointer	gthstnml_list,
		character(*), intent(in)	name,
		type(gthst_nmlinfo_entry), optional, pointer	previous,
		type(gthst_nmlinfo_entry), optional, pointer	next,
		logical, intent(out), optional	err
	)

Search list entry by name

gthstnml_list (type GTHST_NMLINFO_ENTRY) that is a list structure is received, and gthstnml_list is reassociated to the entry that has a value that is same as argument name, and returned. If the entry is not found, null is returned. If gthstnml_list is null from the beginning, null is returned.

If previous is given, an entry previous to the above entry is associated. If previous entries are not found, null is returned.

If next is given, an entry next to the above entry is associated. If next entries are not found, null is returned.

Parameters

[in,out]	gthstnml_list	List entry pointer
[in]	name	Variable identifier
[out]	previous	Previous entry pointer (optional)
[out]	next	Next entry pointer (optional)
[out]	err	Error flag (optional)

Definition at line 293 of file gtool_history_nmlinfo_internal.f90.

    use gtool_history_nmlinfo_types, only: gthst_nmlinfo_entry
    use dc_trace, only: beginsub, endsub
    use dc_error, only: storeerror, dc_noerr
    use dc_types, only: string
    implicit none
    type(GTHST_NMLINFO_ENTRY), pointer:: gthstnml_list
                              ! (inout)
    character(*), intent(in):: name
                              ! 変数名. 
                              ! 先頭の空白は無視されます. 
                              ! 
                              ! Variable identifier. 
                              ! Blanks at the head of the name are ignored. 
    type(GTHST_NMLINFO_ENTRY), pointer, optional:: previous
                              ! (out)
    type(GTHST_NMLINFO_ENTRY), pointer, optional:: next
                              ! (out)
    logical, intent(out), optional:: err
                              ! 例外処理用フラグ. 
                              ! デフォルトでは, この手続き内でエラーが
                              ! 生じた場合, プログラムは強制終了します. 
                              ! 引数 *err* が与えられる場合, 
                              ! プログラムは強制終了せず, 代わりに
                              ! *err* に .true. が代入されます. 
                              !
                              ! Exception handling flag. 
                              ! By default, when error occur in 
                              ! this procedure, the program aborts. 
                              ! If this *err* argument is given, 
                              ! .true. is substituted to *err* and 
                              ! the program does not abort. 
 
    !-----------------------------------
    !  作業変数
    !  Work variables
    integer:: stat
    character(STRING):: cause_c
    character(*), parameter:: subname = 'HstNmlInfoListSearch'
  continue
    call beginsub( subname )
    stat = dc_noerr
    cause_c = ''
 
    !-----------------------------------------------------------------
    !  空状態の場合は何もしないで返す
    !  If null, return without change
    !-----------------------------------------------------------------
    if ( .not. associated( gthstnml_list ) ) goto 999
 
    !-----------------------------------------------------------------
    !  引数 *name* と同じ *name* を持つエントリを探査
    !  The entry that has *name* that is same as argument *name* is searched
    !-----------------------------------------------------------------
    if ( present( previous ) ) nullify( previous )
    if ( present( next ) ) nullify( next )
    if ( trim( adjustl( gthstnml_list % name ) ) == trim( adjustl( name ) ) ) then
      if ( present( next ) ) then
        next => gthstnml_list % next
      end if
      goto 999
    end if
 
    do while ( associated( gthstnml_list ) )
      if ( present( previous ) ) previous => gthstnml_list
      call listnext( gthstnml_list = gthstnml_list ) ! (inout)
      if ( .not. associated( gthstnml_list ) ) goto 999
      if ( trim( adjustl( gthstnml_list % name ) ) == trim( adjustl( name ) ) ) then
        if ( present( next ) ) then
          next => gthstnml_list % next
        end if
        goto 999
      end if
    end do
 
    !-----------------------------------------------------------------
    !  終了処理, 例外処理
    !  Termination and Exception handling
    !-----------------------------------------------------------------
999 continue
    call storeerror( stat, subname, err, cause_c )
    call endsub( subname )

References dc_trace::beginsub(), dc_error::dc_noerr, dc_trace::endsub(), dc_error::storeerror(), and dc_types::string.

Here is the call graph for this function:

---

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

• gtool/gtool_history_nmlinfo/gtool_history_nmlinfo_internal.f90