subroutine ESMF_AlarmNotSticky(alarm, keywordEnforcer, &
ringDuration, ringTimeStepCount, rc)
! !ARGUMENTS:
type(ESMF_Alarm), intent(inout) :: alarm
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
type(ESMF_TimeInterval), intent(in), optional :: ringDuration
integer, intent(in), optional :: ringTimeStepCount
integer, intent(out), optional :: rc
!
! !STATUS:
! \begin{itemize}
! \item\apiStatusCompatibleVersion{5.2.0r}
! \end{itemize}
!
! !DESCRIPTION:
! Unset an {\tt ESMF\_Alarm}'s sticky flag; once alarm is ringing,
! it turns itself off after ringDuration.
!
! The arguments are:
! \begin{description}
! \item[alarm]
! The object instance to unset sticky.
! \item[{[ringDuration]}]
! If not sticky, alarms rings for ringDuration, then turns itself off.
! Mutually exclusive with ringTimeStepCount (see below and full
! description in method {\tt ESMF\_AlarmCreate()} or
! {\tt ESMF\_AlarmSet()}).
! \item[{[ringTimeStepCount]}]
! \begin{sloppypar}
! If not sticky, alarms rings for ringTimeStepCount, then turns
! itself off. Mutually exclusive with ringDuration (see above and
! full description in method {\tt ESMF\_AlarmCreate()} or
! {\tt ESMF\_AlarmSet()}).
! \end{sloppypar}
! \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 inputs
ESMF_INIT_CHECK_DEEP(ESMF_AlarmGetInit,alarm,rc)
ESMF_INIT_CHECK_SHALLOW(ESMF_TimeIntervalGetInit,ringDuration,rc)
! invoke C to C++ entry point
call c_ESMC_AlarmNotSticky(alarm, ringDuration, &
ringTimeStepCount, localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
! Return success
if (present(rc)) rc = ESMF_SUCCESS
end subroutine ESMF_AlarmNotSticky