Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_Clock), | intent(in) | :: | clock | |||
type(ESMF_KeywordEnforcer), | optional | :: | keywordEnforcer | |||
integer, | intent(out), | optional | :: | rc |
function ESMF_ClockIsReverse(clock, keywordEnforcer, rc) ! ! !RETURN VALUE: logical :: ESMF_ClockIsReverse ! !ARGUMENTS: type(ESMF_Clock), intent(in) :: clock type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below integer, intent(out), optional :: rc ! ! !STATUS: ! \begin{itemize} ! \item\apiStatusCompatibleVersion{5.2.0r} ! \end{itemize} ! ! !DESCRIPTION: ! Returns true if clock is in {\tt ESMF\_DIRECTION\_REVERSE}, and false if ! in {\tt ESMF\_DIRECTION\_FORWARD}. Allows convenient use in "if" and ! "do while" constructs. Alternative to ! {\tt ESMF\_ClockGet(...direction=...)}. ! ! The arguments are: ! \begin{description} ! \item[clock] ! The object instance to check. ! \item[{[rc]}] ! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors. ! \end{description} !EOP ! !REQUIREMENTS: ! TMG3.4.6 integer :: localrc ! local return code ! Assume failure until success if (present(rc)) rc = ESMF_RC_NOT_IMPL localrc = ESMF_RC_NOT_IMPL ! Initialize output value in case of error ESMF_ClockIsReverse = .false. ! check input ESMF_INIT_CHECK_DEEP(ESMF_ClockGetInit,clock,rc) ! invoke C to C++ entry point call c_ESMC_ClockIsReverse(clock, ESMF_ClockIsReverse, localrc) if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, & ESMF_CONTEXT, rcToReturn=rc)) return ! Return success if (present(rc)) rc = ESMF_SUCCESS end function ESMF_ClockIsReverse