libSBML C API
libSBML 5.20.2 C API
|
Stores errors (and messages) encountered while processing SBML. More...
Functions | |
void | SBMLErrorLog_add (SBMLErrorLog_t *log, const SBMLError_t *error) |
_tLogs_t _tthe_t _tgiven_t _tXMLError_t_t _tstructure_t. | |
void | SBMLErrorLog_clearLog (SBMLErrorLog_t *log) |
_tRemoves_t _tall_t _terrors_t _tfrom_t _tthis_t _tlog_t. | |
int | SBMLErrorLog_contains (const SBMLErrorLog_t *log, unsigned int errorId) |
_tReturns_t @_tc_t _ttrue_t _tif_t _tSBMLErrorLog_t _tcontains_t _tan_t _terrorId_t | |
SBMLErrorLog_t * | SBMLErrorLog_create (void) |
@_tendcond_t | |
void | SBMLErrorLog_free (SBMLErrorLog_t *log) |
_tFrees_t _tthe_t _tSBMLErrorLog_t_t _tstructure_t. | |
const SBMLError_t * | SBMLErrorLog_getError (const SBMLErrorLog_t *log, unsigned int n) |
_tReturns_t _tthe_t _tnth_t _tSBMLError_t_t _tin_t _tthis_t _tlog_t. | |
const SBMLError_t * | SBMLErrorLog_getErrorWithSeverity (const SBMLErrorLog_t *log, unsigned int n, unsigned int severity) |
_tReturns_t _tthe_t <_ti_t>_tn_t</_ti_t>_tth_t _tSBMLError_t _tobject_t _twith_t _tgiven_t _tseverity_t _tin_t _tthis_t _tlog_t. | |
unsigned int | SBMLErrorLog_getNumErrors (const SBMLErrorLog_t *log) |
_tReturns_t _tthe_t _tnumber_t _tof_t _terrors_t _tthat_t _thave_t _tbeen_t _tlogged_t. | |
unsigned int | SBMLErrorLog_getNumFailsWithSeverity (const SBMLErrorLog_t *log, unsigned int severity) |
_tReturns_t _tthe_t _tnumber_t _tof_t _terrors_t _tthat_t _thave_t _tbeen_t _tlogged_t _twith_t _tthe_t _tgiven_t _tseverity_t _tcode_t. | |
void | SBMLErrorLog_remove (SBMLErrorLog_t *log, unsigned int errorId) |
_tRemoves_t _tan_t _terror_t _thaving_t _terrorId_t _tfrom_t _tthe_t _tSBMLError_t _tlist_t. | |
void | SBMLErrorLog_removeAll (SBMLErrorLog_t *log, unsigned int errorId) |
_tRemoves_t _tall_t _terrors_t _thaving_t _terrorId_t _tfrom_t _tthe_t _tSBMLError_t _tlist_t. | |
Stores errors (and messages) encountered while processing SBML.
void SBMLErrorLog_add | ( | SBMLErrorLog_t * | log, |
const SBMLError_t * | error | ||
) |
_tLogs_t _tthe_t _tgiven_t _tXMLError_t_t _tstructure_t.
@_tparam_t _tlog_t _tSBMLErrorLog_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 _tSBMLErrorLog_t_t
void SBMLErrorLog_clearLog | ( | SBMLErrorLog_t * | log | ) |
_tRemoves_t _tall_t _terrors_t _tfrom_t _tthis_t _tlog_t.
@_tparam_t _tlog_t _tSBMLErrorLog_t_t, _tthe_t _terror_t _tlog_t _tto_t _tbe_t _tcleared_t.
@_tmemberof_t _tSBMLErrorLog_t_t
int SBMLErrorLog_contains | ( | const SBMLErrorLog_t * | log, |
unsigned int | errorId | ||
) |
_tReturns_t @_tc_t _ttrue_t _tif_t _tSBMLErrorLog_t _tcontains_t _tan_t _terrorId_t
@_tparam_t _tlog_t _tSBMLErrorLog_t_t, _tthe_t _terror_t _tlog_t _tto_t _tbe_t _tqueried_t. @_tparam_t _terrorId_t _tthe_t _terror_t _tidentifier_t _tof_t _tthe_t _terror_t _tto_t _tbe_t _tfound_t.
@_tmemberof_t _tSBMLErrorLog_t_t
SBMLErrorLog_t * SBMLErrorLog_create | ( | void | ) |
@_tendcond_t
@_tclass_t _tdoc_errorlog_what_are_severities_t
@_tcond_t _tdoxygenIgnored_t
void SBMLErrorLog_free | ( | SBMLErrorLog_t * | log | ) |
_tFrees_t _tthe_t _tSBMLErrorLog_t_t _tstructure_t.
@_tmemberof_t _tSBMLErrorLog_t_t
const SBMLError_t * SBMLErrorLog_getError | ( | const SBMLErrorLog_t * | log, |
unsigned int | n | ||
) |
_tReturns_t _tthe_t _tnth_t _tSBMLError_t_t _tin_t _tthis_t _tlog_t.
@_tparam_t _tlog_t _tSBMLErrorLog_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 _tSBMLError_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 _tSBMLErrorLog_t_t
const SBMLError_t * SBMLErrorLog_getErrorWithSeverity | ( | const SBMLErrorLog_t * | log, |
unsigned int | n, | ||
unsigned int | severity | ||
) |
_tReturns_t _tthe_t <_ti_t>_tn_t</_ti_t>_tth_t _tSBMLError_t _tobject_t _twith_t _tgiven_t _tseverity_t _tin_t _tthis_t _tlog_t.
_tIndex_t @_tp_t _tn_t _tis_t _tcounted_t _tfrom_t _t0_t. _tCallers_t _tshould_t _tfirst_t _tinquire_t _tabout_t _tthe_t _tnumber_t _tof_t _titems_t _tin_t _tthe_t _tlog_t _tby_t _tusing_t _tthe_t @_tif_t _tjava_t _tSBMLErrorLog_t::_tgetNumFailsWithSeverity_t(_tlong_t _tseverity_t)@_telse_t _tgetNumFailsWithSeverity_t()@_tendif_t _tmethod_t. _tAttempts_t _tto_t _tuse_t _tan_t _terror_t _tindex_t _tnumber_t _tthat_t _texceeds_t _tthe_t _tactual_t _tnumber_t _tof_t _terrors_t _tin_t _tthe_t _tlog_t _twill_t _tresult_t _tin_t _ta_t @_tc_t _tNULL_t _tbeing_t _treturned_t.
@_tparam_t _tlog_t _tSBMLErrorLog_t_t, _tthe_t _terror_t _tlog_t _tto_t _tbe_t _tqueried_t. @_tparam_t _tn_t _tthe_t _tindex_t _tnumber_t _tof_t _tthe_t _terror_t _tto_t _tretrieve_t (_twith_t _t0_t _tbeing_t _tthe_t _tfirst_t _terror_t). @_tparam_t _tseverity_t _tthe_t _tseverity_t _tof_t _tthe_t _terror_t _tto_t _tretrieve_t.
@_treturn_t _tthe_t <_ti_t>_tn_t</_ti_t>_tth_t _tSBMLError_t _tin_t _tthis_t _tlog_t, _tor_t @_tc_t _tNULL_t _tif_t @_tp_t _tn_t _tis_t _tgreater_t _tthan_t _tor_t _tequal_t _tto_t @_tif_t _tjava_t _tSBMLErrorLog_t::_tgetNumFailsWithSeverity_t(_tlong_t _tseverity_t)@_telse_t _tgetNumFailsWithSeverity_t()@_tendif_t.
@_tsee_t _tgetNumFailsWithSeverity_t(_tunsigned_t _tint_t _tseverity_t)
@_tmemberof_t _tSBMLErrorLog_t_t
unsigned int SBMLErrorLog_getNumErrors | ( | const SBMLErrorLog_t * | log | ) |
_tReturns_t _tthe_t _tnumber_t _tof_t _terrors_t _tthat_t _thave_t _tbeen_t _tlogged_t.
@_tparam_t _tlog_t _tSBMLErrorLog_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 _tSBMLErrorLog_t_t
unsigned int SBMLErrorLog_getNumFailsWithSeverity | ( | const SBMLErrorLog_t * | log, |
unsigned int | severity | ||
) |
_tReturns_t _tthe_t _tnumber_t _tof_t _terrors_t _tthat_t _thave_t _tbeen_t _tlogged_t _twith_t _tthe_t _tgiven_t _tseverity_t _tcode_t.
@_tcopydetails_t _tdoc_errorlog_what_are_severities_t
@_tparam_t _tlog_t _tSBMLErrorLog_t_t, _tthe_t _terror_t _tlog_t _tto_t _tbe_t _tqueried_t. @_tif_t _tclike_t @_tparam_t _tseverity_t _ta_t _tvalue_t _tfrom_t #_tSBMLErrorSeverity_t_t @_tendif_t@_tif_t _tjava_t @_tparam_t _tseverity_t _ta_t _tvalue_t _tfrom_t _tthe_t _tset_t _tof_t <_tcode_t>_tLIBSBML_SEV__t</_tcode_t> _tconstants_t _tdefined_t _tby_t _tthe_t _tinterface_t _tclass_t <_tcode_t><_ta_t _thref_t="_tlibsbmlConstants._thtml_t">_tlibsbmlConstants_t</_ta_t></_tcode_t> @_tendif_t@_tif_t _tpython_t @_tparam_t _tseverity_t _ta_t _tvalue_t _tfrom_t _tthe_t _tset_t _tof_t <_tcode_t>_tLIBSBML_SEV__t</_tcode_t> _tconstants_t _tdefined_t _tby_t _tthe_t _tinterface_t _tclass_t @_tlink_t _tlibsbml_t _tlibsbml_t@_tendlink_t. @_tendif_t
@_treturn_t _ta_t _tcount_t _tof_t _tthe_t _tnumber_t _tof_t _terrors_t _twith_t _tthe_t _tgiven_t _tseverity_t _tcode_t.
@_tsee_t _tgetNumErrors_t()
@_tmemberof_t _tSBMLErrorLog_t_t
void SBMLErrorLog_remove | ( | SBMLErrorLog_t * | log, |
unsigned int | errorId | ||
) |
_tRemoves_t _tan_t _terror_t _thaving_t _terrorId_t _tfrom_t _tthe_t _tSBMLError_t _tlist_t.
_tOnly_t _tthe_t _tfirst_t _titem_t _twill_t _tbe_t _tremoved_t _tif_t _tthere_t _tare_t _tmultiple_t _terrors_t _twith_t _tthe_t _tgiven_t _terrorId_t.
@_tparam_t _tlog_t _tSBMLErrorLog_t_t, _tthe_t _terror_t _tlog_t _tto_t _tbe_t _tcleared_t. @_tparam_t _terrorId_t _tthe_t _terror_t _tidentifier_t _tof_t _tthe_t _terror_t _tto_t _tbe_t _tremoved_t.
@_tmemberof_t _tSBMLErrorLog_t_t
void SBMLErrorLog_removeAll | ( | SBMLErrorLog_t * | log, |
unsigned int | errorId | ||
) |
_tRemoves_t _tall_t _terrors_t _thaving_t _terrorId_t _tfrom_t _tthe_t _tSBMLError_t _tlist_t.
@_tparam_t _tlog_t _tSBMLErrorLog_t_t, _tthe_t _terror_t _tlog_t _tto_t _tbe_t _tcleared_t. @_tparam_t _terrorId_t _tthe_t _terror_t _tidentifier_t _tof_t _tthe_t _terror_t _tto_t _tbe_t _tremoved_t.
@_tmemberof_t _tSBMLErrorLog_t_t