fieldml_util_routines Module Reference

Utility routines for FieldML. More...

Data Types
interface	fieldml_util_check_fieldml_error

Functions/Subroutines
subroutine	fieldmlutil_checkfieldmlsessionerrorvs (ERROR_DESCRIPTION, FML_HANDLE, ERR, ERROR,)
subroutine	fieldml_util_check_fieldml_session_errorc (ERROR_DESCRIPTION, FML_HANDLE, ERR, ERROR,)
subroutine, public	fieldml_io_initialise (FIELDML_INFO, IS_OUT, ERR, ERROR,)
subroutine, public	fieldml_io_finalise (FIELDML_INFO, ERR, ERROR,)

Detailed Description

Utility routines for FieldML.

Function/Subroutine Documentation

subroutine, public fieldml_util_routines::fieldml_io_finalise	(	type(fieldml_io_type), pointer	FIELDML_INFO,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Parameters

	fieldml_info	The FieldML parsing state to clean up.
[out]	err	The error code.
[out]	error	The error string.

Definition at line 207 of file fieldml_util_routines.f90.

References base_routines::enters(), base_routines::exits(), and lists::list_destroy().

Referenced by fieldml_io_initialise().

subroutine, public fieldml_util_routines::fieldml_io_initialise	(	type(fieldml_io_type), pointer	FIELDML_INFO,
		logical, intent(in)	IS_OUT,
		integer(intg), intent(out)	ERR,
		type(varying_string), intent(out)	ERROR
	)

Parameters

	fieldml_info	The FieldML parsing state to initialise.
[in]	is_out	True if the state is being used for output, false otherwise.
[out]	err	The error code.
[out]	error	The error string.

Definition at line 141 of file fieldml_util_routines.f90.

References base_routines::enters(), base_routines::exits(), fieldml_io_finalise(), lists::list_create_finish(), lists::list_create_start(), lists::list_data_type_set(), lists::list_intg_type, and lists::list_mutable_set().

Referenced by fieldml_input_routines::fieldml_input_initialise_from_file(), and fieldml_output_routines::fieldml_output_initialise_info().

subroutine fieldml_util_routines::fieldml_util_check_fieldml_session_errorc ( character(len=*), intent(in)  ERROR_DESCRIPTION, integer(intg), intent(in)  FML_HANDLE, integer(intg), intent(out)  ERR, type(varying_string), intent(out)  ERROR  )

private

Parameters

[in]	fml_handle	The FieldML session handle.
[out]	err	The error code.
[out]	error	The error string

Definition at line 112 of file fieldml_util_routines.f90.

References base_routines::enters(), and base_routines::exits().

subroutine fieldml_util_routines::fieldmlutil_checkfieldmlsessionerrorvs ( type(varying_string), intent(in)  ERROR_DESCRIPTION, integer(intg), intent(in)  FML_HANDLE, integer(intg), intent(out)  ERR, type(varying_string), intent(out)  ERROR  )

private

Parameters

[in]	fml_handle	The FieldML session handle.
[out]	err	The error code.
[out]	error	The error string

Definition at line 84 of file fieldml_util_routines.f90.

References base_routines::enters(), and base_routines::exits().