libSBML C API  libSBML 5.20.2 C API
Loading...
Searching...
No Matches
XMLError.cpp File Reference

Represents errors (and messages) encountered during an XML parse. More...

Include dependency graph for XMLError.cpp:

Functions

LIBLAX_EXTERN XMLError_tXMLError_create (void)
 @_tendcond_t
 
LIBLAX_EXTERN XMLError_tXMLError_createWithIdAndMessage (unsigned int errorId, const char *message)
 _tCreates_t _ta_t _tnew_t _tXMLError_t _twith_t _tthe_t _tidentification_t _tnumber_t _tand_t _tdetailed_t _tmessage_t _tset_t.
 
LIBLAX_EXTERN void XMLError_free (XMLError_t *error)
 _tFrees_t _tthe_t _tgiven_t _tXMLError_t_t _tstructure_t.
 
LIBLAX_EXTERN unsigned int XMLError_getCategory (const XMLError_t *error)
 _tReturn_t _tthe_t _tcategory_t _tof_t _tthis_t _tXMLError_t_t.
 
LIBLAX_EXTERN const char * XMLError_getCategoryAsString (const XMLError_t *error)
 _tReturn_t _tthe_t _tcategory_t _tof_t _tthis_t _tXMLError_t_t _tas_t _ta_t _tstring_t.
 
LIBLAX_EXTERN unsigned int XMLError_getColumn (const XMLError_t *error)
 _tReturn_t _tthe_t _tcolumn_t _tnumber_t _twhere_t _tthis_t _tXMLError_t_t _toccurred_t.
 
LIBLAX_EXTERN unsigned int XMLError_getErrorId (const XMLError_t *error)
 _tReturns_t _tthe_t _tid_t _tof_t _tthis_t _tXMLError_t_t.
 
LIBLAX_EXTERN unsigned int XMLError_getLine (const XMLError_t *error)
 _tReturn_t _tthe_t _tline_t _tnumber_t _twhere_t _tthis_t _tXMLError_t_t _toccurred_t.
 
LIBLAX_EXTERN const char * XMLError_getMessage (const XMLError_t *error)
 _tReturns_t _tthe_t _tmessage_t _ttext_t _tof_t _tthis_t _tXMLError_t_t.
 
LIBLAX_EXTERN unsigned int XMLError_getSeverity (const XMLError_t *error)
 _tReturn_t _tthe_t _tseverity_t _tof_t _tthis_t _tXMLError_t_t.
 
LIBLAX_EXTERN const char * XMLError_getSeverityAsString (const XMLError_t *error)
 _tReturn_t _tthe_t _tseverity_t _tof_t _tthis_t _tXMLError_t_t _tas_t _ta_t _tstring_t.
 
LIBLAX_EXTERN const char * XMLError_getShortMessage (const XMLError_t *error)
 _tReturns_t _tthe_t _tshort_t _tmessage_t _ttext_t _tof_t _tthis_t _tXMLError_t_t.
 
LIBLAX_EXTERN int XMLError_isError (const XMLError_t *error)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthis_t _tXMLError_t_t _tstructure_t _tis_t _tan_t _terror_t.
 
LIBLAX_EXTERN int XMLError_isFatal (const XMLError_t *error)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthis_t _tXMLError_t_t _tstructure_t _tis_t _ta_t _tfatal_t _terror_t.
 
LIBLAX_EXTERN int XMLError_isInfo (const XMLError_t *error)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthis_t _tXMLError_t_t _tstructure_t _tis_t _tfor_t _tinformation_t _tonly_t.
 
LIBLAX_EXTERN int XMLError_isWarning (const XMLError_t *error)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthis_t _tXMLError_t_t _tstructure_t _tis_t _ta_t _twarning_t.
 
LIBLAX_EXTERN void XMLError_print (const XMLError_t *error, FILE *stream)
 _tOutputs_t _tthis_t _tXMLError_t_t _tto_t _tstream_t _tin_t _tthe_t _tfollowing_t _tformat_t (_tand_t _tfollowed_t _tby_t _ta_t _tnewline_t):
 

Detailed Description

Represents errors (and messages) encountered during an XML parse.

Author
Ben Bornstein

Function Documentation

◆ XMLError_create()

LIBLAX_EXTERN XMLError_t * XMLError_create ( void  )

@_tendcond_t

_tCreates_t _ta_t _tnew_t _tXMLError_t _tto_t _treport_t _tthat_t _tsomething_t _toccurred_t.

@_tcond_t _tdoxygenIgnored_t

◆ XMLError_createWithIdAndMessage()

LIBLAX_EXTERN XMLError_t * XMLError_createWithIdAndMessage ( unsigned int  errorId,
const char *  message 
)

_tCreates_t _ta_t _tnew_t _tXMLError_t _twith_t _tthe_t _tidentification_t _tnumber_t _tand_t _tdetailed_t _tmessage_t _tset_t.

_tIf_t _tthe_t _tidentifier_t _tis_t < _t10000_t, _tit_t _tmust_t _tbe_t _tone_t _tof_t _tthe_t _tpredefined_t _tXML_t _tlayer_t _terror_t _tcodes_t.

@_tparam_t _terrorId_t _tan_t _tunsigned_t _tint_t, _tthe_t _tidentification_t _tnumber_t _tof_t _tthe_t _terror_t. @_tparam_t _tmessage_t _ta_t _tstring_t, _tthe_t _terror_t _tmessage_t.

@_tmemberof_t _tXMLError_t_t

◆ XMLError_free()

LIBLAX_EXTERN void XMLError_free ( XMLError_t error)

_tFrees_t _tthe_t _tgiven_t _tXMLError_t_t _tstructure_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tXMLError_t_t

◆ XMLError_getCategory()

LIBLAX_EXTERN unsigned int XMLError_getCategory ( const XMLError_t error)

_tReturn_t _tthe_t _tcategory_t _tof_t _tthis_t _tXMLError_t_t.

_tThe_t _tpossible_t _tvalues_t (_tfor_t _tthe_t _tXML_t _tlayers_t) _tare_t _tthose_t _tfrom_t _tthe_t _tenumeration_t _tXMLErrorCategory_t_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t _tfrom_t _twhich_t _tto_t _treturn_t _tthe_t _tcategory_t.

@_treturn_t _tthe_t _tcategory_t _tof_t _tthis_t _tXMLError_t_t.

@_tmemberof_t _tXMLError_t_t

◆ XMLError_getCategoryAsString()

LIBLAX_EXTERN const char * XMLError_getCategoryAsString ( const XMLError_t error)

_tReturn_t _tthe_t _tcategory_t _tof_t _tthis_t _tXMLError_t_t _tas_t _ta_t _tstring_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t _tfrom_t _twhich_t _tto_t _treturn_t _tthe_t _tcategory_t.

@_treturn_t _tstring_t _trepresenting_t _tthe_t _tcategory_t _tof_t _tthis_t _tXMLError_t_t.

@_tmemberof_t _tXMLError_t_t

◆ XMLError_getColumn()

LIBLAX_EXTERN unsigned int XMLError_getColumn ( const XMLError_t error)

_tReturn_t _tthe_t _tcolumn_t _tnumber_t _twhere_t _tthis_t _tXMLError_t_t _toccurred_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t _tfrom_t _twhich_t _tto_t _treturn_t _tthe_t _tcolumn_t _tnumber_t.

@_treturn_t _tthe_t _tcolumn_t _tnumber_t _twhere_t _tthis_t _tXMLError_t_t _toccurred_t.

@_tmemberof_t _tXMLError_t_t

◆ XMLError_getErrorId()

LIBLAX_EXTERN unsigned int XMLError_getErrorId ( const XMLError_t error)

_tReturns_t _tthe_t _tid_t _tof_t _tthis_t _tXMLError_t_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t _tfrom_t _twhich_t _tto_t _treturn_t _tthe_t _tid_t.

@_treturn_t _tthe_t _tid_t _tof_t _tthis_t _tXMLError_t_t.

@_tmemberof_t _tXMLError_t_t

◆ XMLError_getLine()

LIBLAX_EXTERN unsigned int XMLError_getLine ( const XMLError_t error)

_tReturn_t _tthe_t _tline_t _tnumber_t _twhere_t _tthis_t _tXMLError_t_t _toccurred_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t _tfrom_t _twhich_t _tto_t _treturn_t _tthe_t _tline_t _tnumber_t.

@_treturn_t _tthe_t _tline_t _tnumber_t _twhere_t _tthis_t _tXMLError_t_t _toccurred_t.

@_tmemberof_t _tXMLError_t_t

◆ XMLError_getMessage()

LIBLAX_EXTERN const char * XMLError_getMessage ( const XMLError_t error)

_tReturns_t _tthe_t _tmessage_t _ttext_t _tof_t _tthis_t _tXMLError_t_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t _tfrom_t _twhich_t _tto_t _treturn_t _tthe_t _tmessage_t.

@_treturn_t _tthe_t _tmessage_t _ttext_t _tof_t _tthis_t _tXMLError_t_t.

@_tmemberof_t _tXMLError_t_t

◆ XMLError_getSeverity()

LIBLAX_EXTERN unsigned int XMLError_getSeverity ( const XMLError_t error)

_tReturn_t _tthe_t _tseverity_t _tof_t _tthis_t _tXMLError_t_t.

_tThe_t _tpossible_t _tvalues_t (_tfor_t _tthe_t _tXML_t _tlayer_t) _tare_t _tthose_t _tfrom_t _tthe_t _tenumeration_t #_tXMLErrorSeverity_t_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t _tfrom_t _twhich_t _tto_t _treturn_t _tthe_t _tseverity_t.

@_treturn_t _tthe_t _tseverity_t _tof_t _tthis_t _tXMLError_t_t.

@_tmemberof_t _tXMLError_t_t

◆ XMLError_getSeverityAsString()

LIBLAX_EXTERN const char * XMLError_getSeverityAsString ( const XMLError_t error)

_tReturn_t _tthe_t _tseverity_t _tof_t _tthis_t _tXMLError_t_t _tas_t _ta_t _tstring_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t _tfrom_t _twhich_t _tto_t _treturn_t _tthe_t _tseverity_t.

@_treturn_t _tstring_t _trepresenting_t _tthe_t _tseverity_t _tof_t _tthis_t _tXMLError_t_t.

@_tmemberof_t _tXMLError_t_t

◆ XMLError_getShortMessage()

LIBLAX_EXTERN const char * XMLError_getShortMessage ( const XMLError_t error)

_tReturns_t _tthe_t _tshort_t _tmessage_t _ttext_t _tof_t _tthis_t _tXMLError_t_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t _tfrom_t _twhich_t _tto_t _treturn_t _tthe_t _tshort_t _tmessage_t.

@_treturn_t _tthe_t _tmessage_t _ttext_t _tof_t _tthis_t _tXMLError_t_t.

@_tmemberof_t _tXMLError_t_t

◆ XMLError_isError()

LIBLAX_EXTERN int XMLError_isError ( const XMLError_t error)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthis_t _tXMLError_t_t _tstructure_t _tis_t _tan_t _terror_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tXMLError_t_t _tis_t _tan_t _terror_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tXMLError_t_t

Examples
createExampleSBML.c.

◆ XMLError_isFatal()

LIBLAX_EXTERN int XMLError_isFatal ( const XMLError_t error)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthis_t _tXMLError_t_t _tstructure_t _tis_t _ta_t _tfatal_t _terror_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tXMLError_t_t _tis_t _ta_t _tfatal_t _terror_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tXMLError_t_t

Examples
createExampleSBML.c.

◆ XMLError_isInfo()

LIBLAX_EXTERN int XMLError_isInfo ( const XMLError_t error)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthis_t _tXMLError_t_t _tstructure_t _tis_t _tfor_t _tinformation_t _tonly_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tXMLError_t_t _tis_t _tfor_t _tinformational_t _tpurposes_t _tonly_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tXMLError_t_t

◆ XMLError_isWarning()

LIBLAX_EXTERN int XMLError_isWarning ( const XMLError_t error)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthis_t _tXMLError_t_t _tstructure_t _tis_t _ta_t _twarning_t.

@_tparam_t _terror_t _tthe_t _tXMLError_t_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tXMLError_t_t _tis_t _ta_t _twarning_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tXMLError_t_t

◆ XMLError_print()

LIBLAX_EXTERN void XMLError_print ( const XMLError_t error,
FILE *  stream 
)

_tOutputs_t _tthis_t _tXMLError_t_t _tto_t _tstream_t _tin_t _tthe_t _tfollowing_t _tformat_t (_tand_t _tfollowed_t _tby_t _ta_t _tnewline_t):

_tline_t: (_tid_t) _tmessage_t

@_tparam_t _terror_t _tthe_t _tXMLError_t_t _tstructure_t _tto_t _twrite_t. @_tparam_t _tstream_t _tthe_t _tstream_t _tto_t _twrite_t _tto_t.

@_tmemberof_t _tXMLError_t_t