historyaddattr.f90

Go to the documentation of this file.

!--
! *** Caution!! ***
!
! This file is generated from "historyaddattr.rb2f90" by Ruby 3.3.8.
! Please do not edit this file directly.
!
! [JAPANESE]
!
! ※※※ 注意!!! ※※※
!
! このファイルは "historyaddattr.rb2f90" から Ruby 3.3.8
! によって自動生成されたファイルです.
! このファイルを直接編集しませんようお願い致します.
!
!
!++
!> @file historyaddattr.F
!>
!> @author Yasuhiro MORIKAWA, Eizi TOYODA
!> @copyright Copyright (C) GFD Dennou Club, 2000-2026. All rights reserved. <br/>
!>            License is BSD-2-Clause. See [COPYRIGHT](@ref COPYRIGHT) in detail
!>
!> @en
!> @brief Add attributes to a variable in gtool4 data
!> @enden
!>
!> @ja
!> @brief gtool4 データ内の変数への属性付加
!> @endja
  subroutine historyaddattrchar0( &
    & varname, attrname, value, history, err)
    !
                        !
    !> @brief gtool4 データ内の変数への属性付加
    !>
    !> gtool4 データおよびそのデータ内の変数に属性を付加します。
    !> このサブルーチンを用いる前に、 HistoryCreate による初期設定が
    !> 必要です。
    !>
    !> 属性名 attrname の先頭にプラス "+" を付加する
    !> 場合は、gtool4 データ自体の属性 (大域属性) として属性が付加されます。
    !> この場合、varname は無視されますが、
    !> その場合でも varname へはデータ内に存在する変数名を与えてください。
    !>
    !> HistoryAddAttr は複数のサブルーチンの総称名です。value には
    !> いくつかの型を与えることが可能です。
    !> 下記のサブルーチンを参照ください。
    !
    !
    use gtool_history_types, only: gt_history
    use gtool_history_internal, only: default, lookup_var_or_dim
    use gtdata_generic, only: put_attr
    use gtdata_types, only: gt_variable
    use dc_string, only: tochar
    use dc_url, only: gt_plus
    use dc_error, only: storeerror, dc_noerr, nf90_enotvar, hst_empinoaxisdata
    use dc_message, only: messagenotify
    use dc_trace, only: beginsub, endsub
    use dc_types, only: string
    implicit none
    character(*), intent(in):: varname
                                                  ! 変数の名前。
                              !
                              ! ここで指定するものは、
                              ! HistoryCreateの *dims* 、
                              ! または HistoryAddVariable の
                              ! *varname* で既に指定されてい
                              ! なければなりません。
                              !
    character(*), intent(in):: attrname
                                                  ! 変数またはファイル全体に付
                              ! 加する属性の名前
                              !
                              ! "<b><tt>+</tt></b>" (プラ
                              ! ス) を属性名の先頭につける
                              ! 場合には、ファイル全体に属
                              ! 性を付加します。
                              ! ファイル全体へ属性を付加
                              ! する場合でも、 HistoryCreate
                              ! の *dims* 、または
                              ! HistoryAddVariable の
                              ! *varname* で既に指定されてい
                              ! る変数を *varname* に指定する
                              ! 必要があります。
                              !
    character(*), intent(in):: value
                                                  ! 属性の値
                              !
    type(gt_history), intent(inout), target, optional:: history
                                                  ! 出力ファイルの設定に関する情報を
                              ! 格納した構造体
                              !
                              ! ここに指定するものは、
                              ! HistoryCreate によって初期設定
                              ! されていなければなりません。
                              !
    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.
    type(gt_history), pointer:: hst =>null()
    type(gt_variable):: var
    integer:: v_ord
    logical:: err_not_found
    integer:: stat
    character(STRING):: cause_c
    character(len = *), parameter:: subname = "HistoryAddAttrChar0"
  continue
    call beginsub(subname, &
      & 'varname=<%c> attrname=<%c>, value=<%c>', &
      & c1=trim(varname), c2=trim(attrname), c3=trim(value))
    stat = dc_noerr
    cause_c = ''
    ! 操作対象決定
    if (present(history)) then
      hst => history
    else
      hst => default
    endif
    if (varname == "") then
      ! とりあえず無駄だが大域属性を何度もつける
      do, v_ord = 1, size(hst % vars)
        call put_attr(hst % vars(v_ord), gt_plus // attrname, value)
      enddo
    else
      call lookup_var_or_dim( hst, varname, var, err_not_found )
      if ( .not. err_not_found ) then
        call put_attr(var, attrname, value)
      else
        stat = nf90_enotvar
        cause_c = 'varname="' // trim(varname) // '" is not found'
        goto 999
      endif
    endif
999 continue
    call storeerror(stat, subname, err, cause_c=cause_c)
    call endsub(subname)
  end subroutine historyaddattrchar0
  subroutine historyaddattrlogical0( &
    & varname, attrname, value, history, err)
    !
    !
    use gtool_history_types, only: gt_history
    use gtool_history_internal, only: default, lookup_var_or_dim
    use gtdata_generic, only: put_attr
    use gtdata_types, only: gt_variable
    use dc_string, only: tochar
    use dc_url, only: gt_plus
    use dc_error, only: storeerror, dc_noerr, nf90_enotvar, hst_empinoaxisdata
    use dc_message, only: messagenotify
    use dc_trace, only: beginsub, endsub
    use dc_types, only: string
    implicit none
    character(*), intent(in):: varname
    character(*), intent(in):: attrname
    logical, intent(in):: value
    type(gt_history), intent(inout), target, optional:: history
    logical, intent(out), optional:: err
    type(gt_history), pointer:: hst =>null()
    type(gt_variable):: var
    integer:: v_ord
    logical:: err_not_found
    integer:: stat
    character(STRING):: cause_c
    character(len = *), parameter:: subname = "HistoryAddAttrLogical0"
  continue
    call beginsub(subname, &
      & 'varname=<%c> attrname=<%c>, value=<%c>', &
      & c1=trim(varname), c2=trim(attrname), c3=trim(tochar(value)))
    stat = dc_noerr
    cause_c = ''
    ! 操作対象決定
    if (present(history)) then
      hst => history
    else
      hst => default
    endif
    if (varname == "") then
      ! とりあえず無駄だが大域属性を何度もつける
      do, v_ord = 1, size(hst % vars)
        call put_attr(hst % vars(v_ord), gt_plus // attrname, value)
      enddo
    else
      call lookup_var_or_dim( hst, varname, var, err_not_found )
      if ( .not. err_not_found ) then
        call put_attr(var, attrname, value)
      else
        stat = nf90_enotvar
        cause_c = 'varname="' // trim(varname) // '" is not found'
        goto 999
      endif
    endif
999 continue
    call storeerror(stat, subname, err, cause_c=cause_c)
    call endsub(subname)
  end subroutine historyaddattrlogical0
  subroutine historyaddattrint0( &
    & varname, attrname, value, history, err)
    !
    !
    use gtool_history_types, only: gt_history
    use gtool_history_internal, only: default, lookup_var_or_dim
    use gtdata_generic, only: put_attr
    use gtdata_types, only: gt_variable
    use dc_string, only: tochar
    use dc_url, only: gt_plus
    use dc_error, only: storeerror, dc_noerr, nf90_enotvar, hst_empinoaxisdata
    use dc_message, only: messagenotify
    use dc_trace, only: beginsub, endsub
    use dc_types, only: string
    implicit none
    character(*), intent(in):: varname
    character(*), intent(in):: attrname
    integer, intent(in):: value
    type(gt_history), intent(inout), target, optional:: history
    logical, intent(out), optional:: err
    type(gt_history), pointer:: hst =>null()
    type(gt_variable):: var
    integer:: v_ord
    logical:: err_not_found
    integer:: stat
    character(STRING):: cause_c
    character(len = *), parameter:: subname = "HistoryAddAttrInt0"
  continue
    call beginsub(subname, &
      & 'varname=<%c> attrname=<%c>, value=<%c>', &
      & c1=trim(varname), c2=trim(attrname), c3=trim(tochar(value)))
    stat = dc_noerr
    cause_c = ''
    ! 操作対象決定
    if (present(history)) then
      hst => history
    else
      hst => default
    endif
    if (varname == "") then
      ! とりあえず無駄だが大域属性を何度もつける
      do, v_ord = 1, size(hst % vars)
        call put_attr(hst % vars(v_ord), gt_plus // attrname, (/value/))
      enddo
    else
      call lookup_var_or_dim( hst, varname, var, err_not_found )
      if ( .not. err_not_found ) then
        call put_attr(var, attrname, (/value/))
      else
        stat = nf90_enotvar
        cause_c = 'varname="' // trim(varname) // '" is not found'
        goto 999
      endif
    endif
999 continue
    call storeerror(stat, subname, err, cause_c=cause_c)
    call endsub(subname)
  end subroutine historyaddattrint0
  subroutine historyaddattrint1( &
    & varname, attrname, value, history, err)
    !
    !
    use gtool_history_types, only: gt_history
    use gtool_history_internal, only: default, lookup_var_or_dim
    use gtdata_generic, only: put_attr
    use gtdata_types, only: gt_variable
    use dc_string, only: tochar
    use dc_url, only: gt_plus
    use dc_error, only: storeerror, dc_noerr, nf90_enotvar, hst_empinoaxisdata
    use dc_message, only: messagenotify
    use dc_trace, only: beginsub, endsub
    use dc_types, only: string
    implicit none
    character(*), intent(in):: varname
    character(*), intent(in):: attrname
    integer, intent(in):: value(:)
    type(gt_history), intent(inout), target, optional:: history
    logical, intent(out), optional:: err
    type(gt_history), pointer:: hst =>null()
    type(gt_variable):: var
    integer:: v_ord
    logical:: err_not_found
    integer:: stat
    character(STRING):: cause_c
    character(len = *), parameter:: subname = "HistoryAddAttrInt1"
  continue
    call beginsub(subname, &
      & 'varname=<%c> attrname=<%c>, value=<%c>', &
      & c1=trim(varname), c2=trim(attrname), c3=trim(tochar(value)))
    stat = dc_noerr
    cause_c = ''
    ! 操作対象決定
    if (present(history)) then
      hst => history
    else
      hst => default
    endif
    if (varname == "") then
      ! とりあえず無駄だが大域属性を何度もつける
      do, v_ord = 1, size(hst % vars)
        call put_attr(hst % vars(v_ord), gt_plus // attrname, (/value/))
      enddo
    else
      call lookup_var_or_dim( hst, varname, var, err_not_found )
      if ( .not. err_not_found ) then
        call put_attr(var, attrname, (/value/))
      else
        stat = nf90_enotvar
        cause_c = 'varname="' // trim(varname) // '" is not found'
        goto 999
      endif
    endif
999 continue
    call storeerror(stat, subname, err, cause_c=cause_c)
    call endsub(subname)
  end subroutine historyaddattrint1
  subroutine historyaddattrreal0( &
    & varname, attrname, value, history, err)
    !
    !
    use gtool_history_types, only: gt_history
    use gtool_history_internal, only: default, lookup_var_or_dim
    use gtdata_generic, only: put_attr
    use gtdata_types, only: gt_variable
    use dc_string, only: tochar
    use dc_url, only: gt_plus
    use dc_error, only: storeerror, dc_noerr, nf90_enotvar, hst_empinoaxisdata
    use dc_message, only: messagenotify
    use dc_trace, only: beginsub, endsub
    use dc_types, only: string
    implicit none
    character(*), intent(in):: varname
    character(*), intent(in):: attrname
    real, intent(in):: value
    type(gt_history), intent(inout), target, optional:: history
    logical, intent(out), optional:: err
    type(gt_history), pointer:: hst =>null()
    type(gt_variable):: var
    integer:: v_ord
    logical:: err_not_found
    integer:: stat
    character(STRING):: cause_c
    character(len = *), parameter:: subname = "HistoryAddAttrReal0"
  continue
    call beginsub(subname, &
      & 'varname=<%c> attrname=<%c>, value=<%c>', &
      & c1=trim(varname), c2=trim(attrname), c3=trim(tochar(value)))
    stat = dc_noerr
    cause_c = ''
    ! 操作対象決定
    if (present(history)) then
      hst => history
    else
      hst => default
    endif
    if (varname == "") then
      ! とりあえず無駄だが大域属性を何度もつける
      do, v_ord = 1, size(hst % vars)
        call put_attr(hst % vars(v_ord), gt_plus // attrname, (/value/))
      enddo
    else
      call lookup_var_or_dim( hst, varname, var, err_not_found )
      if ( .not. err_not_found ) then
        call put_attr(var, attrname, (/value/))
      else
        stat = nf90_enotvar
        cause_c = 'varname="' // trim(varname) // '" is not found'
        goto 999
      endif
    endif
999 continue
    call storeerror(stat, subname, err, cause_c=cause_c)
    call endsub(subname)
  end subroutine historyaddattrreal0
  subroutine historyaddattrreal1( &
    & varname, attrname, value, history, err)
    !
    !
    use gtool_history_types, only: gt_history
    use gtool_history_internal, only: default, lookup_var_or_dim
    use gtdata_generic, only: put_attr
    use gtdata_types, only: gt_variable
    use dc_string, only: tochar
    use dc_url, only: gt_plus
    use dc_error, only: storeerror, dc_noerr, nf90_enotvar, hst_empinoaxisdata
    use dc_message, only: messagenotify
    use dc_trace, only: beginsub, endsub
    use dc_types, only: string
    implicit none
    character(*), intent(in):: varname
    character(*), intent(in):: attrname
    real, intent(in):: value(:)
    type(gt_history), intent(inout), target, optional:: history
    logical, intent(out), optional:: err
    type(gt_history), pointer:: hst =>null()
    type(gt_variable):: var
    integer:: v_ord
    logical:: err_not_found
    integer:: stat
    character(STRING):: cause_c
    character(len = *), parameter:: subname = "HistoryAddAttrReal1"
  continue
    call beginsub(subname, &
      & 'varname=<%c> attrname=<%c>, value=<%c>', &
      & c1=trim(varname), c2=trim(attrname), c3=trim(tochar(value)))
    stat = dc_noerr
    cause_c = ''
    ! 操作対象決定
    if (present(history)) then
      hst => history
    else
      hst => default
    endif
    if (varname == "") then
      ! とりあえず無駄だが大域属性を何度もつける
      do, v_ord = 1, size(hst % vars)
        call put_attr(hst % vars(v_ord), gt_plus // attrname, (/value/))
      enddo
    else
      call lookup_var_or_dim( hst, varname, var, err_not_found )
      if ( .not. err_not_found ) then
        call put_attr(var, attrname, (/value/))
      else
        stat = nf90_enotvar
        cause_c = 'varname="' // trim(varname) // '" is not found'
        goto 999
      endif
    endif
999 continue
    call storeerror(stat, subname, err, cause_c=cause_c)
    call endsub(subname)
  end subroutine historyaddattrreal1
  subroutine historyaddattrdouble0( &
    & varname, attrname, value, history, err)
    !
    !
    use gtool_history_types, only: gt_history
    use gtool_history_internal, only: default, lookup_var_or_dim
    use gtdata_generic, only: put_attr
    use gtdata_types, only: gt_variable
    use dc_string, only: tochar
    use dc_url, only: gt_plus
    use dc_error, only: storeerror, dc_noerr, nf90_enotvar, hst_empinoaxisdata
    use dc_message, only: messagenotify
    use dc_trace, only: beginsub, endsub
    use dc_types, only: string, dp
    implicit none
    character(*), intent(in):: varname
    character(*), intent(in):: attrname
    real(DP), intent(in):: value
    type(gt_history), intent(inout), target, optional:: history
    logical, intent(out), optional:: err
    type(gt_history), pointer:: hst =>null()
    type(gt_variable):: var
    integer:: v_ord
    logical:: err_not_found
    integer:: stat
    character(STRING):: cause_c
    character(len = *), parameter:: subname = "HistoryAddAttrDouble0"
  continue
    call beginsub(subname, &
      & 'varname=<%c> attrname=<%c>, value=<%c>', &
      & c1=trim(varname), c2=trim(attrname), c3=trim(tochar(value)))
    stat = dc_noerr
    cause_c = ''
    ! 操作対象決定
    if (present(history)) then
      hst => history
    else
      hst => default
    endif
    if (varname == "") then
      ! とりあえず無駄だが大域属性を何度もつける
      do, v_ord = 1, size(hst % vars)
        call put_attr(hst % vars(v_ord), gt_plus // attrname, (/value/))
      enddo
    else
      call lookup_var_or_dim( hst, varname, var, err_not_found )
      if ( .not. err_not_found ) then
        call put_attr(var, attrname, (/value/))
      else
        stat = nf90_enotvar
        cause_c = 'varname="' // trim(varname) // '" is not found'
        goto 999
      endif
    endif
999 continue
    call storeerror(stat, subname, err, cause_c=cause_c)
    call endsub(subname)
  end subroutine historyaddattrdouble0
  subroutine historyaddattrdouble1( &
    & varname, attrname, value, history, err)
    !
    !
    use gtool_history_types, only: gt_history
    use gtool_history_internal, only: default, lookup_var_or_dim
    use gtdata_generic, only: put_attr
    use gtdata_types, only: gt_variable
    use dc_string, only: tochar
    use dc_url, only: gt_plus
    use dc_error, only: storeerror, dc_noerr, nf90_enotvar, hst_empinoaxisdata
    use dc_message, only: messagenotify
    use dc_trace, only: beginsub, endsub
    use dc_types, only: string, dp
    implicit none
    character(*), intent(in):: varname
    character(*), intent(in):: attrname
    real(DP), intent(in):: value(:)
    type(gt_history), intent(inout), target, optional:: history
    logical, intent(out), optional:: err
    type(gt_history), pointer:: hst =>null()
    type(gt_variable):: var
    integer:: v_ord
    logical:: err_not_found
    integer:: stat
    character(STRING):: cause_c
    character(len = *), parameter:: subname = "HistoryAddAttrDouble1"
  continue
    call beginsub(subname, &
      & 'varname=<%c> attrname=<%c>, value=<%c>', &
      & c1=trim(varname), c2=trim(attrname), c3=trim(tochar(value)))
    stat = dc_noerr
    cause_c = ''
    ! 操作対象決定
    if (present(history)) then
      hst => history
    else
      hst => default
    endif
    if (varname == "") then
      ! とりあえず無駄だが大域属性を何度もつける
      do, v_ord = 1, size(hst % vars)
        call put_attr(hst % vars(v_ord), gt_plus // attrname, (/value/))
      enddo
    else
      call lookup_var_or_dim( hst, varname, var, err_not_found )
      if ( .not. err_not_found ) then
        call put_attr(var, attrname, (/value/))
      else
        stat = nf90_enotvar
        cause_c = 'varname="' // trim(varname) // '" is not found'
        goto 999
      endif
    endif
999 continue
    call storeerror(stat, subname, err, cause_c=cause_c)
    call endsub(subname)
  end subroutine historyaddattrdouble1
!--
! vi:set readonly sw=4 ts=8:
!
!Local Variables:
!mode: f90
!buffer-read-only: t
!End:
!
!++