ESMF_ArrayBundleGetItem Subroutine

private subroutine ESMF_ArrayBundleGetItem(arraybundle, arrayName, keywordEnforcer, array, arrayCount, isPresent, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_ArrayBundle), intent(in) :: arraybundle
character(len=*), intent(in) :: arrayName
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Array), intent(out), optional :: array
integer, intent(out), optional :: arrayCount
logical, intent(out), optional :: isPresent
integer, intent(out), optional :: rc

Calls

proc~~esmf_arraybundlegetitem~~CallsGraph proc~esmf_arraybundlegetitem ESMF_ArrayBundleGetItem c_esmc_arraybundlegetcount c_esmc_arraybundlegetcount proc~esmf_arraybundlegetitem->c_esmc_arraybundlegetcount c_esmc_arraybundlegetispresent c_esmc_arraybundlegetispresent proc~esmf_arraybundlegetitem->c_esmc_arraybundlegetispresent c_esmc_arraybundlegetitem c_esmc_arraybundlegetitem proc~esmf_arraybundlegetitem->c_esmc_arraybundlegetitem esmf_arraysetinitcreated esmf_arraysetinitcreated proc~esmf_arraybundlegetitem->esmf_arraysetinitcreated proc~esmf_arraybundlegetinit ESMF_ArrayBundleGetInit proc~esmf_arraybundlegetitem->proc~esmf_arraybundlegetinit proc~esmf_imerr ESMF_IMErr proc~esmf_arraybundlegetitem->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_arraybundlegetitem->proc~esmf_logfounderror 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_arraybundlegetitem~~CalledByGraph proc~esmf_arraybundlegetitem ESMF_ArrayBundleGetItem interface~esmf_arraybundleget ESMF_ArrayBundleGet interface~esmf_arraybundleget->proc~esmf_arraybundlegetitem proc~esmf_namedaliasarraybundle ESMF_NamedAliasArrayBundle proc~esmf_namedaliasarraybundle->interface~esmf_arraybundleget proc~esmf_stateitemget ESMF_StateItemGet proc~esmf_stateitemget->interface~esmf_arraybundleget proc~esmf_statereconcileisnoop ESMF_StateReconcileIsNoop proc~esmf_statereconcileisnoop->interface~esmf_arraybundleget proc~fillmembersarraybundle ESMF_InfoDescribe%fillMembersArrayBundle proc~fillmembersarraybundle->interface~esmf_arraybundleget proc~testarraybundlenamedalias TestArrayBundleNamedAlias proc~testarraybundlenamedalias->interface~esmf_arraybundleget proc~updatewitharraybundle ESMF_InfoDescribe%updateWithArrayBundle proc~updatewitharraybundle->interface~esmf_arraybundleget proc~user_final~47 user_final proc~user_final~47->interface~esmf_arraybundleget proc~user_final~92 user_final proc~user_final~92->interface~esmf_arraybundleget proc~user_run~47 user_run proc~user_run~47->interface~esmf_arraybundleget proc~user_run~92 user_run proc~user_run~92->interface~esmf_arraybundleget program~esmf_arraybundlecreateutest ESMF_ArrayBundleCreateUTest program~esmf_arraybundlecreateutest->interface~esmf_arraybundleget program~esmf_arraybundleex ESMF_ArrayBundleEx program~esmf_arraybundleex->interface~esmf_arraybundleget interface~esmf_namedalias ESMF_NamedAlias interface~esmf_namedalias->proc~esmf_namedaliasarraybundle none~fillmembers ESMF_InfoDescribe%FillMembers none~fillmembers->proc~fillmembersarraybundle none~update ESMF_InfoDescribe%Update none~update->proc~updatewitharraybundle 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 program~esmf_namedaliasutest ESMF_NamedAliasUTest program~esmf_namedaliasutest->proc~testarraybundlenamedalias

Source Code

    subroutine ESMF_ArrayBundleGetItem(arraybundle, arrayName, &
      keywordEnforcer, array, arrayCount, isPresent, rc)
!
! !ARGUMENTS:
    type(ESMF_ArrayBundle), intent(in)            :: arraybundle
    character(len=*),       intent(in)            :: arrayName
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    type(ESMF_Array),       intent(out), optional :: array
    integer,                intent(out), optional :: arrayCount
    logical,                intent(out), optional :: isPresent
    integer,                intent(out), optional :: rc
!
! !STATUS:
! \begin{itemize}
! \item\apiStatusCompatibleVersion{5.2.0r}
! \end{itemize}
!
! !DESCRIPTION:
!   Get information about items that match {\tt arrayName} in ArrayBundle.
!
!   \begin{description}
!   \item [arraybundle]
!     {\tt ESMF\_ArrayBundle} to be queried.
!   \item [arrayName]
!     Specified name.
!   \item [{[array]}]
!     Upon return holds the requested Array item. It is an error if this
!     argument was specified and there is not exactly one Array item in 
!     {\tt arraybundle} that matches {\tt arrayName}.
!   \item [{[arrayCount]}]
!     Number of Arrays with {\tt arrayName} in {\tt arraybundle}.
!   \item [{[isPresent]}]
!     Upon return indicates whether Array(s) with {\tt arrayName} exist
!     in {\tt arraybundle}.
!   \item [{[rc]}]
!     Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOP
!------------------------------------------------------------------------------
    integer                       :: localrc      ! local return code
    type(ESMF_Logical)            :: dummyIsPresent

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

    ! Check init status of arguments
    ESMF_INIT_CHECK_DEEP_SHORT(ESMF_ArrayBundleGetInit, arraybundle, rc)
    
    if (present(array)) then
      ! Call into the C++ interface
      call c_ESMC_ArrayBundleGetItem(arraybundle, trim(arrayName), array, &
        localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
      ! Set init code for deep C++ object
      call ESMF_ArraySetInitCreated(array, rc=localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
    endif
    
    if (present(arrayCount)) then
      ! Call into the C++ interface
      call c_ESMC_ArrayBundleGetCount(arraybundle, trim(arrayName), &
        arrayCount, localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
    endif

    if (present(isPresent)) then
      ! Call into the C++ interface
      call c_ESMC_ArrayBundleGetIsPresent(arraybundle, trim(arrayName), &
        dummyIsPresent, localrc)
      if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
      isPresent = dummyIsPresent
    endif

    ! Return successfully
    if (present(rc)) rc = ESMF_SUCCESS
  
  end subroutine ESMF_ArrayBundleGetItem