gtvarattrtrue.f90

Go to the documentation of this file.

!> @file gtvarattrtrue.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 Logical type attribute input
!>
!> This function is provided through gtdata_generic.
!> @enden
!>
!> @ja
!> @brief 論理型属性の入力
!>
!> この関数は gtdata_generic から提供されます。
!> @endja
!>
 
!>
!> @en
!> @brief Get attribute as logical value
!>
!> Returns the value of attribute name attached to variable var.
!> Can only be used when the attribute value is a logical type attribute.
!>
!> Returns .false. in the following cases:
!> - Attribute value is character type and one of "", "0", "0.0", "0.",
!>   ".0", "FALSE", "false", ".FALSE.", ".false.", "F", "f", "0.0D0", "0.0d0"
!> - Attribute value is a negative real number
!>
!> If the attribute value cannot be retrieved normally and default
!> is provided, that value is returned. If default is not provided,
!> .false. is returned.
!> @param[in] var     Variable handle
!> @param[in] name    Attribute name
!> @param[in] default Default value (optional)
!> @return Logical attribute value
!> @enden
!>
!> @ja
!> @brief 属性を論理値として取得
!>
!> 変数 var に付加されている属性 name の値を返します。
!> 属性値が論理型属性の場合のみ用いることが出来ます。
!>
!> 以下の場合には .false. が返ります。
!> - 属性の値が文字型で "", "0", "0.0", "0.", ".0", "FALSE",
!>   "false", ".FALSE.", ".false.", "F", "f", "0.0D0", "0.0d0"
!>   のいづれかであった場合
!> - 属性の値が負の実数であった場合
!>
!> 属性の値が正常に取得できず、且つ default が与えられて
!> いた場合、その値が返ります。default が与えられていなかった
!> 場合には .false. が返ります。
!> @param[in] var     変数ハンドル
!> @param[in] name    属性名
!> @param[in] default デフォルト値 (省略可能)
!> @return 論理属性値
!> @endja
!>
logical function gtvarattrtrue(var, name, default) result(result)
  use gtdata_types, only: gt_variable
  use gtdata_internal_map, only: var_class, vtb_class_netcdf
  use gtdata_netcdf_generic, only: get_attr
  use gtdata_netcdf_types, only: gd_nc_variable
  use dc_error, only: storeerror, gt_enotvar
  implicit none
  type(gt_variable), intent(in):: var
  character(len = *), intent(in):: name
  logical, intent(in), optional:: default
  integer:: class, cid
continue
  call var_class(var, class, cid)
  if (class == vtb_class_netcdf) then
    call get_attr(gd_nc_variable(cid), name, result, default)
  else
    call storeerror(gt_enotvar, "GTVarAttrTrue(NO VARIABLE)")
    result = .false.
  endif
end function gtvarattrtrue