Type | Intent | Optional | Attributes | Name | ||
---|---|---|---|---|---|---|
type(ESMF_Calendar), | intent(inout), | optional | :: | c | ||
integer, | intent(out), | optional | :: | rc |
subroutine ESMF_CalendarSetInitCreated(c, rc) ! ! !ARGUMENTS: type(ESMF_Calendar), intent(inout), optional :: c integer, intent(out), optional :: rc ! ! ! !DESCRIPTION: ! Set init code in Calendar object to "CREATED". ! ! Used by other classes to set the isInit value of a calendar, since it ! is private to the {\tt ESMF\_Calendar} class. Within the ! {\tt ESMF\_Calendar} class, the macro {\tt ESMF\_INIT\_SET\_CREATED()} ! is used instead, since the {\tt ESMF\_Calendar} class and its methods ! are encapsulated within the same module. This gives the calendar ! methods direct access to the private isInit member. Compare to the ! other TimeMgr classes which have their types defined in separate ! modules from their methods, due to mutual dependencies. They must ! call their own {\tt ESMF\_*Init*()} method rather than use the ! {\tt ESMF\_INIT\_SET\_*()} macro. ! ! The arguments are: ! \begin{description} ! \item[{[c]}] ! Specified {\tt ESMF\_Calendar} object. ! \item[{[rc]}] ! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors. ! \end{description} ! !EOPI !------------------------------------------------------------------------------ ! Set return code to not implemented if (present(rc)) rc = ESMF_RC_NOT_IMPL ! Set init code if (present(c)) then ESMF_INIT_SET_CREATED(c) endif ! Return success if (present(rc)) rc = ESMF_SUCCESS end subroutine ESMF_CalendarSetInitCreated