ESMF_InfoIsSet Function

public function ESMF_InfoIsSet(info, key, keywordEnforcer, rc) result(is_set)

Arguments

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

Return Value logical


Calls

proc~~esmf_infoisset~~CallsGraph proc~esmf_infoisset ESMF_InfoIsSet interface~c_info_is_set c_info_is_set proc~esmf_infoisset->interface~c_info_is_set proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_infoisset->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_infoisset~~CalledByGraph proc~esmf_infoisset ESMF_InfoIsSet proc~nuopc_cplcompattributeget NUOPC_CplCompAttributeGet proc~nuopc_cplcompattributeget->proc~esmf_infoisset proc~nuopc_cplcompattributegeti NUOPC_CplCompAttributeGetI proc~nuopc_cplcompattributegeti->proc~esmf_infoisset proc~nuopc_cplcompattributegetil NUOPC_CplCompAttributeGetIL proc~nuopc_cplcompattributegetil->proc~esmf_infoisset proc~nuopc_cplcompattributegetsl NUOPC_CplCompAttributeGetSL proc~nuopc_cplcompattributegetsl->proc~esmf_infoisset proc~nuopc_cplcompsearchrevphasemap NUOPC_CplCompSearchRevPhaseMap proc~nuopc_cplcompsearchrevphasemap->proc~esmf_infoisset proc~nuopc_getattributefieldtk NUOPC_GetAttributeFieldTK proc~nuopc_getattributefieldtk->proc~esmf_infoisset proc~nuopc_getattributefieldval NUOPC_GetAttributeFieldVal proc~nuopc_getattributefieldval->proc~esmf_infoisset proc~nuopc_getattributestate NUOPC_GetAttributeState proc~nuopc_getattributestate->proc~esmf_infoisset proc~nuopc_gridcompattributeget NUOPC_GridCompAttributeGet proc~nuopc_gridcompattributeget->proc~esmf_infoisset proc~nuopc_gridcompattributegeti NUOPC_GridCompAttributeGetI proc~nuopc_gridcompattributegeti->proc~esmf_infoisset proc~nuopc_gridcompattributegetil NUOPC_GridCompAttributeGetIL proc~nuopc_gridcompattributegetil->proc~esmf_infoisset proc~nuopc_gridcompattributegetsl NUOPC_GridCompAttributeGetSL proc~nuopc_gridcompattributegetsl->proc~esmf_infoisset proc~nuopc_gridcompsearchrevphasemap NUOPC_GridCompSearchRevPhaseMap proc~nuopc_gridcompsearchrevphasemap->proc~esmf_infoisset program~esmf_infotutorial ESMF_InfoTutorial program~esmf_infotutorial->proc~esmf_infoisset program~esmf_infoutest ESMF_InfoUTest program~esmf_infoutest->proc~esmf_infoisset interface~nuopc_compattributeget NUOPC_CompAttributeGet interface~nuopc_compattributeget->proc~nuopc_cplcompattributeget interface~nuopc_compattributeget->proc~nuopc_cplcompattributegeti interface~nuopc_compattributeget->proc~nuopc_cplcompattributegetil interface~nuopc_compattributeget->proc~nuopc_cplcompattributegetsl interface~nuopc_compattributeget->proc~nuopc_gridcompattributeget interface~nuopc_compattributeget->proc~nuopc_gridcompattributegeti interface~nuopc_compattributeget->proc~nuopc_gridcompattributegetil interface~nuopc_compattributeget->proc~nuopc_gridcompattributegetsl interface~nuopc_compsearchrevphasemap NUOPC_CompSearchRevPhaseMap interface~nuopc_compsearchrevphasemap->proc~nuopc_cplcompsearchrevphasemap interface~nuopc_compsearchrevphasemap->proc~nuopc_gridcompsearchrevphasemap interface~nuopc_getattribute NUOPC_GetAttribute interface~nuopc_getattribute->proc~nuopc_getattributefieldtk interface~nuopc_getattribute->proc~nuopc_getattributefieldval interface~nuopc_getattribute->proc~nuopc_getattributestate

Source Code

function ESMF_InfoIsSet(info, key, keywordEnforcer, rc) result(is_set)
! !ARGUMENTS:
  type(ESMF_Info), intent(in) :: info
  character(len=*), intent(in) :: key
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
  integer, intent(out), optional :: rc
! !RETURN VALUE:
  logical :: is_set
!
! !DESCRIPTION:
!     Returns true if the target value is not null \cite{json_for_modern_cpp_null}.
!
!     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 [{[rc]}]
!       Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!EOP

  integer :: localrc
  integer(C_INT) :: is_set_c

  is_set = .false.
  localrc = ESMF_FAILURE
  if (present(rc)) rc = ESMF_FAILURE

  call c_info_is_set(info%ptr, trim(key)//C_NULL_CHAR, is_set_c, localrc)
  if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, ESMF_CONTEXT, rcToReturn=rc)) return

  if (is_set_c == 1) then
    is_set = .true.
  end if

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