ESMF_RouteHandleGetP Subroutine

private subroutine ESMF_RouteHandleGetP(routehandle, keywordEnforcer, name, vm, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_RouteHandle), intent(in) :: routehandle
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
character(len=*), intent(out), optional :: name
type(ESMF_VM), intent(out), optional :: vm
integer, intent(out), optional :: rc

Calls

proc~~esmf_routehandlegetp~~CallsGraph proc~esmf_routehandlegetp ESMF_RouteHandleGetP c_esmc_getvm c_esmc_getvm proc~esmf_routehandlegetp->c_esmc_getvm interface~c_esmc_getname c_ESMC_GetName proc~esmf_routehandlegetp->interface~c_esmc_getname proc~esmf_imerr ESMF_IMErr proc~esmf_routehandlegetp->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_routehandlegetp->proc~esmf_logfounderror proc~esmf_routehandlegetinit ESMF_RouteHandleGetInit proc~esmf_routehandlegetp->proc~esmf_routehandlegetinit proc~esmf_vmsetinitcreated ESMF_VMSetInitCreated proc~esmf_routehandlegetp->proc~esmf_vmsetinitcreated proc~esmf_imerr->proc~esmf_logfounderror proc~esmf_initcheckdeep ESMF_InitCheckDeep proc~esmf_imerr->proc~esmf_initcheckdeep 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

proc~~esmf_routehandlegetp~~CalledByGraph proc~esmf_routehandlegetp ESMF_RouteHandleGetP interface~esmf_routehandleget ESMF_RouteHandleGet interface~esmf_routehandleget->proc~esmf_routehandlegetp proc~esmf_stateitemget ESMF_StateItemGet proc~esmf_stateitemget->interface~esmf_routehandleget proc~esmf_statereconcileisnoop ESMF_StateReconcileIsNoop proc~esmf_statereconcileisnoop->interface~esmf_routehandleget proc~updatewithroutehandle ESMF_InfoDescribe%updateWithRouteHandle proc~updatewithroutehandle->interface~esmf_routehandleget program~esmf_routehandleadvancedutest ESMF_RouteHandleAdvancedUTest program~esmf_routehandleadvancedutest->interface~esmf_routehandleget none~update ESMF_InfoDescribe%Update none~update->proc~updatewithroutehandle proc~esmf_containeraddreplacesil ESMF_ContainerAddReplaceSIL proc~esmf_containeraddreplacesil->proc~esmf_stateitemget proc~esmf_containeraddsil ESMF_ContainerAddSIL proc~esmf_containeraddsil->proc~esmf_stateitemget proc~esmf_containerreplacesil ESMF_ContainerReplaceSIL proc~esmf_containerreplacesil->proc~esmf_stateitemget proc~esmf_reconcilezappedproxies ESMF_ReconcileZappedProxies proc~esmf_reconcilezappedproxies->proc~esmf_stateitemget proc~esmf_reconcilezapproxies ESMF_ReconcileZapProxies proc~esmf_reconcilezapproxies->proc~esmf_stateitemget proc~esmf_statereconcile ESMF_StateReconcile proc~esmf_statereconcile->proc~esmf_statereconcileisnoop

Source Code

  subroutine ESMF_RouteHandleGetP(routehandle, keywordEnforcer, name, vm, rc)
!
! !ARGUMENTS:
    type(ESMF_RouteHandle), intent(in)            :: routehandle
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    character(len=*),       intent(out), optional :: name
    type(ESMF_VM),          intent(out), optional :: vm
    integer,                intent(out), optional :: rc

!
! !DESCRIPTION:
!     Returns information about an {\tt ESMF\_RouteHandle}.
!
!     The arguments are:
!     \begin{description}
!     \item[routehandle]
!          {\tt ESMF\_RouteHandle} to be queried.
!     \item [{[name]}]
!          Name of the RouteHandle object.
!     \item [{[vm}]
!         The VM on which the RouteHandle object was created.
!     \item[{[rc]}]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOP
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code

    ! initialize return code; assume routine not implemented
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    ESMF_INIT_CHECK_DEEP(ESMF_RouteHandleGetInit,routehandle,rc)

    if (present(name)) then
      call c_ESMC_GetName(routehandle, name, localrc)
      if (ESMF_LogFoundError(localrc, &
        ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
    endif

    if (present(vm)) then
      call c_ESMC_GetVM(routehandle, vm, localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
      ! Set init code on the VM object before returning
      call ESMF_VMSetInitCreated(vm, rc=localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
    endif

    ! Return successfully
    if (present(rc)) rc = ESMF_SUCCESS

  end subroutine ESMF_RouteHandleGetP