ESMF_IMErrS Function

public recursive function ESMF_IMErrS(isInit, line, file, method, rc) result(IMErrS)

Arguments

Type IntentOptional Attributes Name
integer(kind=ESMF_KIND_I8), intent(in) :: isInit
integer, intent(in), optional :: line
character(len=*), intent(in), optional :: file
character(len=*), intent(in), optional :: method
integer, intent(out), optional :: rc

Return Value logical


Calls

proc~~esmf_imerrs~~CallsGraph proc~esmf_imerrs ESMF_IMErrS proc~esmf_initcheckshallow ESMF_InitCheckShallow proc~esmf_imerrs->proc~esmf_initcheckshallow proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_imerrs->proc~esmf_logfounderror esmf_breakpoint esmf_breakpoint proc~esmf_logfounderror->esmf_breakpoint proc~esmf_logrc2msg ESMF_LogRc2Msg proc~esmf_logfounderror->proc~esmf_logrc2msg proc~esmf_logwrite ESMF_LogWrite proc~esmf_logfounderror->proc~esmf_logwrite c_esmc_loggeterrormsg c_esmc_loggeterrormsg proc~esmf_logrc2msg->c_esmc_loggeterrormsg c_esmc_vmwtime c_esmc_vmwtime proc~esmf_logwrite->c_esmc_vmwtime proc~esmf_logclose ESMF_LogClose proc~esmf_logwrite->proc~esmf_logclose proc~esmf_logflush ESMF_LogFlush proc~esmf_logwrite->proc~esmf_logflush proc~esmf_logopenfile ESMF_LogOpenFile proc~esmf_logwrite->proc~esmf_logopenfile proc~esmf_utiliounitflush ESMF_UtilIOUnitFlush proc~esmf_logwrite->proc~esmf_utiliounitflush proc~esmf_utilstring2array ESMF_UtilString2Array proc~esmf_logwrite->proc~esmf_utilstring2array proc~esmf_logclose->proc~esmf_logflush proc~esmf_logflush->proc~esmf_utiliounitflush proc~esmf_utilarray2string ESMF_UtilArray2String proc~esmf_logflush->proc~esmf_utilarray2string proc~esmf_logopenfile->proc~esmf_utiliounitflush proc~esmf_utiliounitget ESMF_UtilIOUnitGet proc~esmf_logopenfile->proc~esmf_utiliounitget

Called by

ESMF_AlarmCreateNewwESMF_IMErrS
w
ESMF_AlarmNotStickyw
w
ESMF_AlarmSetw
w
ESMF_AlarmWillRingNextw
w
ESMF_ArraySMMw
w
ESMF_ArraySpecEQw
w
ESMF_ArraySpecGetw
w
ESMF_ArraySpecPrintw
w
ESMF_ArraySpecValidatew
w
ESMF_ClockAdvancew
w
ESMF_ClockCreateNeww
w
ESMF_ClockGetAlarmListw
w
ESMF_ClockGetNextTimew
w
ESMF_ClockSetw
w
ESMF_ClockStopTimeEnablew
w
ESMF_CompStatusGetw
w
ESMF_DistGridConnectionGetw
w
ESMF_DynamicMaskGetw
w
ESMF_InterArrayCreateDGConnw
w
ESMF_TimeDecw
w
ESMF_TimeDiffw
w
ESMF_TimeEQw
w
ESMF_TimeGEw
w
ESMF_TimeGetw
w
ESMF_TimeGTw
w
ESMF_TimeIncw
w
ESMF_TimeIntervalAbsValuew
w
ESMF_TimeIntervalDiffw
w
ESMF_TimeIntervalEQw
w
ESMF_TimeIntervalFQuotw
w
ESMF_TimeIntervalGEw
w
ESMF_TimeIntervalGetDurw
w
ESMF_TimeIntervalGetDurCalw
w
ESMF_TimeIntervalGetDurCalTypw
w
ESMF_TimeIntervalGetDurStartw
w
ESMF_TimeIntervalGTw
w
ESMF_TimeIntervalLEw
w
ESMF_TimeIntervalLTw
w
ESMF_TimeIntervalNEw
w
ESMF_TimeIntervalNegAbsValuew
w
ESMF_TimeIntervalNegatew
w
ESMF_TimeIntervalPrintw
w
ESMF_TimeIntervalProdFTw
w
ESMF_TimeIntervalProdITw
w
ESMF_TimeIntervalProdRTw
w
ESMF_TimeIntervalProdTFw
w
ESMF_TimeIntervalProdTIw
w
ESMF_TimeIntervalProdTRw
w
ESMF_TimeIntervalQuotIw
w
ESMF_TimeIntervalQuotRw
w
ESMF_TimeIntervalRemainderw
w
ESMF_TimeIntervalRQuotw
w
ESMF_TimeIntervalSetDurStartw
w
ESMF_TimeIntervalSumw
w
ESMF_TimeIntervalValidatew
w
ESMF_TimeIntervalWriteRestartw
w
ESMF_TimeIsLeapYearw
w
ESMF_TimeIsSameCalendarw
w
ESMF_TimeLEw
w
ESMF_TimeLTw
w
ESMF_TimeNEw
w
ESMF_TimePrintw
w
ESMF_TimeSyncToRealTimew
w
ESMF_TimeValidatew
w
ESMF_TimeWriteRestartw
w

Source Code

recursive function ESMF_IMErrS(isInit, line, file, method, rc) result (IMErrS)
!
! !RETURN VALUE:
        logical                                         :: IMErrS
! !ARGUMENTS:
!       
        ESMF_INIT_TYPE, intent(in)              :: isInit
        integer, intent(in), optional                   :: line
        character(len=*), intent(in), optional          :: file
        character(len=*), intent(in), optional          :: method
        integer, intent(out),optional                   :: rc
        

! !DESCRIPTION:
!      This function returns a logical true for ESMF initialization
!      codes that indicate an error.  A predefined error message will
!      be added to the {\tt ESMF\_Log} along with
!      a user added {\tt line}, {\tt file} and {\tt method}.
!      Additionally, {\tt rc} will be set to an appropriate return code.
!
!      The arguments are:
!      \begin{description}
!       
!      \item [isInit]
!            Initialization code to check.
!      \item [{[line]}]
!            Integer source line number.  Expected to be set by
!            using the preprocessor macro {\tt \_\_LINE\_\_} macro.
!      \item [{[file]}]
!            User-provided source file name.
!      \item [{[method]}]
!            User-provided method string.
!      \item [{[rc]}]
!            If specified, put the return code into {\tt rc}.
!            This is not the return code for this function; it allows
!            the calling code to do an assignment of the error code
!            at the same time it is testing the value.
!            of the default Log.
!
!      \end{description}
!
!EOPI

    ! Initialize return code; assume routine not imlemented
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    IMErrS=ESMF_LogFoundError(ESMF_InitCheckShallow(isInit), &
                                     msg="Object not Initialized", &
                                     line=line, file=file, method=method, &
                                     rcToReturn=rc)

end function ESMF_IMErrS