Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_Clock), | intent(inout) | :: | clock | |||
type(ESMF_KeywordEnforcer), | optional | :: | keywordEnforcer | |||
type(ESMF_Time), | intent(in), | optional | :: | stopTime | ||
integer, | intent(out), | optional | :: | rc |
subroutine ESMF_ClockStopTimeEnable(clock, keywordEnforcer, stopTime, rc) ! !ARGUMENTS: type(ESMF_Clock), intent(inout) :: clock type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below type(ESMF_Time), intent(in), optional :: stopTime integer, intent(out), optional :: rc ! ! !STATUS: ! \begin{itemize} ! \item\apiStatusCompatibleVersion{5.2.0r} ! \end{itemize} ! ! !DESCRIPTION: ! Enables a {\tt ESMF\_Clock}'s stop time, allowing ! {\tt ESMF\_ClockIsStopTime()} to respect the stopTime. ! ! The arguments are: ! \begin{description} ! \item[clock] ! The object instance whose stop time to enable. ! \item[{[stopTime]}] ! The stop time to set or reset. ! \item[{[rc]}] ! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors. ! \end{description} !EOP ! !REQUIREMENTS: ! TMGx.x, WRF integer :: localrc ! local return code ! Assume failure until success if (present(rc)) rc = ESMF_RC_NOT_IMPL localrc = ESMF_RC_NOT_IMPL ! check inputs ESMF_INIT_CHECK_DEEP(ESMF_ClockGetInit,clock,rc) ESMF_INIT_CHECK_SHALLOW(ESMF_TimeGetInit,stopTime,rc) ! invoke C to C++ entry point call c_ESMC_ClockStopTimeEnable(clock, stopTime, localrc) if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, & ESMF_CONTEXT, rcToReturn=rc)) return ! Return success if (present(rc)) rc = ESMF_SUCCESS end subroutine ESMF_ClockStopTimeEnable