solverError.h File Reference

#include <stdarg.h>
#include <stddef.h>
#include "sbmlsolver/exportdefs.h"

Include dependency graph for solverError.h:

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

Go to the source code of this file.

Defines
#define	RETURN_ON_ERRORS_WITH(x)   {if (SolverError_getNum(ERROR_ERROR_TYPE) || SolverError_getNum(FATAL_ERROR_TYPE)) return (x); }
#define	RETURN_ON_FATALS_WITH(x)   {if (SolverError_getNum(FATAL_ERROR_TYPE)) return (x); }
#define	ASSIGN_NEW_MEMORY_BLOCK(_ref, _num, _type, _return)   { (_ref) = (_type *)SolverError_calloc(_num, sizeof(_type)); RETURN_ON_FATALS_WITH(_return) }
#define	ASSIGN_NEW_MEMORY(_ref, _type, _return)   ASSIGN_NEW_MEMORY_BLOCK(_ref, 1, _type, _return)
Typedefs
typedef enum errorCode	errorCode_t
	error codes.
typedef enum errorType	errorType_t
	error types
Enumerations
enum	errorCode {   SOLVER_ERROR_ODE_COULD_NOT_BE_CONSTRUCTED_FOR_SPECIES = 10000, SOLVER_ERROR_THE_MODEL_CONTAINS_EVENTS = 10001, SOLVER_ERROR_THE_MODEL_CONTAINS_ALGEBRAIC_RULES = 10002, SOLVER_ERROR_ODE_MODEL_COULD_NOT_BE_CONSTRUCTED = 10003,   SOLVER_ERROR_NO_KINETIC_LAW_FOUND_FOR_REACTION = 10004, SOLVER_ERROR_ENTRIES_OF_THE_JACOBIAN_MATRIX_COULD_NOT_BE_CONSTRUCTED = 10005, SOLVER_ERROR_MODEL_NOT_SIMPLIFIED = 10006, SOLVER_ERROR_ENTRIES_OF_THE_PARAMETRIC_MATRIX_COULD_NOT_BE_CONSTRUCTED = 10007,   SOLVER_ERROR_MAKE_SURE_SCHEMA_IS_ON_PATH = 10030, SOLVER_ERROR_CANNOT_PARSE_MODEL = 10031, SOLVER_ERROR_DOCUMENTLEVEL_ONE = 100032, SOLVER_ERROR_NO_GRAPHVIZ = 10050,   SOLVER_ERROR_INTEGRATOR_SETTINGS = 10100, SOLVER_ERROR_VARY_SETTINGS = 10101, SOLVER_ERROR_INTEGRATION_NOT_SUCCESSFUL = 20000, SOLVER_ERROR_EVENT_TRIGGER_FIRED = 20001,   SOLVER_ERROR_CVODE_MALLOC_FAILED = 20002, SOLVER_ERROR_AST_UNKNOWN_NODE_TYPE = 20100, SOLVER_ERROR_AST_UNKNOWN_FAILURE = 20101, SOLVER_ERROR_AST_EVALUATION_FAILED_MISSING_VALUE = 20102,   SOLVER_ERROR_AST_EVALUATION_FAILED_DELAY = 20103, SOLVER_ERROR_AST_EVALUATION_FAILED_LAMBDA = 20104, SOLVER_ERROR_AST_EVALUATION_FAILED_FUNCTION = 20105, SOLVER_ERROR_AST_EVALUATION_FAILED_FLOAT_FACTORIAL = 20106,   SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_CONSTANT = 20110, SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_OPERATOR = 20111, SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_LAMBDA = 20112, SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_DELAY = 20114,   SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_FACTORIAL = 20115, SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_PIECEWISE = 20117, SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_LOGICAL_OR_RELATIONAL = 20118, SOLVER_ERROR_CVODE_RESULTS_FAILED = 20201,   SOLVER_ERROR_SBML_RESULTS_FAILED = 20202, SOLVER_MESSAGE_RERUN_WITH_OR_WO_JACOBIAN = 20500, SOLVER_MESSAGE_STEADYSTATE_FOUND = 20501, SOLVER_ERROR_NO_MORE_MEMORY_AVAILABLE = 30000,   SOLVER_ERROR_SYMBOL_IS_NOT_IN_MODEL = 40000, SOLVER_ERROR_ATTEMPTING_TO_COPY_VARIABLE_STATE_BETWEEN_INSTANCES_OF_DIFFERENT_MODELS = 40001 }
	error codes. More...
enum	errorType { FATAL_ERROR_TYPE = 0, ERROR_ERROR_TYPE = 1, WARNING_ERROR_TYPE = 2, NUMBER_OF_ERROR_TYPES = 3 }
	error types More...
Functions
SBML_ODESOLVER_API int	SolverError_getNum (errorType_t)
SBML_ODESOLVER_API char *	SolverError_getMessage (errorType_t, int errorNum)
	get a stored error message
SBML_ODESOLVER_API errorCode_t	SolverError_getCode (errorType_t, int errorNum)
	get error code
SBML_ODESOLVER_API errorCode_t	SolverError_getLastCode (errorType_t)
	get error code of last error stored of given type
SBML_ODESOLVER_API void	SolverError_clear ()
	empty error store
SBML_ODESOLVER_API void	SolverError_error (errorType_t, errorCode_t, char *format,...)
	create an error
SBML_ODESOLVER_API void	SolverError_haltOnErrors ()
	exit the program if errors or fatals have been created.
SBML_ODESOLVER_API void	SolverError_dump ()
SBML_ODESOLVER_API char *	SolverError_dumpToString ()
SBML_ODESOLVER_API void	SolverError_freeDumpString (char *)
SBML_ODESOLVER_API void	SolverError_dumpAndClearErrors ()
SBML_ODESOLVER_API void *	SolverError_calloc (size_t num, size_t size)
SBML_ODESOLVER_API int	SolverError_isMemoryExhausted ()

---

Define Documentation

#define RETURN_ON_ERRORS_WITH (  x   )     {if (SolverError_getNum(ERROR_ERROR_TYPE) || SolverError_getNum(FATAL_ERROR_TYPE)) return (x); }

#define RETURN_ON_FATALS_WITH (  x   )     {if (SolverError_getNum(FATAL_ERROR_TYPE)) return (x); }

#define ASSIGN_NEW_MEMORY_BLOCK (  _ref, _num, _type, _return   )     { (_ref) = (_type *)SolverError_calloc(_num, sizeof(_type)); RETURN_ON_FATALS_WITH(_return) }

#define ASSIGN_NEW_MEMORY (  _ref, _type, _return   )     ASSIGN_NEW_MEMORY_BLOCK(_ref, 1, _type, _return)

---

Typedef Documentation

typedef enum errorCode errorCode_t

error codes. codes < 0 reserved for CVODE codes 0 throu 9999 reserved for LibSBML

typedef enum errorType errorType_t

error types

---

Enumeration Type Documentation

enum errorCode

error codes. codes < 0 reserved for CVODE codes 0 throu 9999 reserved for LibSBML Enumerator: SOLVER_ERROR_ODE_COULD_NOT_BE_CONSTRUCTED_FOR_SPECIES  1XXXX - conversion to ode model failures in odeConstruct.c SOLVER_ERROR_THE_MODEL_CONTAINS_EVENTS  SOLVER_ERROR_THE_MODEL_CONTAINS_ALGEBRAIC_RULES  SOLVER_ERROR_ODE_MODEL_COULD_NOT_BE_CONSTRUCTED  SOLVER_ERROR_NO_KINETIC_LAW_FOUND_FOR_REACTION  SOLVER_ERROR_ENTRIES_OF_THE_JACOBIAN_MATRIX_COULD_NOT_BE_CONSTRUCTED  SOLVER_ERROR_MODEL_NOT_SIMPLIFIED  SOLVER_ERROR_ENTRIES_OF_THE_PARAMETRIC_MATRIX_COULD_NOT_BE_CONSTRUCTED  SOLVER_ERROR_MAKE_SURE_SCHEMA_IS_ON_PATH  1xx30 - SBML input model failures in sbml.c SOLVER_ERROR_CANNOT_PARSE_MODEL  SOLVER_ERROR_DOCUMENTLEVEL_ONE  SOLVER_ERROR_NO_GRAPHVIZ  1XX5X - Graph Drawing Errors in drawGraph.c SOLVER_ERROR_INTEGRATOR_SETTINGS  1X1XX - Wrong Input Settings SOLVER_ERROR_VARY_SETTINGS  SOLVER_ERROR_INTEGRATION_NOT_SUCCESSFUL  2XXXX - Integration Failures in integratorInstance.c SOLVER_ERROR_EVENT_TRIGGER_FIRED  SOLVER_ERROR_CVODE_MALLOC_FAILED  SOLVER_ERROR_AST_UNKNOWN_NODE_TYPE  AST evaluation in evaluateAST. SOLVER_ERROR_AST_UNKNOWN_FAILURE  SOLVER_ERROR_AST_EVALUATION_FAILED_MISSING_VALUE  SOLVER_ERROR_AST_EVALUATION_FAILED_DELAY  SOLVER_ERROR_AST_EVALUATION_FAILED_LAMBDA  SOLVER_ERROR_AST_EVALUATION_FAILED_FUNCTION  SOLVER_ERROR_AST_EVALUATION_FAILED_FLOAT_FACTORIAL  SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_CONSTANT  AST differentiation in differentiateAST. SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_OPERATOR  SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_LAMBDA  SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_DELAY  SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_FACTORIAL  SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_PIECEWISE  SOLVER_ERROR_AST_DIFFERENTIATION_FAILED_LOGICAL_OR_RELATIONAL  SOLVER_ERROR_CVODE_RESULTS_FAILED  2X2XX - Result Writing Failures SOLVER_ERROR_SBML_RESULTS_FAILED  SOLVER_MESSAGE_RERUN_WITH_OR_WO_JACOBIAN  2X5XX - Integration Messages in integratorInstance.c SOLVER_MESSAGE_STEADYSTATE_FOUND  SOLVER_ERROR_NO_MORE_MEMORY_AVAILABLE  3XXXX - Memory Exhaustion; general SOLVER_ERROR_SYMBOL_IS_NOT_IN_MODEL  4XXXX - assorted API errors SOLVER_ERROR_ATTEMPTING_TO_COPY_VARIABLE_STATE_BETWEEN_INSTANCES_OF_DIFFERENT_MODELS

enum errorType

error types Enumerator: FATAL_ERROR_TYPE  ERROR_ERROR_TYPE  WARNING_ERROR_TYPE  NUMBER_OF_ERROR_TYPES

---