api_handle_error Module Reference

Functions/Subroutines
subroutine	check_call_position (CALL_POSITION, FNAME, PREV_POS, NEXT_POS, IERR)
subroutine	get_error_type (IERR, MESSAGE)

Variables
integer, parameter	error_len = 50
	name of error string length More...
integer, parameter	error_mess_len = 250
	error message string length More...
integer, parameter	no_error =0
integer, parameter	unallocated_array_error =1
integer, parameter	file_not_found_error =2
integer, parameter	call_position_error =3
integer, parameter	overtime_error =4
integer, parameter	max_instance_error =5
integer, parameter	invalid_instance_num_error =6
integer, parameter	unused_instance_error =7
integer, parameter	unknown_var_error =8
integer, parameter	increase_nb_var_t2d_error =9
integer, parameter	increase_nb_var_t3d_error =10
integer, parameter	increase_nb_var_art_error =11
integer, parameter	increase_nb_var_wac_error =12
integer, parameter	increase_nb_var_sis_error =13
integer, parameter	index_block_missing =14
integer, parameter	unknown_module =15
integer, parameter	no_position =-1
integer, parameter	run_set_config_pos =0
integer, parameter	run_read_case_pos =1
integer, parameter	run_allocation_pos =2
integer, parameter	run_init_pos =3
integer, parameter	run_timestep_pos =4
integer, parameter	run_finalize_pos =5
character(len=32), dimension(6)	pos_name
	List of positions names. More...
character(len=error_mess_len)	err_mess
	Error message. More...

Detailed Description

Brief:

error handling functions for the api

Function/Subroutine Documentation

check_call_position()

subroutine api_handle_error::check_call_position	(	integer	CALL_POSITION,
		character(*), intent(in)	FNAME,
		integer, intent(in)	PREV_POS,
		integer, intent(in)	NEXT_POS,
		integer, intent(out)	IERR
	)

Brief:

Check that the flag for postion call_position is between 'before' and 'after'

Parameters

[in]	CALL_POSITION	Id of the current position
[in]	FNAME	Name of the function
[in]	PREV_POS	Id of the postion the function must be called after
[in]	NEXT_POS	Id of the postion the function must be called before
[out]	IERR	0 if subroutine successfull, error id otherwise

Definition at line 67 of file api_handle_error.f.

get_error_type()

subroutine api_handle_error::get_error_type	(	integer, intent(in)	IERR,
		character(*), intent(out)	MESSAGE
	)

Brief:

Return the error message of the last error

Parameters

[in]	ierr	id of the error
[out]	message	the error message

Definition at line 95 of file api_handle_error.f.

Variable Documentation

call_position_error

integer, parameter api_handle_error::call_position_error =3

Definition at line 16 of file api_handle_error.f.

err_mess

character(len=error_mess_len) api_handle_error::err_mess

Error message.

Definition at line 48 of file api_handle_error.f.

error_len

integer, parameter api_handle_error::error_len = 50

name of error string length

Definition at line 9 of file api_handle_error.f.

error_mess_len

integer, parameter api_handle_error::error_mess_len = 250

error message string length

Definition at line 11 of file api_handle_error.f.

file_not_found_error

integer, parameter api_handle_error::file_not_found_error =2

Definition at line 15 of file api_handle_error.f.

increase_nb_var_art_error

integer, parameter api_handle_error::increase_nb_var_art_error =11

Definition at line 24 of file api_handle_error.f.

increase_nb_var_sis_error

integer, parameter api_handle_error::increase_nb_var_sis_error =13

Definition at line 26 of file api_handle_error.f.

increase_nb_var_t2d_error

integer, parameter api_handle_error::increase_nb_var_t2d_error =9

Definition at line 22 of file api_handle_error.f.

increase_nb_var_t3d_error

integer, parameter api_handle_error::increase_nb_var_t3d_error =10

Definition at line 23 of file api_handle_error.f.

increase_nb_var_wac_error

integer, parameter api_handle_error::increase_nb_var_wac_error =12

Definition at line 25 of file api_handle_error.f.

index_block_missing

integer, parameter api_handle_error::index_block_missing =14

Definition at line 27 of file api_handle_error.f.

invalid_instance_num_error

integer, parameter api_handle_error::invalid_instance_num_error =6

Definition at line 19 of file api_handle_error.f.

max_instance_error

integer, parameter api_handle_error::max_instance_error =5

Definition at line 18 of file api_handle_error.f.

no_error

integer, parameter api_handle_error::no_error =0

Definition at line 13 of file api_handle_error.f.

no_position

integer, parameter api_handle_error::no_position =-1

Definition at line 31 of file api_handle_error.f.

overtime_error

integer, parameter api_handle_error::overtime_error =4

Definition at line 17 of file api_handle_error.f.

pos_name

character(len=32), dimension(6) api_handle_error::pos_name

List of positions names.

Definition at line 39 of file api_handle_error.f.

run_allocation_pos

integer, parameter api_handle_error::run_allocation_pos =2

Definition at line 34 of file api_handle_error.f.

run_finalize_pos

integer, parameter api_handle_error::run_finalize_pos =5

Definition at line 37 of file api_handle_error.f.

run_init_pos

integer, parameter api_handle_error::run_init_pos =3

Definition at line 35 of file api_handle_error.f.

run_read_case_pos

integer, parameter api_handle_error::run_read_case_pos =1

Definition at line 33 of file api_handle_error.f.

run_set_config_pos

integer, parameter api_handle_error::run_set_config_pos =0

Definition at line 32 of file api_handle_error.f.

run_timestep_pos

integer, parameter api_handle_error::run_timestep_pos =4

Definition at line 36 of file api_handle_error.f.

unallocated_array_error

integer, parameter api_handle_error::unallocated_array_error =1

Definition at line 14 of file api_handle_error.f.

unknown_module

integer, parameter api_handle_error::unknown_module =15

Definition at line 28 of file api_handle_error.f.

unknown_var_error

integer, parameter api_handle_error::unknown_var_error =8

Definition at line 21 of file api_handle_error.f.

unused_instance_error

integer, parameter api_handle_error::unused_instance_error =7

Definition at line 20 of file api_handle_error.f.