ESMF_InfoGetTK Function

public function ESMF_InfoGetTK(info, key, keywordEnforcer, attnestflag, rc) result(typekind)

Arguments

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

Return Value type(ESMF_TypeKind_Flag)


Calls

proc~~esmf_infogettk~~CallsGraph proc~esmf_infogettk ESMF_InfoGetTK interface~c_info_get_tk c_info_get_tk proc~esmf_infogettk->interface~c_info_get_tk proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_infogettk->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

proc~~esmf_infogettk~~CalledByGraph proc~esmf_infogettk ESMF_InfoGetTK proc~nuopc_cplcompattributeget NUOPC_CplCompAttributeGet proc~nuopc_cplcompattributeget->proc~esmf_infogettk proc~nuopc_cplcompattributegetil NUOPC_CplCompAttributeGetIL proc~nuopc_cplcompattributegetil->proc~esmf_infogettk proc~nuopc_cplcompattributegetsl NUOPC_CplCompAttributeGetSL proc~nuopc_cplcompattributegetsl->proc~esmf_infogettk proc~nuopc_getattributefieldtk NUOPC_GetAttributeFieldTK proc~nuopc_getattributefieldtk->proc~esmf_infogettk proc~nuopc_getattributestate NUOPC_GetAttributeState proc~nuopc_getattributestate->proc~esmf_infogettk proc~nuopc_gridcompattributeget NUOPC_GridCompAttributeGet proc~nuopc_gridcompattributeget->proc~esmf_infogettk proc~nuopc_gridcompattributegetil NUOPC_GridCompAttributeGetIL proc~nuopc_gridcompattributegetil->proc~esmf_infogettk proc~nuopc_gridcompattributegetsl NUOPC_GridCompAttributeGetSL proc~nuopc_gridcompattributegetsl->proc~esmf_infogettk program~esmf_infoutest ESMF_InfoUTest program~esmf_infoutest->proc~esmf_infogettk interface~nuopc_compattributeget NUOPC_CompAttributeGet interface~nuopc_compattributeget->proc~nuopc_cplcompattributeget interface~nuopc_compattributeget->proc~nuopc_cplcompattributegetil interface~nuopc_compattributeget->proc~nuopc_cplcompattributegetsl interface~nuopc_compattributeget->proc~nuopc_gridcompattributeget interface~nuopc_compattributeget->proc~nuopc_gridcompattributegetil interface~nuopc_compattributeget->proc~nuopc_gridcompattributegetsl interface~nuopc_getattribute NUOPC_GetAttribute interface~nuopc_getattribute->proc~nuopc_getattributefieldtk interface~nuopc_getattribute->proc~nuopc_getattributestate

Source Code

function ESMF_InfoGetTK(info, key, keywordEnforcer, attnestflag, rc) result(typekind)
! !ARGUMENTS:
  type(ESMF_Info), intent(in) :: info
  character(len=*), intent(in) :: key
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
  type(ESMF_AttNest_Flag), intent(in), optional :: attnestflag
  integer, intent(out), optional :: rc
! !RETURN VALUE:
  type(ESMF_TypeKind_Flag) :: typekind
!
! !DESCRIPTION:
!     Return the ESMF TypeKind of the value associated with \textit{key}.
!     See section \ref{const:typekind} for valid return values.
!
!     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 [{[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_typekind
  integer(C_INT) :: recursive

  localrc = ESMF_FAILURE
  if (present(rc)) rc = ESMF_FAILURE
  recursive = 0 !false
  local_typekind = 0

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

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

  typekind = ESMF_TypeKind_Flag(local_typekind)

  if (present(rc)) rc = ESMF_SUCCESS
end function ESMF_InfoGetTK