subroutine ESMF_ContainerAddSIL(container, itemList, keywordEnforcer, &
multiflag, relaxedflag, rc)
!
! !ARGUMENTS:
type(ESMF_Container), intent(inout) :: container
type(ESMF_StateItemWrap), intent(in) :: itemList(:)
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
logical, intent(in), optional :: multiflag
logical, intent(in), optional :: relaxedflag
integer, intent(out), optional :: rc
!
! !DESCRIPTION:
! Add elements to an {\tt ESMF\_Container} object.
!
! This method defines garbage as those elements in {\tt itemList} that
! cannot be added to the container because an element with the same name
! already exists in the container. Garbage can only be generated in relaxed
! mode.
!
! The arguments are:
! \begin{description}
! \item[container]
! {\tt ESMF\_Container} object to be added to.
! \item[itemList]
! Items to be added.
! \item [{[multiflag]}]
! A setting of {\tt .true.} allows multiple items with the same name
! to be added to {\tt container}. For {\tt .false.}, added items must
! have unique names. The default setting is {\tt .false.}.
! \item [{[relaxedflag]}]
! A setting of {\tt .true.} indicates a relaxed definition of "add"
! under {\tt multiflag=.false.} mode, where it is {\em not} an error if
! {\tt itemList} contains items with names that are also found in
! {\tt container}. The {\tt container} is left unchanged for these items.
! For {\tt .false.} this is treated as an error condition.
! The default setting is {\tt .false.}.
! \item[{[rc]}]
! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
! \end{description}
!
!EOPI
!------------------------------------------------------------------------------
integer :: localrc ! local return code
type(ESMF_Logical) :: multiflagArg
type(ESMF_Logical) :: relaxedflagArg
integer :: i
character(len=ESMF_MAXSTR) :: name
type(ESMF_StateItemWrap) :: siw
! Initialize return code; assume failure until success is certain
localrc = ESMF_RC_NOT_IMPL
if (present(rc)) rc = ESMF_RC_NOT_IMPL
! Check init status of arguments
ESMF_INIT_CHECK_DEEP_SHORT(ESMF_ContainerGetInit, container, rc)
if (present(multiflag)) then
multiflagArg = multiflag
else
multiflagArg = ESMF_FALSE
endif
if (present(relaxedflag)) then
relaxedflagArg = relaxedflag
else
relaxedflagArg = ESMF_FALSE
endif
do i=1, size(itemList)
! Get the name of the item
call ESMF_StateItemGet(itemList(i)%si, name=name, rc=localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
! Call into the C++ interface layer
siw = itemList(i) ! makes object passing robust
call c_ESMC_ContainerAdd(container, trim(name), siw, &
multiflagArg, relaxedflagArg, localrc)
if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
ESMF_CONTEXT, rcToReturn=rc)) return
enddo
! Return successfully
if (present(rc)) rc = ESMF_SUCCESS
end subroutine ESMF_ContainerAddSIL