gtvarattrsearch.f90

Go to the documentation of this file.

!> @file gtvarattrsearch.f90
!>
!> @author Eizi TOYODA, Yasuhiro MORIKAWA
!> @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 Variable attribute retrieval
!>
!> These subroutines are provided through gtdata_generic.
!> @enden
!>
!> @ja
!> @brief 変数の属性取得
!>
!> これらのサブルーチンは gtdata_generic から提供されます。
!> @endja
!>
 
!>
!> @en
!> @brief Get attribute list from variable (initialization)
!>
!> Subroutine used to get a list of attribute names from var.
!> You can get the attribute list using this subroutine and Attr_Next.
!>
!> To enumerate all attributes for a variable var, first call
!> Attr_Rewind, then call Attr_Next. The first call returns the
!> first attribute, the next call returns the next attribute name.
!> After the last attribute, end == .true..
!>
!> Example:
!> @code
!> use gtool5
!> type(GT_VARIABLE):: var
!> character(len = STRING):: attrname
!> logical:: end
!>
!> call Attr_Rewind(var)
!> do
!>     call Attr_Next(var, attrname, end)
!>     if (end) exit
!>     write(*,*) trim(attrname)
!> enddo
!> @endcode
!> @param[inout] var Variable handle
!> @enden
!>
!> @ja
!> @brief 変数からの属性リスト取得 (初期化用)
!>
!> var から属性名のリストを取得するために利用するサブルーチンです。
!> このサブルーチンと Attr_Next によって属性リスト一覧を取得できます。
!>
!> ある変数 var について全ての属性を列挙するためには、まず
!> Attr_Rewind を呼んだ後、Attr_Next を呼びます。最初の呼び出しで
!> 最初の属性が、次の呼び出しで次の属性の名前が得られます。最後の
!> 属性のあとでは end == .true. となります。
!> @param[inout] var 変数ハンドル
!> @endja
!>
subroutine gtvarattrrewind(var)
  use gtdata_types, only: gt_variable
  use gtdata_internal_map, only: var_class, vtb_class_netcdf
  use gtdata_netcdf_generic, only: attr_rewind
  use gtdata_netcdf_types, only: gd_nc_variable
  implicit none
  type(gt_variable), intent(inout), target:: var
  integer:: class, cid
continue
  call var_class(var, class, cid)
  select case(class)
  case(vtb_class_netcdf)
    call attr_rewind(gd_nc_variable(cid))
  end select
end subroutine gtvarattrrewind
 
!>
!> @en
!> @brief Get attribute list from variable (get next)
!>
!> See Attr_Rewind.
!> @param[inout] var  Variable handle
!> @param[out]   name Attribute name
!> @param[out]   end  .true. when all attributes have been enumerated (optional)
!> @enden
!>
!> @ja
!> @brief 変数からの属性リスト取得 (次を取得)
!>
!> Attr_Rewind を参照してください。
!> @param[inout] var  変数ハンドル
!> @param[out]   name 属性名
!> @param[out]   end  すべての属性を列挙し終えたとき .true. (省略可能)
!> @endja
!>
subroutine gtvarattrnext(var, name, end)
  use gtdata_types, only: gt_variable
  use gtdata_internal_map, only: var_class, vtb_class_netcdf
  use gtdata_netcdf_generic, only: attr_next
  use gtdata_netcdf_types, only: gd_nc_variable
  implicit none
  type(gt_variable), intent(inout), target:: var
  character(len = *), intent(out):: name
  logical, intent(out), optional:: end
  integer:: class, cid
continue
  call var_class(var, class, cid)
  select case(class)
  case(vtb_class_netcdf)
    call attr_next(gd_nc_variable(cid), name, end)
  end select
end subroutine gtvarattrnext