cmiss Module Reference

Data Types
interface	cmfe_InitFatalHandler
interface	cmfe_ResetFatalHandler
interface	cmfe_SetFatalHandler

Functions/Subroutines
subroutine, public	cmfe_errorhandlingmodeget_ (errorHandlingMode, err, error,)
	Returns the error handling mode for CMISS. More...
subroutine, public	cmfe_errorhandlingmodeset_ (errorHandlingMode, err, error,)
	Sets the error handling mode for cmiss. More...
subroutine, public	cmfe_finalise_ (err, error,)
	Finalises CMISS. More...
subroutine, public	cmfe_initialise_ (worldRegion, err, error,)
	Initialises CMISS. More...
subroutine, public	cmfe_handleerror (err, error)
	Handle an error condition. More...

Variables
integer(intg), parameter, public	cmfe_major_version = 0
integer(intg), parameter, public	cmfe_minor_version = 4
integer(intg), parameter, public	cmfe_revision_version = 0
character(len=maxstrlen), parameter, public	cmfe_build_version = "$Rev"
integer(intg), parameter, public	cmfe_return_error_code = 0
	Just return the error code. More...
integer(intg), parameter, public	cmfe_output_error = 1
	Output the error traceback and return the error code. More...
integer(intg), parameter, public	cmfe_trap_error = 2
	Trap the error by outputing the error traceback and stopping the program. More...
integer(intg), save	cmfe_errorhandlingmode
	The current error handling mode for OpenCMISS. More...

Function/Subroutine Documentation

subroutine, public cmiss::cmfe_errorhandlingmodeget_	(	integer(intg), intent(out)	errorHandlingMode,
		integer(intg), intent(inout)	err,
		type(varying_string), intent(inout)	error
	)

Returns the error handling mode for CMISS.

See also

OPENCMISS::CMISSErrorHandlingModeGet

Parameters

[out]

errorhandlingmode

On return, the error handling mode.

See also

CMISS::ErrorHandlingModes,CMISS

Parameters

[in,out]	err	The error string
[in,out]	error	The error code

Definition at line 140 of file cmiss.f90.

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

Referenced by cmiss::cmfe_SetFatalHandler::cmfe_setfatalhandler().

subroutine, public cmiss::cmfe_errorhandlingmodeset_	(	integer(intg), intent(in)	errorHandlingMode,
		integer(intg), intent(inout)	err,
		type(varying_string), intent(inout)	error
	)

Sets the error handling mode for cmiss.

See also

OPENCMISS::CMISSErrorHandlingModeSet

Parameters

[in]

errorhandlingmode

The error handling mode to set.

See also

CMISS::ErrorHandlingModes,CMISS

Parameters

[in,out]	err	The error string
[in,out]	error	The error code

Definition at line 166 of file cmiss.f90.

References cmfe_errorhandlingmode, cmfe_output_error, cmfe_return_error_code, cmfe_trap_error, base_routines::enters(), and base_routines::exits().

Referenced by cmiss::cmfe_SetFatalHandler::cmfe_setfatalhandler().

subroutine, public cmiss::cmfe_finalise_	(	integer(intg), intent(inout)	err,
		type(varying_string), intent(inout)	error
	)

Finalises CMISS.

See also

OPENCMISS::CMISSFinalise

Parameters

[in,out]	err	The error string
[in,out]	error	The error code

Definition at line 204 of file cmiss.f90.

References base_routines::base_routines_finalise(), basis_routines::bases_finalise(), comp_environment::computational_environment_finalise(), coordinate_routines::coordinate_systems_finalise(), and region_routines::regions_finalise().

Referenced by cmiss::cmfe_SetFatalHandler::cmfe_setfatalhandler().

subroutine, public cmiss::cmfe_handleerror	(	integer(intg), intent(inout)	err,
		type(varying_string), intent(inout)	error
	)

Handle an error condition.

Parameters

[in,out]	err	The error code
[in,out]	error	The error string

Definition at line 294 of file cmiss.f90.

References cmfe_errorhandlingmode, cmfe_output_error, cmfe_return_error_code, cmfe_trap_error, and base_routines::writeerror().

Referenced by cmiss::cmfe_SetFatalHandler::cmfe_setfatalhandler().

subroutine, public cmiss::cmfe_initialise_	(	type(region_type), pointer	worldRegion,
		integer(intg), intent(inout)	err,
		type(varying_string), intent(inout)	error
	)

Initialises CMISS.

See also

OPENCMISS::CMISSInitialise

Parameters

	worldregion	On exit, a pointer to the world region. Must not be associated on entry.
[in,out]	err	The error code
[in,out]	error	The error string

Definition at line 238 of file cmiss.f90.

References base_routines::base_routines_initialise(), basis_routines::bases_initialise(), cmfe_errorhandlingmode, cmfe_major_version, cmfe_minor_version, cmfe_output_error, cmfe_revision_version, comp_environment::computational_environment, comp_environment::computational_environment_initialise(), coordinate_routines::coordinate_systems_initialise(), and region_routines::regions_initialise().

Referenced by cmiss::cmfe_SetFatalHandler::cmfe_setfatalhandler().

Variable Documentation

character(len=maxstrlen), parameter, public cmiss::cmfe_build_version = "$Rev"

Definition at line 88 of file cmiss.f90.

Referenced by cmiss::cmfe_SetFatalHandler::cmfe_setfatalhandler().

integer(intg), save cmiss::cmfe_errorhandlingmode

private

The current error handling mode for OpenCMISS.

See also

CMISS::ErrorHandlingModes

Definition at line 103 of file cmiss.f90.

Referenced by cmfe_errorhandlingmodeget_(), cmfe_errorhandlingmodeset_(), cmfe_handleerror(), and cmfe_initialise_().

integer(intg), parameter, public cmiss::cmfe_major_version = 0

Definition at line 84 of file cmiss.f90.

Referenced by cmfe_initialise_(), and cmiss::cmfe_SetFatalHandler::cmfe_setfatalhandler().

integer(intg), parameter, public cmiss::cmfe_minor_version = 4

Definition at line 85 of file cmiss.f90.

Referenced by cmfe_initialise_(), and cmiss::cmfe_SetFatalHandler::cmfe_setfatalhandler().

integer(intg), parameter, public cmiss::cmfe_revision_version = 0

Definition at line 86 of file cmiss.f90.

Referenced by cmfe_initialise_(), and cmiss::cmfe_SetFatalHandler::cmfe_setfatalhandler().