historyinquire.f90 File Reference

Inquire for a GT_HISTORY variable . More...

Go to the source code of this file.

Functions/Subroutines
subroutine	historyinquire1 (history, err, file, title, source, dims, dimsizes, longnames, units, xtypes, institution, origin, interval, newest, oldest, conventions, gt_version, axes, varinfo)
subroutine	historyinquire2 (history, err, file, title, source, dims, dimsizes, longnames, units, xtypes, institution, origin, interval, newest, oldest, conventions, gt_version, axes, varinfo)
subroutine	historyinquire3 (history, err, file, title, source, dims, dimsizes, longnames, units, xtypes, institution, origin, interval, newest, oldest, conventions, gt_version, axes, varinfo)
subroutine	historyinquire4 (history, err, file, title, source, dims, dimsizes, longnames, units, xtypes, institution, origin, interval, newest, oldest, conventions, gt_version, axes, varinfo)

Detailed Description

Inquire for a GT_HISTORY variable

.

Author

Yasuhiro MORIKAWA

Copyright

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

Definition in file historyinquire.f90.

Function/Subroutine Documentation

historyinquire1()

subroutine historyinquire1	(	type(gt_history), intent(in)	history,
		logical, intent(out), optional	err,
		character(*), intent(out), optional	file,
		character(*), intent(out), optional	title,
		character(*), intent(out), optional	source,
		character(*), dimension(:), optional, pointer	dims,
		integer, dimension(:), optional, pointer	dimsizes,
		character(*), dimension(:), optional, pointer	longnames,
		character(*), dimension(:), optional, pointer	units,
		character(*), dimension(:), optional, pointer	xtypes,
		character(*), intent(out), optional	institution,
		real, intent(out), optional	origin,
		real, intent(out), optional	interval,
		real, intent(out), optional	newest,
		real, intent(out), optional	oldest,
		character(*), intent(out), optional	conventions,
		character(*), intent(out), optional	gt_version,
		type(gt_history_axis), dimension(:), optional, pointer	axes,
		type(gt_history_varinfo), dimension(:), optional, pointer	varinfo
	)

Inquire a GT_HISTORY variable

Retrieves values set by HistoryCreate, HistoryAddVariable, etc. For file, title, source, institution, origin, interval, conventions, gt_version, dims, dimsizes, longnames, units, xtypes, see HistoryCreate.

For title, source, institution, origin, interval, conventions, gt_version, "unknown" is returned if values are not available.

dims, dimsizes, longnames, units, xtypes return values via pointer; pass null pointers.

axes and varinfo return axis and variable information respectively.

HistoryInquire is a generic name for two subroutines.

Parameters

[in]	history	History handle
[out]	err	Error flag (optional)
[out]	file	Output file name (optional)
[out]	title	Title (optional)
[out]	source	Source (optional)
[out]	institution	Institution (optional)
[out]	origin	Origin time (optional)
[out]	interval	Output interval (optional)
[out]	newest	Newest time (optional)
[out]	oldest	Oldest time (optional)
[out]	conventions	Conventions (optional)
[out]	gt_version	gt_version (optional)
[out]	dims	Dimension names (pointer, optional)
[out]	dimsizes	Dimension sizes (pointer, optional)
[out]	longnames	Long names (pointer, optional)
[out]	units	Units (pointer, optional)
[out]	xtypes	Types (pointer, optional)
[out]	axes	Axis information (pointer, optional)
[out]	varinfo	Variable information (pointer, optional)

Definition at line 95 of file historyinquire.f90.

    !
    use gtool_history_types, only: gt_history, gt_history_axis, gt_history_varinfo
    use gtdata_generic, only: inquire, get_attr, open, close
    use gtdata_types, only: gt_variable
    use dc_url, only: urlsplit
    use dc_error, only: storeerror, dc_noerr, gt_ebadhistory, nf90_enotvar
    use dc_trace, only: beginsub, endsub
    use dc_types, only: string, token
    implicit none
    type(GT_HISTORY), intent(in):: history
    logical, intent(out), optional :: err
    character(*), intent(out), optional:: file, title, source, institution
    real,intent(out), optional:: origin, interval
    real,intent(out), optional:: newest ! 最新の時刻
    real,intent(out), optional:: oldest ! 最初の時刻
    character(*), intent(out), optional:: conventions, gt_version
    character(*), pointer, optional:: dims(:) ! (out)
    integer,pointer, optional:: dimsizes(:) ! (out)
    character(*), pointer, optional:: longnames(:) ! (out)
    character(*), pointer, optional:: units(:) ! (out)
    character(*), pointer, optional:: xtypes(:) ! (out)
    type(GT_HISTORY_AXIS), pointer, optional :: axes(:) ! (out)
    type(GT_HISTORY_VARINFO), pointer, optional :: varinfo(:) ! (out)
 
    ! Internal Work
    character(STRING)      :: url, cause_c
    character(TOKEN)       :: unknown_mes = 'unknown'
    integer          :: i, j, numdims, numvars, alldims, stat
    logical                :: growable
    type(GT_VARIABLE)      :: dimvar
    character(*), parameter:: subname = "HistoryInquire1"
  continue
    call beginsub(subname)
    stat = dc_noerr
    cause_c =  ''
    if (.not. associated(history % dimvars) .or. &
      & size(history % dimvars) < 1) then
      stat = gt_ebadhistory
      goto 999
    end if
 
    if (present(file)) then
      call inquire(history % dimvars(1), url=url)
      call urlsplit(fullname=url, file=file)
    end if
    if (present(title)) then
      call get_attr(history % dimvars(1), '+title', title, trim(unknown_mes))
    end if
    if (present(source)) then
      call get_attr(history % dimvars(1), '+source', source, trim(unknown_mes))
    end if
    if (present(institution)) then
      call get_attr(history % dimvars(1), '+institution', institution, trim(unknown_mes))
    end if
 
    if (present(origin)) then
      origin = real(history % origin, kind=kind(origin))
!      origin = EvalByUnit( history % origin, '', history % unlimited_units_symbol )
    end if
    if (present(interval)) then
      interval = real(history % interval, kind=kind(interval))
!      interval = EvalByUnit( history % interval, '', history % unlimited_units_symbol )
    end if
    if (present(newest)) then
      newest = real(history % newest, kind=kind(newest))
!      newest = EvalByUnit( history % newest, '', history % unlimited_units_symbol )
    end if
    if (present(oldest)) then
      oldest = real(history % oldest, kind=kind(oldest))
!      oldest = EvalByUnit( history % oldest, '', history % unlimited_units_symbol )
    end if
    if (present(conventions)) then
      call get_attr(history % dimvars(1), '+Conventions', conventions, trim(unknown_mes))
    end if
    if (present(gt_version)) then
      call get_attr(history % dimvars(1), '+gt_version', gt_version, trim(unknown_mes))
    end if
    if (present(dims)) then
      numdims = size(history % dimvars)
      allocate(dims(numdims))
      do i = 1, numdims
        call inquire(history % dimvars(i), name=dims(i))
      end do
    end if
    if (present(dimsizes)) then
      numdims = size(history % dimvars)
      allocate(dimsizes(numdims))
      do i = 1, numdims
        call inquire(history % dimvars(i), size=dimsizes(i), growable=growable)
        if (growable) dimsizes(i) = 0
      end do
    end if
    if (present(longnames)) then
      numdims = size(history % dimvars)
      allocate(longnames(numdims))
      do i = 1, numdims
        call get_attr(history % dimvars(i), 'long_name', &
          & longnames(i), 'unknown')
      end do
    end if
    if (present(units)) then
      numdims = size(history % dimvars)
      allocate(units(numdims))
      do i = 1, numdims
        call get_attr(history % dimvars(i), 'units', &
          & units(i), 'unknown')
      end do
    end if
    if (present(xtypes)) then
      numdims = size(history % dimvars)
      allocate(xtypes(numdims))
      do i = 1, numdims
        call inquire(history % dimvars(i), xtype=xtypes(i))
      end do
    end if
    if (present(axes)) then
      numvars = size(history % dimvars)
      allocate(axes(numvars))
      do i = 1, numvars
        call inquire(history % dimvars(i), &
          & allcount=axes(i) % length, &
          & xtype=axes(i) % xtype, name=axes(i) % name)
        call get_attr(history % dimvars(i), 'long_name', &
          & axes(i) % longname, 'unknown')
        call get_attr(history % dimvars(i), 'units', &
          & axes(i) % units, 'unknown')
 
        ! 属性 GT_HISTORY_ATTR はまだ取得できない
        !
        ! するためには, 属性名に対して様々な型が存在しうると
        ! 考えられるため, get_attr (gtdata_generic および gtdata_netcdf_generic)
        ! に err 属性を装備させ, 取得できない際にエラーを
        ! 返してもらわなければならないだろう.
 
      end do
    end if
 
    if (present(varinfo)) then
       if (.not. associated(history % vars) ) then
        stat = nf90_enotvar
        goto 999
      end if
      if ( size(history % vars) < 1) then
        stat = nf90_enotvar
        goto 999
      end if
      numvars = size(history % vars)
      allocate(varinfo(numvars))
      do i = 1, numvars
        call inquire(history % vars(i), alldims=alldims, &
          & xtype=varinfo(i) % xtype, name=varinfo(i) % name)
        call get_attr(history % vars(i), 'long_name', &
          & varinfo(i) % longname, 'unknown')
        call get_attr(history % vars(i), 'units', &
          & varinfo(i) % units, 'unknown')
 
        ! 属性 GT_HISTORY_ATTR はまだ取得できない
        !
        ! するためには, 属性名に対して様々な型が存在しうると
        ! 考えられるため, get_attr (gtdata_generic および gtdata_netcdf_generic)
        ! に err 属性を装備させ, 取得できない際にエラーを
        ! 返してもらわなければならないだろう.
 
        allocate(varinfo(i) % dims(alldims))
        do j = 1, alldims
          call open(var=dimvar, source_var=history % vars(i), &
            & dimord=j, count_compact=.true.)
          call inquire(dimvar, name=varinfo(i) % dims(j))
          call close(dimvar)
        end do
 
        varinfo(i) % initialized = .true.
 
      end do
    end if
999 continue
    call storeerror(stat, subname, err, cause_c=cause_c)
    call endsub(subname)

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

Here is the call graph for this function:

historyinquire2()

subroutine historyinquire2	(	character(*), intent(in)	history,
		logical, intent(out), optional	err,
		character(*), intent(out), optional	file,
		character(*), intent(out), optional	title,
		character(*), intent(out), optional	source,
		character(*), dimension(:), optional, pointer	dims,
		integer, dimension(:), optional, pointer	dimsizes,
		character(*), dimension(:), optional, pointer	longnames,
		character(*), dimension(:), optional, pointer	units,
		character(*), dimension(:), optional, pointer	xtypes,
		character(*), intent(out), optional	institution,
		real, intent(out), optional	origin,
		real, intent(out), optional	interval,
		real, intent(out), optional	newest,
		real, intent(out), optional	oldest,
		character(*), intent(out), optional	conventions,
		character(*), intent(out), optional	gt_version,
		type(gt_history_axis), dimension(:), optional, pointer	axes,
		type(gt_history_varinfo), dimension(:), optional, pointer	varinfo
	)

Inquire a GT_HISTORY variable (character interface)

Use this subroutine for inquiries when history was not specified in HistoryCreate. Pass the string "default" to history.

Definition at line 295 of file historyinquire.f90.

    use gtool_history_types, only: gt_history, gt_history_axis, gt_history_varinfo
    use gtool_history_internal, only: default
    use gtool_history_generic, only: historyinquire
    use dc_error, only: storeerror, dc_noerr, nf90_einval
    use dc_trace, only: beginsub, endsub
    use dc_types, only: string
    implicit none
    character(*), intent(in):: history
    logical, intent(out), optional :: err
    character(*), intent(out), optional:: file, title, source, institution
    real,intent(out), optional:: origin, interval, newest, oldest
    character(*), intent(out), optional:: conventions, gt_version
    character(*), pointer, optional:: dims(:) ! (out)
    integer,pointer, optional:: dimsizes(:) ! (out)
    character(*), pointer, optional:: longnames(:) ! (out)
    character(*), pointer, optional:: units(:) ! (out)
    character(*), pointer, optional:: xtypes(:) ! (out)
    type(GT_HISTORY_AXIS), pointer, optional :: axes(:) ! (out)
    type(GT_HISTORY_VARINFO), pointer, optional :: varinfo(:) ! (out)
    integer:: stat
    character(STRING):: cause_c
    character(*), parameter:: subname = "HistoryInquire2"
  continue
    call beginsub(subname, "history=%c", c1=trim(history))
    stat = dc_noerr
    cause_c = ''
    if (trim(history) /= 'default') then
      stat = nf90_einval
      cause_c = 'history="' // trim(history) // '"'
      goto 999
    end if
    call historyinquire(default, err, file, title, source, &
      & dims, dimsizes, longnames, units, xtypes, &
      & institution, origin, interval, newest, oldest, &
      & conventions, gt_version, &
      & axes, varinfo )
999 continue
    call storeerror(stat, subname, cause_c=cause_c)
    call endsub(subname)

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

Here is the call graph for this function:

historyinquire3()

subroutine historyinquire3	(	type(gt_history), intent(in)	history,
		logical, intent(out), optional	err,
		character(*), intent(out), optional	file,
		character(*), intent(out), optional	title,
		character(*), intent(out), optional	source,
		character(*), dimension(:), optional, pointer	dims,
		integer, dimension(:), optional, pointer	dimsizes,
		character(*), dimension(:), optional, pointer	longnames,
		character(*), dimension(:), optional, pointer	units,
		character(*), dimension(:), optional, pointer	xtypes,
		character(*), intent(out), optional	institution,
		real, intent(out), optional	origin,
		real, intent(out), optional	interval,
		real, intent(out), optional	newest,
		real, intent(out), optional	oldest,
		character(*), intent(out), optional	conventions,
		character(*), intent(out), optional	gt_version,
		type(gt_history_axis), dimension(:), optional, pointer	axes,
		type(gt_history_varinfo), dimension(:), optional, pointer	varinfo
	)

Inquire a GT_HISTORY variable (generic interface)

Usage is same as HistoryInquire.

Definition at line 353 of file historyinquire.f90.

    use gtool_history_types, only: gt_history, gt_history_axis, gt_history_varinfo
    use gtool_history_generic, only: historyinquire
    use dc_trace, only: beginsub, endsub
    implicit none
    type(GT_HISTORY), intent(in):: history
    logical, intent(out), optional :: err
    character(*), intent(out), optional:: file, title, source, institution
    real,intent(out), optional:: origin, interval
    real,intent(out), optional:: newest ! 最新の時刻
    real,intent(out), optional:: oldest ! 最初の時刻
    character(*), intent(out), optional:: conventions, gt_version
    character(*), pointer, optional:: dims(:) ! (out)
    integer,pointer, optional:: dimsizes(:) ! (out)
    character(*), pointer, optional:: longnames(:) ! (out)
    character(*), pointer, optional:: units(:) ! (out)
    character(*), pointer, optional:: xtypes(:) ! (out)
    type(GT_HISTORY_AXIS), pointer, optional :: axes(:) ! (out)
    type(GT_HISTORY_VARINFO), pointer, optional :: varinfo(:) ! (out)
 
    character(*), parameter:: subname = "HistoryInquire3"
  continue
    call beginsub(subname)
    call historyinquire(history, err, file, title, source, &
      & dims, dimsizes, longnames, units, xtypes, &
      & institution, origin, interval, newest, oldest, &
      & conventions, gt_version, &
      & axes, varinfo )
    call endsub(subname)

References dc_trace::beginsub(), and dc_trace::endsub().

Here is the call graph for this function:

historyinquire4()

subroutine historyinquire4	(	character(*), intent(in)	history,
		logical, intent(out), optional	err,
		character(*), intent(out), optional	file,
		character(*), intent(out), optional	title,
		character(*), intent(out), optional	source,
		character(*), dimension(:), optional, pointer	dims,
		integer, dimension(:), optional, pointer	dimsizes,
		character(*), dimension(:), optional, pointer	longnames,
		character(*), dimension(:), optional, pointer	units,
		character(*), dimension(:), optional, pointer	xtypes,
		character(*), intent(out), optional	institution,
		real, intent(out), optional	origin,
		real, intent(out), optional	interval,
		real, intent(out), optional	newest,
		real, intent(out), optional	oldest,
		character(*), intent(out), optional	conventions,
		character(*), intent(out), optional	gt_version,
		type(gt_history_axis), dimension(:), optional, pointer	axes,
		type(gt_history_varinfo), dimension(:), optional, pointer	varinfo
	)

Inquire a GT_HISTORY variable (generic interface)

Usage is same as HistoryInquire.

Definition at line 400 of file historyinquire.f90.

    use gtool_history_types, only: gt_history, gt_history_axis, gt_history_varinfo
    use gtool_history_generic, only: historyinquire
    use dc_trace, only: beginsub, endsub
    implicit none
    character(*), intent(in):: history
    logical, intent(out), optional :: err
    character(*), intent(out), optional:: file, title, source, institution
    real,intent(out), optional:: origin, interval, newest, oldest
    character(*), intent(out), optional:: conventions, gt_version
    character(*), pointer, optional:: dims(:) ! (out)
    integer,pointer, optional:: dimsizes(:) ! (out)
    character(*), pointer, optional:: longnames(:) ! (out)
    character(*), pointer, optional:: units(:) ! (out)
    character(*), pointer, optional:: xtypes(:) ! (out)
    type(GT_HISTORY_AXIS), pointer, optional :: axes(:) ! (out)
    type(GT_HISTORY_VARINFO), pointer, optional :: varinfo(:) ! (out)
    character(*), parameter:: subname = "HistoryInquire4"
  continue
    call beginsub(subname)
    call historyinquire(history, err, file, title, source, &
      & dims, dimsizes, longnames, units, xtypes, &
      & institution, origin, interval, newest, oldest, &
      & conventions, gt_version, &
      & axes, varinfo )
    call endsub(subname)

References dc_trace::beginsub(), and dc_trace::endsub().

Here is the call graph for this function: