ESMF_AlarmSetInitCreated Subroutine

public subroutine ESMF_AlarmSetInitCreated(alarm, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Alarm), intent(inout) :: alarm
integer, intent(out), optional :: rc

Called by

proc~~esmf_alarmsetinitcreated~~CalledByGraph proc~esmf_alarmsetinitcreated ESMF_AlarmSetInitCreated proc~esmf_alarmcreatecopy ESMF_AlarmCreateCopy proc~esmf_alarmcreatecopy->proc~esmf_alarmsetinitcreated proc~esmf_alarmcreatenew ESMF_AlarmCreateNew proc~esmf_alarmcreatenew->proc~esmf_alarmsetinitcreated proc~esmf_alarmreadrestart ESMF_AlarmReadRestart proc~esmf_alarmreadrestart->proc~esmf_alarmsetinitcreated proc~esmf_clockadvance ESMF_ClockAdvance proc~esmf_clockadvance->proc~esmf_alarmsetinitcreated proc~esmf_clockgetalarm ESMF_ClockGetAlarm proc~esmf_clockgetalarm->proc~esmf_alarmsetinitcreated proc~esmf_clockgetalarmlist ESMF_ClockGetAlarmList proc~esmf_clockgetalarmlist->proc~esmf_alarmsetinitcreated

Source Code

      subroutine ESMF_AlarmSetInitCreated(alarm, rc)
!
! !ARGUMENTS:
      type(ESMF_Alarm), intent(inout)         :: alarm
      integer,          intent(out), optional :: rc  
!         
!
! !DESCRIPTION:
!     Set init code in Alarm object to "CREATED".
!
!     The arguments are:
!     \begin{description}
!     \item[alarm] 
!          Specified {\tt ESMF\_Alarm} object.
!     \item[{[rc]}] 
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOPI
!------------------------------------------------------------------------------

      ! Assume failure until success
      if (present(rc)) rc = ESMF_RC_NOT_IMPL
    
      ! Set init code
      ESMF_INIT_SET_CREATED(alarm)

      ! Return success
      if (present(rc)) rc = ESMF_SUCCESS
    
      end subroutine ESMF_AlarmSetInitCreated