dccalparseunit.f90 File Reference

Go to the source code of this file.

Functions/Subroutines
subroutine	dccalparseunit1 (unit_str, unit_sym, err)
	Parse units.

Function/Subroutine Documentation

dccalparseunit1()

subroutine dccalparseunit1	(	character(*), intent(in)	unit_str,
		integer, intent(out)	unit_sym,
		logical, intent(out), optional	err )

Parse units.

Author

Yasuhiro MORIKAWA

Copyright

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

Procedures described in this file are provided from "dc_calendar" module.

Parse character variable of units into integer symbol

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.

Parameters

[in]	unit_str	Character variable of date units
[out]	unit_sym	Integer variable of date units (symbol)
[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.

Definition at line 98 of file dccalparseunit.f90.

 
  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 )

References dc_trace::beginsub(), dc_error::dc_ebadunit, dc_error::dc_noerr, dc_calendar_internal::dccaldate_str2usym(), dc_trace::endsub(), dc_error::storeerror(), dc_types::string, and dc_calendar_types::unit_symbol_err.

Here is the call graph for this function: