Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_Clock), | intent(in) | :: | clock | |||
character(len=*), | intent(in) | :: | alarmname | |||
type(ESMF_Alarm), | intent(out) | :: | alarm | |||
type(ESMF_KeywordEnforcer), | optional | :: | keywordEnforcer | |||
integer, | intent(out), | optional | :: | rc |
subroutine ESMF_ClockGetAlarm(clock, alarmname, alarm, & keywordEnforcer, rc) ! !ARGUMENTS: type(ESMF_Clock), intent(in) :: clock character (len=*), intent(in) :: alarmname type(ESMF_Alarm), intent(out) :: alarm 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: ! Gets the {\tt alarm} whose name is the value of alarmname in the ! {\tt clock}'s {\tt ESMF\_Alarm} list. ! ! The arguments are: ! \begin{description} ! \item[clock] ! The object instance to get the {\tt ESMF\_Alarm} from. ! \item[alarmname] ! The name of the desired {\tt ESMF\_Alarm}. ! \item[alarm] ! The desired alarm. ! \item[{[rc]}] ! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors. ! \end{description} ! !EOP ! !REQUIREMENTS: ! TMGx.x ! get length of given name for C++ validation integer :: alarmnameLen, localrc ! Assume failure until success if (present(rc)) rc = ESMF_RC_NOT_IMPL localrc = ESMF_RC_NOT_IMPL ! check input ESMF_INIT_CHECK_DEEP(ESMF_ClockGetInit,clock,rc) alarmnameLen = len_trim(alarmname) ! invoke C to C++ entry point call c_ESMC_ClockGetAlarm(clock, alarmnameLen, alarmname, alarm, localrc) if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, & ESMF_CONTEXT, rcToReturn=rc)) return ! mark output as successfully initialized call ESMF_AlarmSetInitCreated(alarm) ! Return success if (present(rc)) rc = ESMF_SUCCESS end subroutine ESMF_ClockGetAlarm