Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_LocStream), | intent(in) | :: | locstream1 | |||
type(ESMF_LocStream), | intent(in) | :: | locstream2 | |||
type(ESMF_KeywordEnforcer), | optional | :: | keywordEnforcer | |||
integer, | intent(out), | optional | :: | rc |
function ESMF_LocStreamMatch(locstream1, locstream2, keywordEnforcer, rc) ! ! !RETURN VALUE: logical :: ESMF_LocStreamMatch ! !ARGUMENTS: type(ESMF_Locstream), intent(in) :: locstream1 type(ESMF_Locstream), intent(in) :: locstream2 type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below integer, intent(out), optional :: rc ! ! ! !DESCRIPTION: ! Check if {\tt locstream1} and {\tt locstream2} match. Returns ! .true. if Locstream objects match, .false. otherwise. This ! method current just checks if locstream1 and locstream2 are the ! same object, future work will do a more complex check. ! ! The arguments are: ! \begin{description} ! \item[locstream1] ! {\tt ESMF\_Locstream} object. ! \item[locstream2] ! {\tt ESMF\_Locstream} object. ! \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 routine not implemented localrc = ESMF_RC_NOT_IMPL if (present(rc)) rc = ESMF_RC_NOT_IMPL ! init to one setting in case of error ESMF_LocStreamMatch = .false. ! Check init status of arguments ESMF_INIT_CHECK_DEEP(ESMF_LocstreamGetInit, locstream1, rc) ESMF_INIT_CHECK_DEEP(ESMF_LocstreamGetInit, locstream2, rc) ! make sure the locstreams point to the same thing if (associated(locstream1%lstypep,locstream2%lstypep)) then ESMF_LocStreamMatch = .true. else ESMF_LocStreamMatch = .false. endif ! return successfully if (present(rc)) rc = ESMF_SUCCESS end function ESMF_LocStreamMatch