ESMF_InfoDump Function

public function ESMF_InfoDump(info, keywordEnforcer, key, indent, rc) result(output)

Arguments

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

Return Value character(len=:), allocatable


Calls

proc~~esmf_infodump~~CallsGraph proc~esmf_infodump ESMF_InfoDump interface~c_info_dump c_info_dump proc~esmf_infodump->interface~c_info_dump interface~c_info_dump_len c_info_dump_len proc~esmf_infodump->interface~c_info_dump_len proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_infodump->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_infodump~~CalledByGraph proc~esmf_infodump ESMF_InfoDump proc~esmf_attpackstreamjson ESMF_AttPackStreamJSON proc~esmf_attpackstreamjson->proc~esmf_infodump proc~esmf_attributegetattpackarray ESMF_AttributeGetAttPackArray proc~esmf_attributegetattpackarray->proc~esmf_infodump proc~esmf_attributegetattpackarraybundle ESMF_AttributeGetAttPackArrayBundle proc~esmf_attributegetattpackarraybundle->proc~esmf_infodump proc~esmf_attributegetattpackcplcomp ESMF_AttributeGetAttPackCplComp proc~esmf_attributegetattpackcplcomp->proc~esmf_infodump proc~esmf_attributegetattpackdistgrid ESMF_AttributeGetAttPackDistGrid proc~esmf_attributegetattpackdistgrid->proc~esmf_infodump proc~esmf_attributegetattpackfield ESMF_AttributeGetAttPackField proc~esmf_attributegetattpackfield->proc~esmf_infodump proc~esmf_attributegetattpackfieldbundle ESMF_AttributeGetAttPackFieldBundle proc~esmf_attributegetattpackfieldbundle->proc~esmf_infodump proc~esmf_attributegetattpackgrid ESMF_AttributeGetAttPackGrid proc~esmf_attributegetattpackgrid->proc~esmf_infodump proc~esmf_attributegetattpackgridcomp ESMF_AttributeGetAttPackGridComp proc~esmf_attributegetattpackgridcomp->proc~esmf_infodump proc~esmf_attributegetattpacklocstream ESMF_AttributeGetAttPackLocStream proc~esmf_attributegetattpacklocstream->proc~esmf_infodump proc~esmf_attributegetattpackmesh ESMF_AttributeGetAttPackMesh proc~esmf_attributegetattpackmesh->proc~esmf_infodump proc~esmf_attributegetattpackscicomp ESMF_AttributeGetAttPackSciComp proc~esmf_attributegetattpackscicomp->proc~esmf_infodump proc~esmf_attributegetattpackstate ESMF_AttributeGetAttPackState proc~esmf_attributegetattpackstate->proc~esmf_infodump proc~esmf_attributeremoveattpackarray ESMF_AttributeRemoveAttPackArray proc~esmf_attributeremoveattpackarray->proc~esmf_infodump proc~esmf_attributeremoveattpackarraybundle ESMF_AttributeRemoveAttPackArrayBundle proc~esmf_attributeremoveattpackarraybundle->proc~esmf_infodump proc~esmf_attributeremoveattpackcplcomp ESMF_AttributeRemoveAttPackCplComp proc~esmf_attributeremoveattpackcplcomp->proc~esmf_infodump proc~esmf_attributeremoveattpackdistgrid ESMF_AttributeRemoveAttPackDistGrid proc~esmf_attributeremoveattpackdistgrid->proc~esmf_infodump proc~esmf_attributeremoveattpackfield ESMF_AttributeRemoveAttPackField proc~esmf_attributeremoveattpackfield->proc~esmf_infodump proc~esmf_attributeremoveattpackfieldbundle ESMF_AttributeRemoveAttPackFieldBundle proc~esmf_attributeremoveattpackfieldbundle->proc~esmf_infodump proc~esmf_attributeremoveattpackgrid ESMF_AttributeRemoveAttPackGrid proc~esmf_attributeremoveattpackgrid->proc~esmf_infodump proc~esmf_attributeremoveattpackgridcomp ESMF_AttributeRemoveAttPackGridComp proc~esmf_attributeremoveattpackgridcomp->proc~esmf_infodump proc~esmf_attributeremoveattpacklocstream ESMF_AttributeRemoveAttPackLocStream proc~esmf_attributeremoveattpacklocstream->proc~esmf_infodump proc~esmf_attributeremoveattpackmesh ESMF_AttributeRemoveAttPackMesh proc~esmf_attributeremoveattpackmesh->proc~esmf_infodump proc~esmf_attributeremoveattpackscicomp ESMF_AttributeRemoveAttPackSciComp proc~esmf_attributeremoveattpackscicomp->proc~esmf_infodump proc~esmf_attributeremoveattpackstate ESMF_AttributeRemoveAttPackState proc~esmf_attributeremoveattpackstate->proc~esmf_infodump proc~esmf_infolog ESMF_InfoLog proc~esmf_infolog->proc~esmf_infodump proc~esmf_infoprint ESMF_InfoPrint proc~esmf_infoprint->proc~esmf_infodump proc~esmf_statereconcile ESMF_StateReconcile proc~esmf_statereconcile->proc~esmf_infodump program~esmf_infocacheutest ESMF_InfoCacheUTest program~esmf_infocacheutest->proc~esmf_infodump program~esmf_infotutorial ESMF_InfoTutorial program~esmf_infotutorial->proc~esmf_infodump

Source Code

function ESMF_InfoDump(info, keywordEnforcer, key, indent, rc) result(output)
! !ARGUMENTS:
  type(ESMF_Info), intent(in) :: info
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
  character(*), intent(in), optional :: key
  integer, intent(in), optional :: indent
  integer, intent(out), optional :: rc
! RESULT:
  character(:), allocatable :: output
!
! !DESCRIPTION:
!     Dump the contents of an \texttt{ESMF\_Info} object as a JSON string.
!
!     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 [{[indent]}]
!       Default is 0. Specifying an indentation greater than 0 will result in a
!       "pretty print" for JSON output string (string includes new line breaks).
!     \item [{[rc]}]
!       Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!EOP

  character(:), allocatable :: l_key
  integer :: dump_length, localrc, local_indent

  localrc = ESMF_RC_NOT_IMPL
  if (present(rc)) rc = ESMF_RC_NOT_IMPL

  if (present(key)) then
    l_key = key
  else
    l_key = ""
  endif
  if (present(indent)) then
    local_indent = indent
  else
    local_indent = 0
  endif

  call c_info_dump_len(info%ptr, dump_length, localrc, local_indent)
  if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, ESMF_CONTEXT)) return

  allocate(character(dump_length)::output)

  call c_info_dump(info%ptr, output, localrc, local_indent)
  if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, ESMF_CONTEXT)) return

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