ESMF_StateItemGet Subroutine

public subroutine ESMF_StateItemGet(stateItem, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_StateItem), intent(in) :: stateItem
character(len=*), intent(out), optional :: name
integer, intent(out), optional :: rc

Calls

proc~~esmf_stateitemget~~CallsGraph proc~esmf_stateitemget ESMF_StateItemGet esmf_arrayget esmf_arrayget proc~esmf_stateitemget->esmf_arrayget esmf_fieldbundleget esmf_fieldbundleget proc~esmf_stateitemget->esmf_fieldbundleget esmf_fieldget esmf_fieldget proc~esmf_stateitemget->esmf_fieldget interface~esmf_arraybundleget ESMF_ArrayBundleGet proc~esmf_stateitemget->interface~esmf_arraybundleget interface~esmf_routehandleget ESMF_RouteHandleGet proc~esmf_stateitemget->interface~esmf_routehandleget proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_stateitemget->proc~esmf_logfounderror proc~esmf_logseterror ESMF_LogSetError proc~esmf_stateitemget->proc~esmf_logseterror proc~esmf_arraybundlegetitem ESMF_ArrayBundleGetItem interface~esmf_arraybundleget->proc~esmf_arraybundlegetitem proc~esmf_arraybundlegetlist ESMF_ArrayBundleGetList interface~esmf_arraybundleget->proc~esmf_arraybundlegetlist proc~esmf_arraybundlegetlistall ESMF_ArrayBundleGetListAll interface~esmf_arraybundleget->proc~esmf_arraybundlegetlistall proc~esmf_routehandlegeti ESMF_RouteHandleGetI interface~esmf_routehandleget->proc~esmf_routehandlegeti proc~esmf_routehandlegetp ESMF_RouteHandleGetP interface~esmf_routehandleget->proc~esmf_routehandlegetp 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 proc~esmf_logseterror->esmf_breakpoint proc~esmf_logseterror->proc~esmf_logrc2msg proc~esmf_logseterror->proc~esmf_logwrite

Called by

proc~~esmf_stateitemget~~CalledByGraph proc~esmf_stateitemget ESMF_StateItemGet 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 interface~esmf_containeradd ESMF_ContainerAdd interface~esmf_containeradd->proc~esmf_containeraddsil interface~esmf_containeraddreplace ESMF_ContainerAddReplace interface~esmf_containeraddreplace->proc~esmf_containeraddreplacesil interface~esmf_containerreplace ESMF_ContainerReplace interface~esmf_containerreplace->proc~esmf_containerreplacesil proc~esmf_reconcileinitialize ESMF_ReconcileInitialize proc~esmf_reconcileinitialize->proc~esmf_reconcilezapproxies proc~esmf_statereconcile_driver ESMF_StateReconcile_driver proc~esmf_statereconcile_driver->proc~esmf_reconcilezappedproxies proc~esmf_statereconcile_driver->proc~esmf_reconcileinitialize proc~esmf_statereconcile ESMF_StateReconcile proc~esmf_statereconcile->proc~esmf_statereconcile_driver

Source Code

  subroutine ESMF_StateItemGet(stateItem, name, rc)
!
! !ARGUMENTS:
    type(ESMF_StateItem), intent(in)            :: stateItem
    character(len=*),     intent(out), optional :: name
    integer,              intent(out), optional :: rc
!         
! !DESCRIPTION:
!   Query a StateItem for information.
!
!   The arguments are:
!   \begin{description}
!   \item[stateItem]
!     {\tt ESMF\_StateItem} queried.
!   \item [{[name]}]
!     Name of the contained State item.
!   \item[{[rc]}]
!     Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    integer                     :: localrc      ! local return code

    ! Initialize return code; assume failure until success is certain
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL
    
    select case (stateItem%otype%ot)
    case (ESMF_STATEITEM_FIELD%ot)
      call ESMF_FieldGet(stateItem%datap%fp, name=name, rc=localrc)
      if (ESMF_LogFoundError(localrc, &
        ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) &
        return
    case (ESMF_STATEITEM_FIELDBUNDLE%ot)
      call ESMF_FieldBundleGet(stateItem%datap%fbp, name=name, rc=localrc)
      if (ESMF_LogFoundError(localrc, &
        ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) &
        return
    case (ESMF_STATEITEM_ARRAY%ot)
      call ESMF_ArrayGet(stateItem%datap%ap, name=name, rc=localrc)
      if (ESMF_LogFoundError(localrc, &
        ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) &
        return
    case (ESMF_STATEITEM_ARRAYBUNDLE%ot)
      call ESMF_ArrayBundleGet(stateItem%datap%abp, name=name, rc=localrc)
      if (ESMF_LogFoundError(localrc, &
        ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) &
        return
    case (ESMF_STATEITEM_ROUTEHANDLE%ot)
      call ESMF_RouteHandleGet(stateItem%datap%rp, name=name, rc=localrc)
      if (ESMF_LogFoundError(localrc, &
        ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) &
        return
    case (ESMF_STATEITEM_STATE%ot)
      if (present(name)) then
        name = stateItem%namep
      endif
    case default
      call ESMF_LogSetError(rcToCheck=ESMF_RC_INTNRL_BAD, &
        msg="- unsupported StateItemType", &
        ESMF_CONTEXT, rcToReturn=rc)
      name = '(unknown)'
      return  ! bail out
    end select
    
    ! Return successfully
    if (present(rc)) rc = ESMF_SUCCESS
 
  end subroutine ESMF_StateItemGet