Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_Time), | intent(in) | :: | time | |||
character(len=*), | intent(in), | optional | :: | options | ||
integer, | intent(out), | optional | :: | rc |
subroutine ESMF_TimeValidate(time, options, rc) ! !ARGUMENTS: type(ESMF_Time), intent(in) :: time character (len=*), intent(in), optional :: options integer, intent(out), optional :: rc ! ! !DESCRIPTION: ! Checks whether an {\tt ESMF\_Time} is valid. ! Must be a valid date/time on a valid calendar. ! The options control the type of validation. ! ! The arguments are: ! \begin{description} ! \item[time] ! {\tt ESMF\_Time} instant to be validated. ! \item[{[options]}] ! Validation options. If none specified, validates all {\tt time} property ! values. \\ ! "calendar" - validate only the {\tt time}'s calendar. \\ ! "timezone" - validate only the {\tt time}'s timezone. \\ ! \item[{[rc]}] ! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors. ! \end{description} ! !EOP ! !REQUIREMENTS: ! TMGn.n.n integer :: localrc ! local return code ! Assume failure until success if (present(rc)) rc = ESMF_RC_NOT_IMPL localrc = ESMF_RC_NOT_IMPL ! check input ESMF_INIT_CHECK_SHALLOW(ESMF_TimeGetInit,time,rc) ! invoke C to C++ entry point call c_ESMC_TimeValidate(time, options, localrc) if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, & ESMF_CONTEXT, rcToReturn=rc)) return ! Return success if (present(rc)) rc = ESMF_SUCCESS end subroutine ESMF_TimeValidate