gtvarattrtrue.f90 File Reference

Logical type attribute input. More...

Go to the source code of this file.

Functions/Subroutines
logical function	gtvarattrtrue (var, name, default)

Detailed Description

Logical type attribute input.

Author

Eizi TOYODA, Yasuhiro MORIKAWA

Copyright

Copyright (C) GFD Dennou Club, 2000-2026. All rights reserved.
License is BSD-2-Clause. See COPYRIGHT in detail

This function is provided through gtdata_generic.

Definition in file gtvarattrtrue.f90.

Function/Subroutine Documentation

gtvarattrtrue()

logical function gtvarattrtrue	(	type(gt_variable), intent(in)	var,
		character(len = *), intent(in)	name,
		logical, intent(in), optional	default )

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.

Parameters

[in]	var	Variable handle
[in]	name	Attribute name
[in]	default	Default value (optional)

Returns

Logical attribute value

Definition at line 62 of file gtvarattrtrue.f90.

  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

References dc_error::gt_enotvar, dc_error::storeerror(), and gtdata_internal_map::var_class().

Here is the call graph for this function: