libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
XMLErrorLog.h File Reference

Stores errors (and messages) encountered while processing XML. More...

Include dependency graph for XMLErrorLog.h:
This graph shows which files directly or indirectly include this file:

Functions

LIBLAX_EXTERN void XMLErrorLog_add (XMLErrorLog_t *log, const XMLError_t *error)
 _tLogs_t _tthe_t _tgiven_t _tXMLError_t_t _tstructure_t.
 
LIBLAX_EXTERN void XMLErrorLog_clearLog (XMLErrorLog_t *log)
 _tRemoves_t _tall_t _terrors_t _tfrom_t _tthis_t _tlog_t.
 
LIBLAX_EXTERN XMLErrorLog_tXMLErrorLog_create (void)
 @_tclass_t _tdoc_what_are_severity_overrides_t
 
LIBLAX_EXTERN void XMLErrorLog_free (XMLErrorLog_t *log)
 _tFrees_t _tthe_t _tgiven_t _tXMLError_t_t _tstructure_t.
 
LIBLAX_EXTERN const XMLError_tXMLErrorLog_getError (const XMLErrorLog_t *log, unsigned int n)
 _tReturns_t _tthe_t _tnth_t _tXMLError_t_t _tin_t _tthis_t _tlog_t.
 
LIBLAX_EXTERN unsigned int XMLErrorLog_getNumErrors (const XMLErrorLog_t *log)
 _tReturns_t _tthe_t _tnumber_t _tof_t _terrors_t _tthat_t _thave_t _tbeen_t _tlogged_t.
 
LIBLAX_EXTERN XMLErrorSeverityOverride_t XMLErrorLog_getSeverityOverride (XMLErrorLog_t *log)
 _tReturns_t _tthe_t _tcurrent_t _toverride_t.
 
LIBLAX_EXTERN int XMLErrorLog_isSeverityOverridden (XMLErrorLog_t *log)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t '_tseverity_t _toverridden_t' _tflag_t _tof_t _tthis_t _tXMLErrorLog_t_t _tis_t _tset_t.
 
LIBLAX_EXTERN void XMLErrorLog_setSeverityOverride (XMLErrorLog_t *log, XMLErrorSeverityOverride_t overridden)
 _tSet_t _tthe_t _tseverity_t _toverride_t _tof_t _tthe_t _tgiven_t @_tp_t _tlog_t _tto_t _tthe_t _tgiven_t @_tp_t _toverridden_t _tvalue_t.
 
LIBLAX_EXTERN char * XMLErrorLog_toString (XMLErrorLog_t *log)
 _tWrites_t _tall_t _terrors_t _tcontained_t _tin_t _tthis_t _tlog_t _tto_t _ta_t _tstring_t _tand_t _treturns_t _tit_t.
 
LIBLAX_EXTERN void XMLErrorLog_unsetSeverityOverride (XMLErrorLog_t *log)
 _tUsets_t _tthe_t _toverride_t _tof_t _tthe_t _tgiven_t _tXMLErrorLog_t_t (_tsets_t _tthe_t _tflag_t _tto_t _tLIBSBML_OVERRIDE_DISABLED_t).
 

Detailed Description

Stores errors (and messages) encountered while processing XML.

Author
Ben Bornstein

Function Documentation

◆ XMLErrorLog_add()

LIBLAX_EXTERN void XMLErrorLog_add ( XMLErrorLog_t log,
const XMLError_t error 
)

_tLogs_t _tthe_t _tgiven_t _tXMLError_t_t _tstructure_t.

@_tparam_t _tlog_t _tXMLErrorLog_t_t, _tthe_t _terror_t _tlog_t _tto_t _tbe_t _tadded_t _tto_t. @_tparam_t _terror_t _tXMLError_t_t, _tthe_t _terror_t _tto_t _tbe_t _tlogged_t.

@_tmemberof_t _tXMLErrorLog_t_t

◆ XMLErrorLog_clearLog()

LIBLAX_EXTERN void XMLErrorLog_clearLog ( XMLErrorLog_t log)

_tRemoves_t _tall_t _terrors_t _tfrom_t _tthis_t _tlog_t.

@_tparam_t _tlog_t _tXMLErrorLog_t_t, _tthe_t _terror_t _tlog_t _tto_t _tbe_t _tcleared_t.

@_tmemberof_t _tXMLErrorLog_t_t

◆ XMLErrorLog_create()

LIBLAX_EXTERN XMLErrorLog_t * XMLErrorLog_create ( void  )

@_tclass_t _tdoc_what_are_severity_overrides_t

@_tpar_t _tThe_t <_tem_t>_tseverity_t _toverride_t</_tem_t> _tmechanism_t _tin_t _tXMLErrorLog_t _tis_t _tintended_t _tto_t _thelp_t _tapplications_t _thandle_t _terror_t _tconditions_t _tin_t _tways_t _tthat_t _tmay_t _tbe_t _tmore_t _tconvenient_t _tfor_t _tthose_t _tapplications_t. _tIt_t _tis_t _tpossible_t _tto_t _tuse_t _tthe_t _tmechanism_t _tto_t _toverride_t _tthe_t _tseverity_t _tcode_t _tof_t _terrors_t _tlogged_t _tby_t _tlibSBML_t, _tand_t _teven_t _tto_t _tdisable_t _terror_t _tlogging_t _tcompletely_t. _tAn_t _toverride_t _tstays_t _tin_t _teffect_t _tuntil_t _tthe_t _toverride_t _tis_t _tchanged_t _tagain_t _tby_t _tthe_t _tcalling_t _tapplication_t.

_tCreates_t _ta_t _tnew_t _tempty_t _tXMLErrorLog_t_t _tstructure_t _tand_t _treturns_t _tit_t.

@_treturn_t _tthe_t _tnew_t _tXMLErrorLog_t_t _tstructure_t.

@_tmemberof_t _tXMLErrorLog_t_t

@_tclass_t _tdoc_what_are_severity_overrides_t

@_tcond_t _tdoxygenIgnored_t

◆ XMLErrorLog_free()

LIBLAX_EXTERN void XMLErrorLog_free ( XMLErrorLog_t log)

_tFrees_t _tthe_t _tgiven_t _tXMLError_t_t _tstructure_t.

@_tparam_t _tlog_t _tXMLErrorLog_t_t, _tthe_t _terror_t _tlog_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tXMLErrorLog_t_t

◆ XMLErrorLog_getError()

LIBLAX_EXTERN const XMLError_t * XMLErrorLog_getError ( const XMLErrorLog_t log,
unsigned int  n 
)

_tReturns_t _tthe_t _tnth_t _tXMLError_t_t _tin_t _tthis_t _tlog_t.

@_tparam_t _tlog_t _tXMLErrorLog_t_t, _tthe_t _terror_t _tlog_t _tto_t _tbe_t _tqueried_t. @_tparam_t _tn_t _tunsigned_t _tint_t _tnumber_t _tof_t _tthe_t _terror_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tXMLError_t_t _tin_t _tthis_t _tlog_t. _tIf_t _tthe_t _tindex_t @_tp_t _tn_t _tis_t _tinvalid_t, @_tc_t _tNULL_t _tis_t _treturned_t.

@_tmemberof_t _tXMLErrorLog_t_t

◆ XMLErrorLog_getNumErrors()

LIBLAX_EXTERN unsigned int XMLErrorLog_getNumErrors ( const XMLErrorLog_t log)

_tReturns_t _tthe_t _tnumber_t _tof_t _terrors_t _tthat_t _thave_t _tbeen_t _tlogged_t.

@_tparam_t _tlog_t _tXMLErrorLog_t_t, _tthe_t _terror_t _tlog_t _tto_t _tbe_t _tqueried_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _terrors_t _tthat_t _thave_t _tbeen_t _tlogged_t.

@_tmemberof_t _tXMLErrorLog_t_t

◆ XMLErrorLog_getSeverityOverride()

LIBLAX_EXTERN XMLErrorSeverityOverride_t XMLErrorLog_getSeverityOverride ( XMLErrorLog_t log)

_tReturns_t _tthe_t _tcurrent_t _toverride_t.

@_treturn_t _ta_t _tseverity_t _toverride_t _tcode_t. _tThe_t _tpossible_t _tvalues_t _tare_t _tdrawn_t _tfrom_t _tthe_t _tenumeration_t #_tXMLErrorSeverityOverride_t_t: @_tli_t @_tsbmlconstant_t{_tLIBSBML_OVERRIDE_DISABLED_t, _tXMLErrorSeverityOverride_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OVERRIDE_DONT_LOG_t, _tXMLErrorSeverityOverride_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OVERRIDE_WARNING_t, _tXMLErrorSeverityOverride_t_t}

@_tparam_t _tlog_t _tXMLErrorLog_t_t _tstructure_t _tto_t _tbe_t _tqueried_t.

@_tsee_t _tXMLErrorLog_setSeverityOverride_t()

@_tmemberof_t _tXMLErrorLog_t_t

◆ XMLErrorLog_isSeverityOverridden()

LIBLAX_EXTERN int XMLErrorLog_isSeverityOverridden ( XMLErrorLog_t log)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthe_t '_tseverity_t _toverridden_t' _tflag_t _tof_t _tthis_t _tXMLErrorLog_t_t _tis_t _tset_t.

@_tparam_t _tlog_t _tXMLErrorLog_t_t _tstructure_t _tto_t _tbe_t _tqueried_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tsecurity_t _toverride_t _tis_t _tnot_t _tset_t _tto_t _tLIBSBML_OVERRIDE_DISABLED_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tXMLErrorLog_t_t

◆ XMLErrorLog_setSeverityOverride()

LIBLAX_EXTERN void XMLErrorLog_setSeverityOverride ( XMLErrorLog_t log,
XMLErrorSeverityOverride_t  overridden 
)

_tSet_t _tthe_t _tseverity_t _toverride_t _tof_t _tthe_t _tgiven_t @_tp_t _tlog_t _tto_t _tthe_t _tgiven_t @_tp_t _toverridden_t _tvalue_t.

@_tparam_t _tlog_t _tXMLErrorLog_t_t _tstructure_t _tto_t _tbe_t _tqueried_t. @_tparam_t _toverridden_t _tan_t _toverride_t _tcode_t _tindicating_t _twhat_t _tto_t _tdo_t. _tIf_t _tthe_t _tvalue_t _tis_t @_tsbmlconstant_t{_tLIBSBML_OVERRIDE_DISABLED_t, _tXMLErrorSeverityOverride_t_t} (_tthe_t _tdefault_t _tsetting_t) _tall_t _terrors_t _tlogged_t _twill_t _tbe_t _tgiven_t _tthe_t _tseverity_t _tspecified_t _tin_t _ttheir_t _tusual_t _tdefinition_t. _tIf_t _tthe_t _tvalue_t _tis_t @_tsbmlconstant_t{_tLIBSBML_OVERRIDE_WARNING_t, _tXMLErrorSeverityOverride_t_t}, _tthen_t _tall_t _terrors_t _twill_t _tbe_t _tlogged_t _tas_t _twarnings_t. _tIf_t _tthe_t _tvalue_t _tis_t @_tsbmlconstant_t{_tLIBSBML_OVERRIDE_DONT_LOG_t, _tXMLErrorSeverityOverride_t_t}, _tno_t _terror_t _twill_t _tbe_t _tlogged_t, _tregardless_t _tof_t _ttheir_t _tseverity_t.

@_tsee_t _tXMLErrorLog_getSeverityOverride_t()

@_tmemberof_t _tXMLErrorLog_t_t

◆ XMLErrorLog_toString()

LIBLAX_EXTERN char * XMLErrorLog_toString ( XMLErrorLog_t log)

_tWrites_t _tall_t _terrors_t _tcontained_t _tin_t _tthis_t _tlog_t _tto_t _ta_t _tstring_t _tand_t _treturns_t _tit_t.

@_tparam_t _tlog_t _tXMLErrorLog_t_t, _tthe_t _terror_t _tlog_t _tto_t _tconvert_t.

@_treturn_t _ta_t _tstring_t _tcontaining_t _tall_t _tlogged_t _terrors_t.

@_tmemberof_t _tXMLErrorLog_t_t

◆ XMLErrorLog_unsetSeverityOverride()

LIBLAX_EXTERN void XMLErrorLog_unsetSeverityOverride ( XMLErrorLog_t log)

_tUsets_t _tthe_t _toverride_t _tof_t _tthe_t _tgiven_t _tXMLErrorLog_t_t (_tsets_t _tthe_t _tflag_t _tto_t _tLIBSBML_OVERRIDE_DISABLED_t).

@_tparam_t _tlog_t _tXMLErrorLog_t_t _tstructure_t _tto_t _tbe_t _tqueried_t.

@_tmemberof_t _tXMLErrorLog_t_t