errormanager.h File Reference

Header file for SWMM output API error handling. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	error_s
	Structure for managing errors. More...

Macros
#define	ERR_MAXMSG   256
	Maximum length of error message.

Typedefs
typedef void(*	p_msg_lookup) (int errorcode, char *message, int length)
	Function pointer for error message lookup.
typedef struct error_s	error_handle_t

Enumerations
enum	OutputErrorTypes {   ERR411 = 411 ,   ERR421 = 421 ,   ERR422 = 422 ,   ERR423 = 423 ,   ERR424 = 424 ,   ERR434 = 434 ,   ERR435 = 435 ,   ERR436 = 436 ,   ERR440 = 440 }
	Error codes. More...
enum	OutputWarningTypes { WARN10 = 10 }
	Warning codes. More...

Functions
error_handle_t *	new_error_manager (p_msg_lookup message_lookup)
	Constructs a new error handle.
void	dst_error_manager (error_handle_t *error_handle)
	Destroy error manager object.
int	set_error (error_handle_t *error_handle, int errorcode)
	Set error code in error manager object.
char *	check_error (error_handle_t *error_handle)
	Check error status and return error message.
void	clear_error (error_handle_t *error_handle)
	Clear error status.

Detailed Description

Header file for SWMM output API error handling.

Author

Michael E. Tryby (US EPA - ORD/NRMRL)

Date

Created: 2017-08-25

Last edited: 2024-10-17

Macro Definition Documentation

ERR_MAXMSG

#define ERR_MAXMSG   256

Maximum length of error message.

Typedef Documentation

error_handle_t

typedef struct error_s error_handle_t

p_msg_lookup

p_msg_lookup

Function pointer for error message lookup.

Parameters

[in]	errorcode	Error code
[out]	message	Error message
[in]	length	Length of error message

Enumeration Type Documentation

OutputErrorTypes

enum OutputErrorTypes

Error codes.

Enumerator
ERR411	Error 411: memory allocation failure.
ERR421	Error 421: invalid parameter code.
ERR422	Error 422: reporting period index out of range.
ERR423	Error 423: element index out of range.
ERR424	Error 424: no memory allocated for results.
ERR434	Error 434: unable to open binary output file.
ERR435	Error 435: invalid file - not created by SWMM.
ERR436	Error 436: invalid file - contains no results.
ERR440	rror 440: an unspecified error has occurred

OutputWarningTypes

enum OutputWarningTypes

Warning codes.

Enumerator
WARN10	Model run issued warnings.

Function Documentation

check_error()

char * check_error

(

error_handle_t *

error_handle

)

Check error status and return error message.

Parameters

[in]

error_handle

Pointer to error manager object

Returns

Error message

Check error status and return error message.

Check error status and return error message.

clear_error()

void clear_error

(

error_handle_t *

error_handle

)

Clear error status.

Parameters

[in,out]

error_handle

Pointer to error manager object

Clear error status.

Clear error status.

dst_error_manager()

void dst_error_manager

(

error_handle_t *

error_handle

)

Destroy error manager object.

Parameters

[in]

error_handle

Pointer to error manager object

Destroy error manager object.

Destroy error manager object.

new_error_manager()

error_handle_t * new_error_manager

(

p_msg_lookup

message_lookup

)

Constructs a new error handle.

Parameters

[in]

message_lookup

Function pointer for error message lookup

Returns

Pointer to error manager object

Constructs a new error handle.

Constructs a new error handle.

set_error()

int set_error	(	error_handle_t *	error_handle,
		int	errorcode
	)

Set error code in error manager object.

Parameters

[in]	error_handle	Pointer to error manager object
[in]	errorcode	Error code

Returns

Error code

Set error code in error manager object.

Set error code in error manager object.