dccaldatecreate.f90 File Reference

Go to the source code of this file.

Functions/Subroutines
subroutine	dccaldatecreate1 (year, month, day, hour, min, sec, date, zone, err)
	Date setting procedures.
subroutine	dccaldatecreate2 (date_str, date, err)

Function/Subroutine Documentation

dccaldatecreate1()

subroutine dccaldatecreate1	(	integer, intent(in)	year,
		integer, intent(in)	month,
		integer, intent(in)	day,
		integer, intent(in)	hour,
		integer, intent(in)	min,
		real(dp), intent(in)	sec,
		type(dc_cal_date), intent(out), optional, target	date,
		character(*), intent(in), optional	zone,
		logical, intent(out), optional	err )

Date setting procedures.

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.

Set date with individual variables

Set date.

If a string like as "YYYY-MM-DDThh:mm:ss.sTZD" (YYYY is year, MM is month, DD is day, hh is hour, mm is minute, ss.s is second, TZD is time zone) is used, use a following homonymous subroutine.

If an optional argument date is omitted, the date setting is stored to a "dc_calendar_types#DC_CAL_DATE" variable that is saved in the "dc_calendar". When date is omitted in subsequent procedures, the internal date is used. If date is not omitted, the settings is stored to the date. In order to use the date setting, use the "dc_calendar_types#DC_CAL_DATE" variable to subsequent procedures.

Parameters

[in]	year	Year
[in]	month	Month
[in]	day	Day
[in]	hour	Hour
[in]	min	Minute
[in]	sec	Second
[out]	date	An object that stores information of date and time. If this is omitted, these information is set as default date and time.
[in]	zone	Time-zone (difference from UTC)
[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 89 of file dccaldatecreate.f90.

 
  use dc_calendar_types, only: dc_cal_date
  use dc_calendar_internal, only: default_date
  use dc_regex, only: match
  use dc_message, only: messagenotify
  use dc_string, only: lchar
  use dc_trace, only: beginsub, endsub
  use dc_error, only: storeerror, dc_noerr, dc_ebaddate
  use dc_types, only: string, dp
  implicit none
  integer, intent(in):: year
  integer, intent(in):: month
  integer, intent(in):: day
  integer, intent(in):: hour
  integer, intent(in):: min
  real(DP), intent(in):: sec
  type(DC_CAL_DATE), intent(out), optional, target:: date
  character(*), intent(in), optional:: zone
  logical, intent(out), optional:: err
 
  ! 作業変数
  ! Work variables
  !
  type(DC_CAL_DATE), pointer:: datep =>null()
  integer:: start, length
  integer:: stat
  character(STRING):: cause_c
  character(*), parameter:: version = &
    & '$Name:  $' // &
    & '$Id: dccaldatecreate.f90,v 1.3 2010-09-24 07:07:31 morikawa Exp $'
  character(*), parameter:: subname = 'DCCalDateCreate1'
continue
  call beginsub( subname, version )
  stat = dc_noerr
  cause_c = ''
 
  ! オブジェクトのポインタ割付
  ! Associate pointer of an object
  !
  if ( present( date ) ) then
    datep => date
  else
    datep => default_date
  end if
 
!!$  ! 初期設定のチェック
!!$  ! Check initialization
!!$  !
!!$  if ( datep % initialized ) then
!!$    stat = DC_EALREADYINIT
!!$    cause_c = 'DC_CAL_DATE'
!!$    goto 999
!!$  end if
 
  ! 日時の正当性のチェック
  ! Validate date and time
  !
!!$  if ( year < 1 ) then
!!$    stat = DC_EBADDATE
!!$    call MessageNotify('W', subname, 'year=<%d> must be natural number', &
!!$      & i = (/ year /) )
!!$    goto 999
!!$  end if
 
  if ( month < 1 ) then
    stat = dc_ebaddate
    call messagenotify('W', subname, 'month=<%d> must be natural number', &
      & i = (/ month /) )
    goto 999
  end if
 
  if ( day < 1 ) then
    stat = dc_ebaddate
    call messagenotify('W', subname, 'day=<%d> must be natural number', &
      & i = (/ day /) )
    goto 999
  end if
 
  if ( hour < 0 ) then
    stat = dc_ebaddate
    call messagenotify('W', subname, 'hour=<%d> must not be negative', &
      & i = (/ hour /) )
    goto 999
  end if
 
  if ( min < 0 ) then
    stat = dc_ebaddate
    call messagenotify('W', subname, 'min=<%d> must not be negative', &
      & i = (/ min /) )
    goto 999
  end if
 
  if ( sec < 0.0_dp ) then
    stat = dc_ebaddate
    call messagenotify('W', subname, 'sec=<%f> must not be negative', &
      & d = (/ sec /) )
    goto 999
  end if
 
  call match( '^[#+-]#d+:#d+$', zone, & ! (in)
    &         start, length )           ! (out)
  if ( length > 0 ) then
    datep % zone = zone
  else
    datep % zone = ''
  end if
 
  ! 各要素への値の設定
  ! Configure elements
  !
  datep % year  = year
  datep % month = month
  datep % day   = day
  datep % hour  = hour
  datep % min   = min
  datep % sec   = sec
 
  ! 終了処理, 例外処理
  ! Termination and Exception handling
  !
  datep % initialized = .true.
999 continue
  nullify( datep )
  call storeerror( stat, subname, err, cause_c )
  call endsub( subname )

References dc_trace::beginsub(), dc_error::dc_ebaddate, dc_error::dc_noerr, dc_calendar_internal::default_date, dc_types::dp, dc_trace::endsub(), dc_regex::match(), dc_error::storeerror(), and dc_types::string.

Here is the call graph for this function:

dccaldatecreate2()

subroutine dccaldatecreate2	(	character(*), intent(in)	date_str,
		type(dc_cal_date), intent(out), optional, target	date,
		logical, intent(out), optional	err )

Set date with date string

Set date.

Specify a string like as "YYYY-MM-DDThh:mm:ss.sTZD" (YYYY is year, MM is month, DD is day, hh is hour, mm is minute, ss.s is second, TZD is time zone) to date_str. If individual variables (year, month, day, hour, minute, second, zone) are used, use a foregoing homonymous subroutine. Format of date is conformed to gtool4 netCDF Convention "5.5 Expression of date and time"

If a string like as "s since 2009-06-17T11:23:45+09:00" is specified, A part "s since " is truncated automatically, and a part "2009-06-17T11:23:45+09:00" is set.

If an optional argument date is omitted, the date setting is stored to a "dc_calendar_types#DC_CAL_DATE" variable that is saved in the "dc_calendar". When date is omitted in subsequent procedures, the internal date is used. If date is not omitted, the settings is stored to the date. In order to use the date setting, use the "dc_calendar_types#DC_CAL_DATE" variable to subsequent procedures.

Parameters

[in]	date_str	Strings that express date and time. See gtool4 netCDF Convention 5.5 Expression of date and time for details.
[out]	date	An object that stores information of date and time. If this is omitted, these information is set as default date and time.
[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 287 of file dccaldatecreate.f90.

  use dc_calendar_generic, only: dccaldateparsestr, dccaldatecreate
  use dc_calendar_types, only: dc_cal_date
  use dc_calendar_internal, only: default_date
  use dc_message, only: messagenotify
  use dc_types, only: dp, token
  use dc_trace, only: beginsub, endsub
  use dc_error, only: storeerror, dc_noerr, dc_ebaddate
  use dc_types, only: string
  implicit none
  character(*), intent(in):: date_str
  type(DC_CAL_DATE), intent(out), optional, target:: date
  logical, intent(out), optional:: err
 
  ! 作業変数
  ! Work variables
  !
  type(DC_CAL_DATE), pointer:: datep =>null()
  integer:: year
  integer:: month
  integer:: day
  integer:: hour
  integer:: min
  real(DP):: sec
  character(TOKEN):: zone
  integer:: stat
  character(STRING):: cause_c
  character(*), parameter:: version = &
    & '$Name:  $' // &
    & '$Id: dccaldatecreate.f90,v 1.3 2010-09-24 07:07:31 morikawa Exp $'
  character(*), parameter:: subname = 'DCCalDateCreate2'
continue
  call beginsub( subname, version )
  stat = dc_noerr
  cause_c = ''
 
  ! オブジェクトのポインタ割付
  ! Associate pointer of an object
  !
  if ( present( date ) ) then
    datep => date
  else
    datep => default_date
  end if
 
!!$  ! 初期設定のチェック
!!$  ! Check initialization
!!$  !
!!$  if ( datep % initialized ) then
!!$    stat = DC_EALREADYINIT
!!$    cause_c = 'DC_CAL_DATE'
!!$    goto 999
!!$  end if
 
  ! 日時を表現した文字列の解釈
  ! Parse strings that express date and time
  !
  call dccaldateparsestr( date_str, &           ! (in)
    & year, month, day, hour, min, sec, zone, & ! (out)
    & err = err )                               ! (out) optional
  if ( present(err) ) then
    if ( err ) then
      stat = dc_ebaddate
      goto 999
    end if
  end if
 
  ! オブジェクトの作成
  ! Create an object
  !
  call dccaldatecreate( &
    & year, month, day, hour, min, sec, & ! (in)
    & datep, zone, err = err )            ! (out) optional
  if ( present(err) ) then
    if ( err ) then
      stat = dc_ebaddate
      goto 999
    end if
  end if
 
  ! 終了処理, 例外処理
  ! Termination and Exception handling
  !
999 continue
  nullify( datep )
  call storeerror( stat, subname, err, cause_c )
  call endsub( subname )

References dc_trace::beginsub(), dc_error::dc_ebaddate, dc_error::dc_noerr, dc_calendar_internal::default_date, dc_types::dp, dc_trace::endsub(), dc_error::storeerror(), dc_types::string, and dc_types::token.

Here is the call graph for this function: