ESMF_InfoGetArrayMeta Subroutine

public subroutine ESMF_InfoGetArrayMeta(info, key, isArray, size, keywordEnforcer, attnestflag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Info), intent(in) :: info
character(len=*), intent(in) :: key
logical, intent(out) :: isArray
integer(kind=C_INT), intent(out) :: size
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_AttNest_Flag), intent(in), optional :: attnestflag
integer, intent(out), optional :: rc

Calls

proc~~esmf_infogetarraymeta~~CallsGraph proc~esmf_infogetarraymeta ESMF_InfoGetArrayMeta interface~c_info_get_array_meta c_info_get_array_meta proc~esmf_infogetarraymeta->interface~c_info_get_array_meta proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_infogetarraymeta->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_AttributeGetAttPackArrayBundleCHwESMF_InfoGetArrayMeta
w
ESMF_AttributeGetAttPackArrayBundleI4w
w
ESMF_AttributeGetAttPackArrayBundleI8w
w
ESMF_AttributeGetAttPackArrayBundleLGw
w
ESMF_AttributeGetAttPackArrayBundleR4w
w
ESMF_AttributeGetAttPackArrayBundleR8w
w
ESMF_AttributeGetAttPackArrayCHw
w
ESMF_AttributeGetAttPackArrayI4w
w
ESMF_AttributeGetAttPackArrayI8w
w
ESMF_AttributeGetAttPackArrayLGw
w
ESMF_AttributeGetAttPackArrayR4w
w
ESMF_AttributeGetAttPackArrayR8w
w
ESMF_AttributeGetAttPackCplCompCHw
w
ESMF_AttributeGetAttPackCplCompI4w
w
ESMF_AttributeGetAttPackCplCompI8w
w
ESMF_AttributeGetAttPackCplCompLGw
w
ESMF_AttributeGetAttPackCplCompR4w
w
ESMF_AttributeGetAttPackCplCompR8w
w
ESMF_AttributeGetAttPackDistGridCHw
w
ESMF_AttributeGetAttPackDistGridI4w
w
ESMF_AttributeGetAttPackDistGridI8w
w
ESMF_AttributeGetAttPackDistGridLGw
w
ESMF_AttributeGetAttPackDistGridR4w
w
ESMF_AttributeGetAttPackDistGridR8w
w
ESMF_AttributeGetAttPackFieldBundleCHw
w
ESMF_AttributeGetAttPackFieldBundleI4w
w
ESMF_AttributeGetAttPackFieldBundleI8w
w
ESMF_AttributeGetAttPackFieldBundleLGw
w
ESMF_AttributeGetAttPackFieldBundleR4w
w
ESMF_AttributeGetAttPackFieldBundleR8w
w
ESMF_AttributeGetAttPackFieldCHw
w
ESMF_AttributeGetAttPackFieldI4w
w
ESMF_AttributeGetAttPackFieldI8w
w
ESMF_AttributeGetAttPackFieldLGw
w
ESMF_AttributeGetAttPackFieldR4w
w
ESMF_AttributeGetAttPackFieldR8w
w
ESMF_AttributeGetAttPackGridCHw
w
ESMF_AttributeGetAttPackGridCompCHw
w
ESMF_AttributeGetAttPackGridCompI4w
w
ESMF_AttributeGetAttPackGridCompI8w
w
ESMF_AttributeGetAttPackGridCompLGw
w
ESMF_AttributeGetAttPackGridCompR4w
w
ESMF_AttributeGetAttPackGridCompR8w
w
ESMF_AttributeGetAttPackGridI4w
w
ESMF_AttributeGetAttPackGridI8w
w
ESMF_AttributeGetAttPackGridLGw
w
ESMF_AttributeGetAttPackGridR4w
w
ESMF_AttributeGetAttPackGridR8w
w
ESMF_AttributeGetAttPackLocStreamCHw
w
ESMF_AttributeGetAttPackLocStreamI4w
w
ESMF_AttributeGetAttPackLocStreamI8w
w
ESMF_AttributeGetAttPackLocStreamLGw
w
ESMF_AttributeGetAttPackLocStreamR4w
w
ESMF_AttributeGetAttPackLocStreamR8w
w
ESMF_AttributeGetAttPackMeshCHw
w
ESMF_AttributeGetAttPackMeshI4w
w
ESMF_AttributeGetAttPackMeshI8w
w
ESMF_AttributeGetAttPackMeshLGw
w
ESMF_AttributeGetAttPackMeshR4w
w
ESMF_AttributeGetAttPackMeshR8w
w
ESMF_AttributeGetAttPackSciCompCHw
w
ESMF_AttributeGetAttPackSciCompI4w
w
ESMF_AttributeGetAttPackSciCompI8w
w
ESMF_AttributeGetAttPackSciCompLGw
w
ESMF_AttributeGetAttPackSciCompR4w
w
ESMF_AttributeGetAttPackSciCompR8w
w
ESMF_AttributeGetAttPackStateCHw
w
ESMF_AttributeGetAttPackStateI4w
w
ESMF_AttributeGetAttPackStateI8w
w
ESMF_AttributeGetAttPackStateLGw
w
ESMF_AttributeGetAttPackStateR4w
w
ESMF_AttributeGetAttPackStateR8w
w
ESMF_InfoGetArrayCHw
w
ESMF_InfoGetArrayCHAllocw
w
ESMF_InfoGetArrayI4Allocw
w
ESMF_InfoGetArrayI8Allocw
w
ESMF_InfoGetArrayLGAllocw
w
ESMF_InfoGetArrayR4Allocw
w
ESMF_InfoGetArrayR8Allocw
w
ESMF_InfoUTestw
w

Source Code

subroutine ESMF_InfoGetArrayMeta(info, key, isArray, size, keywordEnforcer, attnestflag, rc)
! !ARGUMENTS:
  type(ESMF_Info), intent(in) :: info
  character(len=*), intent(in) :: key
  logical, intent(out) :: isArray
  integer(C_INT), intent(out) :: size
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
  type(ESMF_AttNest_Flag), intent(in), optional :: attnestflag
  integer, intent(out), optional :: rc
!
! !DESCRIPTION:
!     Return a value's array status and size using a \textit{key}.
!
!     The arguments are:
!     \begin{description}
!     \item [info]
!       Target \texttt{ESMF\_Info} object.
!     \item [key]
!       String key to access in \texttt{ESMF\_Info} storage. See section \ref{info_key_format}
!       for an overview of the key format.
!     \item [isArray]
!       Set to \texttt{true} if the target is an array in storage.
!     \item [size]
!       Set to the size of the target object in storage (i.e. length of the array).
!     \item [{[attnestflag]}]
!       Setting to \texttt{ESMF\_ATTNEST\_ON} triggers a recursive search for
!       \textit{keyParent}. The first instance of the key will be found in the
!       hierarchy. Default is \texttt{ESMF\_ATTNEST\_OFF}.
!     \item [{[rc]}]
!       Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!EOP

  integer :: localrc
  integer(C_INT) :: local_is_array
  integer(C_INT) :: recursive

  localrc = ESMF_FAILURE
  if (present(rc)) rc = ESMF_FAILURE

  recursive = 0 !false
  if (present(attnestflag)) then
    if (attnestflag%value==ESMF_ATTNEST_ON%value) recursive = 1 !true
  end if

  call c_info_get_array_meta(info%ptr, trim(key)//C_NULL_CHAR, local_is_array, size, recursive, &
    localrc)
  if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, ESMF_CONTEXT, rcToReturn=rc)) return

  if (local_is_array == 1) then
    isArray = .true.
  else
    isArray = .false.
  end if

  if (present(rc)) rc = ESMF_SUCCESS
end subroutine ESMF_InfoGetArrayMeta