dccalparseunit.f90

Go to the documentation of this file.

! -*- mode: f90; coding: utf-8 -*-
!-----------------------------------------------------------------------
! Copyright (c) 2000-2026 Gtool Development Group. All rights reserved.
!-----------------------------------------------------------------------
!>
!> @author    Yasuhiro MORIKAWA
!> @copyright Copyright (C) GFD Dennou Club, 2009-2026. All rights reserved. <br/>
!>            License is BSD-2-Clause. see [COPYRIGHT](@ref COPYRIGHT) in detail
!> @en
!> @brief Parse units
!> @details
!> Procedures described in this file are provided from "dc_calendar" module.
!> @enden
!>
!> @ja
!> @brief 単位の解釈
!> @details
!> このファイルに記載される手続き群は dc_calendar モジュールから提供されます.
!> @endja
!>
 
!> @en
!> @brief Parse character variable of units into integer symbol
!> @details
!> Parse a character variable of units of date `unit_str`, and
!> return an integer variable of units of date `unit_sym`.
!> Valid strings as `unit_str` are as follows.
!>
!> | String constants             | Description      |
!> |------------------------------|------------------|
!> | dc_calendar_types#UNIT_SEC   | Units of second  |
!> | dc_calendar_types#UNIT_MIN   | Units of minute  |
!> | dc_calendar_types#UNIT_HOUR  | Units of hour    |
!> | dc_calendar_types#UNIT_DAY   | Units of day     |
!> | dc_calendar_types#UNIT_MONTH | Units of month   |
!> | dc_calendar_types#UNIT_YEAR  | Units of year    |
!>
!> When a valid string is specified, an integer corresponding
!> one of following variables is returned to `unit_sym`.
!>
!> | Symbol constants                    | Description      |
!> |-------------------------------------|------------------|
!> | dc_calendar_types#UNIT_SYMBOL_SEC   | Units of second  |
!> | dc_calendar_types#UNIT_SYMBOL_MIN   | Units of minute  |
!> | dc_calendar_types#UNIT_SYMBOL_HOUR  | Units of hour    |
!> | dc_calendar_types#UNIT_SYMBOL_DAY   | Units of day     |
!> | dc_calendar_types#UNIT_SYMBOL_MONTH | Units of month   |
!> | dc_calendar_types#UNIT_SYMBOL_YEAR  | Units of year    |
!>
!> If an invalid string is specified an error is caused.
!>
!> @param[in]  unit_str Character variable of date units
!> @param[out] unit_sym Integer variable of date units (symbol)
!> @param[out] err      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.
!> @enden
!>
!> @ja
!> @brief 文字列変数の日時単位を整数型シンボルに変換
!> @details
!> 文字列変数の日時単位 `unit_str` を整数型変数の日時単位
!> `unit_sym` に変換します.
!> `unit_str` として有効な文字列は以下の通りです.
!>
!> | 文字列定数                   | 説明     |
!> |------------------------------|----------|
!> | dc_calendar_types#UNIT_SEC   | 秒の単位 |
!> | dc_calendar_types#UNIT_MIN   | 分の単位 |
!> | dc_calendar_types#UNIT_HOUR  | 時間の単位 |
!> | dc_calendar_types#UNIT_DAY   | 日の単位 |
!> | dc_calendar_types#UNIT_MONTH | 月の単位 |
!> | dc_calendar_types#UNIT_YEAR  | 年の単位 |
!>
!> 有効な文字列が与えられた場合, `unit_sym` に以下の変数に相当する
!> 整数が返ります.
!>
!> | シンボル定数                        | 説明     |
!> |-------------------------------------|----------|
!> | dc_calendar_types#UNIT_SYMBOL_SEC   | 秒の単位 |
!> | dc_calendar_types#UNIT_SYMBOL_MIN   | 分の単位 |
!> | dc_calendar_types#UNIT_SYMBOL_HOUR  | 時間の単位 |
!> | dc_calendar_types#UNIT_SYMBOL_DAY   | 日の単位 |
!> | dc_calendar_types#UNIT_SYMBOL_MONTH | 月の単位 |
!> | dc_calendar_types#UNIT_SYMBOL_YEAR  | 年の単位 |
!>
!> 無効な値が与えられた場合, エラーを生じます.
!>
!> @param[in]  unit_str 日時単位の文字列変数
!> @param[out] unit_sym 日時単位の整数型変数 (シンボル)
!> @param[out] err      例外処理用フラグ.
!>                      デフォルトでは, この手続き内でエラーが生じた場合,
!>                      プログラムは強制終了します.
!>                      引数 `err` が与えられる場合, プログラムは強制終了せず,
!>                      代わりに `err` に .true. が代入されます.
!> @endja
subroutine dccalparseunit1( unit_str, unit_sym, err )
 
  use dc_calendar_types, only: unit_symbol_err
  use dc_calendar_internal, only: dccaldate_str2usym
  use dc_message, only: messagenotify
  use dc_string, only: lchar
  use dc_trace, only: beginsub, endsub
  use dc_error, only: storeerror, dc_noerr, dc_ebadunit
  use dc_types, only: string
  implicit none
  character(*), intent(in):: unit_str
  integer, intent(out):: unit_sym
  logical, intent(out), optional:: err
 
  ! 作業変数
  ! Work variables
  !
  integer:: stat
  character(STRING):: cause_c
  character(*), parameter:: subname = 'DCCalParseUnit1'
continue
  call beginsub( subname )
  stat = dc_noerr
  cause_c = ''
 
  ! 単位の文字列をシンボル (整数型変数) に変換
  ! Convert strings of units into symbols (integer variables)
  !
  unit_sym = dccaldate_str2usym( unit_str )
 
  ! エラー処理
  ! Error Handling
  !
  if ( unit_sym == unit_symbol_err ) then
    call messagenotify('W', subname, 'unit_str=<%c> is invalid. (ONLY day,hour,min,sec are valid)', &
      & c1 = trim(unit_str) )
    stat = dc_ebadunit
    goto 999
  end if
 
  ! 終了処理, 例外処理
  ! Termination and Exception handling
  !
999 continue
  call storeerror( stat, subname, err, cause_c )
  call endsub( subname )
end subroutine dccalparseunit1