libSBML C API
libSBML 5.20.2 C API
|
Implementation of the top-level container for an SBML Model_t and associated data. More...
Functions | |
unsigned int | SBMLDocument_checkConsistency (SBMLDocument_t *d) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tand_t _tvalidation_t _tchecks_t _ton_t _tthe_t _tgiven_t _tSBML_t _tdocument_t. | |
unsigned int | SBMLDocument_checkInternalConsistency (SBMLDocument_t *d) |
_tPerforms_t _tconsistency_t _tchecking_t _ton_t _tlibSBML_t'_ts_t _tinternal_t _trepresentation_t _tof_t _tan_t _tSBML_t _tModel_t. | |
unsigned int | SBMLDocument_checkL1Compatibility (SBMLDocument_t *d) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t&_tnbsp_t;_t1_t. | |
unsigned int | SBMLDocument_checkL2v1Compatibility (SBMLDocument_t *d) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t1_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t1_t. | |
unsigned int | SBMLDocument_checkL2v2Compatibility (SBMLDocument_t *d) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t2_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t2_t. | |
unsigned int | SBMLDocument_checkL2v3Compatibility (SBMLDocument_t *d) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t3_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t3_t. | |
unsigned int | SBMLDocument_checkL2v4Compatibility (SBMLDocument_t *d) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t4_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t4_t. | |
unsigned int | SBMLDocument_checkL2v5Compatibility (SBMLDocument_t *d) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t5_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t _t2_t _tVersion_t _t5_t. | |
unsigned int | SBMLDocument_checkL3v1Compatibility (SBMLDocument_t *d) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t _t3_t _tVersion_t _t1_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t _t3_t _tVersion_t _t1_t. | |
unsigned int | SBMLDocument_checkL3v2Compatibility (SBMLDocument_t *d) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t _t3_t _tVersion_t _t2_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t _t3_t _tVersion_t _t2_t. | |
SBMLDocument_t * | SBMLDocument_clone (const SBMLDocument_t *d) |
_tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t | |
int | SBMLDocument_convert (SBMLDocument_t *d, const ConversionProperties_t *props) |
_tConverts_t _tthis_t _tdocument_t _tusing_t _tthe_t _tconverter_t _tthat_t _tbest_t _tmatches_t _tthe_t _tgiven_t _tconversion_t _tproperties_t. | |
SBMLDocument_t * | SBMLDocument_create () |
@_tendcond_t | |
Model_t * | SBMLDocument_createModel (SBMLDocument_t *d) |
_tCreates_t _ta_t _tnew_t _tModel_t_t _tstructure_t _tinside_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t. | |
SBMLDocument_t * | SBMLDocument_createWithLevelAndVersion (unsigned int level, unsigned int version) |
_tCreates_t _ta_t _tnew_t, _tempty_t _tSBMLDocument_t_t _tstructure_t _twith_t _tgiven_t _tvalues_t _tfor_t _tthe_t _tSBML_t _tLevel_t _tand_t _tVersion_t. | |
SBMLDocument_t * | SBMLDocument_createWithSBMLNamespaces (SBMLNamespaces_t *sbmlns) |
_tCreates_t _ta_t _tnew_t _tSBMLDocument_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t @_tp_t _tsbmlns_t. | |
int | SBMLDocument_expandFunctionDefintions (SBMLDocument_t *d) |
_tRemoves_t _tany_t _tFunctionDefinition_t_t'_ts_t _tfrom_t _tthe_t _tdocument_t _tand_t _texpands_t _tany_t _tinstances_t _tof_t _ttheir_t _tuse_t _twithin_t &_tlt_t;_tmath_t&_tgt_t; _telements_t. | |
int | SBMLDocument_expandInitialAssignments (SBMLDocument_t *d) |
_tRemoves_t _tany_t _tInitialAssignment_t_t'_ts_t _tfrom_t _tthe_t _tdocument_t _tand_t _treplaces_t _tthe_t _tappropriate_t _tvalues_t. | |
void | SBMLDocument_free (SBMLDocument_t *d) |
_tFrees_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t. | |
unsigned int | SBMLDocument_getDefaultLevel () |
@_treturn_t _tthe_t _tmost_t _trecent_t _tSBML_t _tspecification_t _tlevel_t (_tat_t _tthe_t _ttime_t _tthis_t _tlibSBML_t _twas_t _treleased_t). | |
unsigned int | SBMLDocument_getDefaultVersion () |
@_treturn_t _tthe_t _tmost_t _trecent_t _tSBML_t _tspecification_t _tversion_t (_tat_t _tthe_t _ttime_t _tthis_t _tlibSBML_t _twas_t _treleased_t). | |
const SBMLError_t * | SBMLDocument_getError (SBMLDocument_t *d, unsigned int n) |
_tReturns_t _tthe_t _tnth_t _terror_t _tor_t _twarning_t _tencountered_t _tduring_t _tparsing_t, _tconsistency_t _tchecking_t, _tor_t _tattempted_t _ttranslation_t _tof_t _tthis_t _tmodel_t. | |
const SBMLErrorLog_t * | SBMLDocument_getErrorLog (SBMLDocument_t *d) |
const SBMLError_t * | SBMLDocument_getErrorWithSeverity (SBMLDocument_t *d, unsigned int n, unsigned int severity) |
_tReturns_t _tthe_t _tnth_t _terror_t _tor_t _twarning_t _twith_t _tthe_t _tgiven_t _tseverity_t _tencountered_t _tduring_t _tparsing_t, _tconsistency_t _tchecking_t, _tor_t _tattempted_t _ttranslation_t _tof_t _tthis_t _tmodel_t. | |
unsigned int | SBMLDocument_getLevel (const SBMLDocument_t *d) |
_tReturns_t _tthe_t _tSBML_t _tLevel_t _tof_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t. | |
char * | SBMLDocument_getLocationURI (SBMLDocument_t *d) |
_tGet_t _tthe_t _tlocation_t _tof_t _tthis_t _tSBMLDocument_t_t. | |
Model_t * | SBMLDocument_getModel (SBMLDocument_t *d) |
_tReturns_t _tthe_t _tModel_t_t _tstructure_t _tstored_t _tin_t _tthis_t _tSBMLDocument_t_t _tstructure_t. | |
const XMLNamespaces_t * | SBMLDocument_getNamespaces (SBMLDocument_t *d) |
_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthe_t _tXML_t _tcontent_t _tof_t _tthis_t _tSBML_t _tdocument_t. | |
unsigned int | SBMLDocument_getNumErrors (const SBMLDocument_t *d) |
_tReturns_t _tthe_t _tnumber_t _tof_t _terrors_t _tor_t _twarnings_t _tencountered_t _tduring_t _tparsing_t, _tconsistency_t _tchecking_t, _tor_t _tattempted_t _ttranslation_t _tof_t _tthis_t _tmodel_t. | |
unsigned int | SBMLDocument_getNumErrorsWithSeverity (const SBMLDocument_t *d, unsigned int severity) |
_tReturns_t _tthe_t _tnumber_t _tof_t _terrors_t _tor_t _twarnings_t _tencountered_t _tduring_t _tparsing_t, _tconsistency_t _tchecking_t, _tor_t _tattempted_t _ttranslation_t _tof_t _tthis_t _tmodel_t. | |
int | SBMLDocument_getPackageRequired (SBMLDocument_t *d, const char *package) |
_tReturns_t _tthe_t <_tcode_t>_trequired_t</_tcode_t> _tattribute_t _tof_t _tthe_t _tgiven_t _tpackage_t _textension_t. | |
int | SBMLDocument_getPkgRequired (SBMLDocument_t *d, const char *package) |
_tReturns_t _tthe_t <_tcode_t>_trequired_t</_tcode_t> _tattribute_t _tof_t _tthe_t _tgiven_t _tpackage_t _textension_t. | |
unsigned int | SBMLDocument_getVersion (const SBMLDocument_t *d) |
_tReturns_t _tthe_t _tVersion_t _twithin_t _tthe_t _tSBML_t _tLevel_t _tof_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t. | |
int | SBMLDocument_isSetModel (const SBMLDocument_t *d) |
_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tidentifier_t _tof_t _ta_t _tgiven_t _tSBMLDocument_t_t _tstructure_t _tis_t _tassigned_t. | |
int | SBMLDocument_isSetPackageRequired (SBMLDocument_t *d, const char *package) |
_tTests_t _twhether_t _tthe_t _trequired_t _tattribute_t _tof_t _tthe_t _tgiven_t _tpackage_t _textension_t _tis_t _tdefined_t. | |
int | SBMLDocument_isSetPkgRequired (SBMLDocument_t *d, const char *package) |
_tTests_t _twhether_t _tthe_t _trequired_t _tattribute_t _tof_t _tthe_t _tgiven_t _tpackage_t _textension_t _tis_t _tdefined_t. | |
void | SBMLDocument_printErrors (SBMLDocument_t *d, FILE *stream) |
_tPrints_t _tto_t _tthe_t _tgiven_t _toutput_t _tstream_t _tall_t _tthe_t _terrors_t _tor_t _twarnings_t _tencountered_t _tduring_t _tparsing_t, _tconsistency_t _tchecking_t, _tor_t _tattempted_t _ttranslation_t _tof_t _tthis_t _tmodel_t. | |
void | SBMLDocument_setConsistencyChecks (SBMLDocument_t *d, SBMLErrorCategory_t category, int apply) |
_tAllows_t _tparticular_t _tvalidators_t _tto_t _tbe_t _tturned_t _ton_t _tor_t _toff_t _tprior_t _tto_t _tcalling_t _tcheckConsistency_t. | |
void | SBMLDocument_setConsistencyChecksForConversion (SBMLDocument_t *d, SBMLErrorCategory_t category, int apply) |
_tAllows_t _tparticular_t _tvalidators_t _tto_t _tbe_t _tturned_t _ton_t _tor_t _toff_t _tprior_t _tto_t _tcalling_t _tsetLevelAndVersion_t. | |
int | SBMLDocument_setLevelAndVersion (SBMLDocument_t *d, unsigned int level, unsigned int version) |
_tSets_t _tthe_t _tSBML_t _tLevel_t _tand_t _tVersion_t _tof_t _tthis_t _tSBMLDocument_t_t, _tattempting_t _tto_t _tconvert_t _tthe_t _tmodel_t _tas_t _tneeded_t. | |
int | SBMLDocument_setLevelAndVersionNonStrict (SBMLDocument_t *d, unsigned int level, unsigned int version) |
_tSets_t _tthe_t _tSBML_t _tLevel_t _tand_t _tVersion_t _tof_t _tthis_t _tSBMLDocument_t_t, _tattempting_t _tto_t _tconvert_t _tthe_t _tmodel_t _tas_t _tneeded_t. | |
int | SBMLDocument_setLevelAndVersionStrict (SBMLDocument_t *d, unsigned int level, unsigned int version) |
_tSets_t _tthe_t _tSBML_t _tLevel_t _tand_t _tVersion_t _tof_t _tthis_t _tSBMLDocument_t_t, _tattempting_t _tto_t _tconvert_t _tthe_t _tmodel_t _tas_t _tneeded_t. | |
void | SBMLDocument_setLocationURI (SBMLDocument_t *d, const char *location) |
_tSets_t _tthe_t _tlocation_t _tof_t _tthis_t _tSBMLDocument_t_t. | |
int | SBMLDocument_setModel (SBMLDocument_t *d, const Model_t *m) |
_tSets_t _tthe_t _tmodel_t _tcontained_t _tin_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tModel_t_t _tstructure_t. | |
int | SBMLDocument_setPackageRequired (SBMLDocument_t *d, const char *package, int flag) |
_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t <_tcode_t>_trequired_t</_tcode_t> _tattribute_t _tfor_t _tthe_t _tgiven_t _tpackage_t. | |
int | SBMLDocument_setPkgRequired (SBMLDocument_t *d, const char *package, int flag) |
_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t <_tcode_t>_trequired_t</_tcode_t> _tattribute_t _tfor_t _tthe_t _tgiven_t _tpackage_t. | |
int | SBMLDocument_setSBMLNamespaces (SBMLDocument_t *d, SBMLNamespaces_t *sbmlns) |
_tSets_t _tthe_t _tSBMLNamespaces_t_t _ton_t _tthe_t _tgiven_t _tSBMLDocument_t_t. | |
unsigned int | SBMLDocument_validateSBML (SBMLDocument_t *d) |
_tPerforms_t _tconsistency_t _tchecking_t _tand_t _tvalidation_t _ton_t _tthe_t _tgiven_t _tSBML_t _tdocument_t. | |
Implementation of the top-level container for an SBML Model_t and associated data.
unsigned int SBMLDocument_checkConsistency | ( | SBMLDocument_t * | d | ) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tand_t _tvalidation_t _tchecks_t _ton_t _tthe_t _tgiven_t _tSBML_t _tdocument_t.
_tIf_t _tthis_t _tmethod_t _treturns_t _ta_t _tnonzero_t _tvalue_t (_tmeaning_t, _tone_t _tor_t _tmore_t _tconsistency_t _tchecks_t _thave_t _tfailed_t _tfor_t _tSBML_t _tdocument_t), _tthe_t _tfailures_t _tmay_t _tbe_t _tdue_t _tto_t _twarnings_t @_tem_t _tor_t _terrors_t. _tCallers_t _tshould_t _tinspect_t _tthe_t _tseverity_t _tflag_t _tin_t _tthe_t _tindividual_t _tSBMLError_t_t _tstructures_t _treturned_t _tby_t _tSBMLDocument_getError_t() _tto_t _tdetermine_t _tthe_t _tnature_t _tof_t _tthe_t _tfailures_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _tfailed_t _tchecks_t (_terrors_t) _tencountered_t.
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_checkInternalConsistency | ( | SBMLDocument_t * | d | ) |
_tPerforms_t _tconsistency_t _tchecking_t _ton_t _tlibSBML_t'_ts_t _tinternal_t _trepresentation_t _tof_t _tan_t _tSBML_t _tModel_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _tfailed_t _tchecks_t (_terrors_t) _tencountered_t.
@_tnote_t _tThe_t _tconsistency_t _tchecks_t _tperformed_t _tby_t _tthis_t _tfunction_t _tare_t _tlimited_t _tto_t _tinconsistencies_t _tthat_t _tare_t _tnot_t _tcaught_t _tby_t _tother_t _tconsistency_t _tchecks_t. @_tsee_t _tsetConsistencyChecks_t()
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_checkL1Compatibility | ( | SBMLDocument_t * | d | ) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t&_tnbsp_t;_t1_t.
_tCallers_t _tshould_t _tquery_t _tthe_t _tresults_t _tof_t _tthe_t _tconsistency_t _tcheck_t _tby_t _tcalling_t _tSBMLDocument_getError_t().
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _tfailed_t _tchecks_t (_terrors_t) _tencountered_t.
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_checkL2v1Compatibility | ( | SBMLDocument_t * | d | ) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t1_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t1_t.
_tCallers_t _tshould_t _tquery_t _tthe_t _tresults_t _tof_t _tthe_t _tconsistency_t _tcheck_t _tby_t _tcalling_t _tSBMLDocument_getError_t().
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _tfailed_t _tchecks_t (_terrors_t) _tencountered_t.
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_checkL2v2Compatibility | ( | SBMLDocument_t * | d | ) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t2_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t2_t.
_tCallers_t _tshould_t _tquery_t _tthe_t _tresults_t _tof_t _tthe_t _tconsistency_t _tcheck_t _tby_t _tcalling_t _tSBMLDocument_getError_t().
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _tfailed_t _tchecks_t (_terrors_t) _tencountered_t.
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_checkL2v3Compatibility | ( | SBMLDocument_t * | d | ) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t3_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t3_t.
_tCallers_t _tshould_t _tquery_t _tthe_t _tresults_t _tof_t _tthe_t _tconsistency_t _tcheck_t _tby_t _tcalling_t _tSBMLDocument_getError_t().
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _tfailed_t _tchecks_t (_terrors_t) _tencountered_t.
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_checkL2v4Compatibility | ( | SBMLDocument_t * | d | ) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t4_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t4_t.
_tCallers_t _tshould_t _tquery_t _tthe_t _tresults_t _tof_t _tthe_t _tconsistency_t _tcheck_t _tby_t _tcalling_t _tSBMLDocument_getError_t().
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _tfailed_t _tchecks_t (_terrors_t) _tencountered_t.
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_checkL2v5Compatibility | ( | SBMLDocument_t * | d | ) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t5_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t _t2_t _tVersion_t _t5_t.
_tCallers_t _tshould_t _tquery_t _tthe_t _tresults_t _tof_t _tthe_t _tconsistency_t _tcheck_t _tby_t _tcalling_t _tSBMLDocument_getError_t().
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t
@_treturn_t _tthe_t _tnumber_t _tof_t _tfailed_t _tchecks_t (_terrors_t) _tencountered_t.
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_checkL3v1Compatibility | ( | SBMLDocument_t * | d | ) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t _t3_t _tVersion_t _t1_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t _t3_t _tVersion_t _t1_t.
_tCallers_t _tshould_t _tquery_t _tthe_t _tresults_t _tof_t _tthe_t _tconsistency_t _tcheck_t _tby_t _tcalling_t _tSBMLDocument_getError_t().
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _tfailed_t _tchecks_t (_terrors_t) _tencountered_t.
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_checkL3v2Compatibility | ( | SBMLDocument_t * | d | ) |
_tPerforms_t _ta_t _tset_t _tof_t _tconsistency_t _tchecks_t _ton_t _tthe_t _tdocument_t _tto_t _testablish_t _twhether_t _tit_t _tis_t _tcompatible_t _twith_t _tSBML_t _tLevel_t _t3_t _tVersion_t _t2_t _tand_t _tcan_t _tbe_t _tconverted_t _tto_t _tLevel_t _t3_t _tVersion_t _t2_t.
_tCallers_t _tshould_t _tquery_t _tthe_t _tresults_t _tof_t _tthe_t _tconsistency_t _tcheck_t _tby_t _tcalling_t _tSBMLDocument_getError_t().
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _tfailed_t _tchecks_t (_terrors_t) _tencountered_t.
@_tmemberof_t _tSBMLDocument_t_t
SBMLDocument_t * SBMLDocument_clone | ( | const SBMLDocument_t * | d | ) |
_tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tSBMLDocument_t_t _tstructure_t
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_convert | ( | SBMLDocument_t * | d, |
const ConversionProperties_t * | props | ||
) |
_tConverts_t _tthis_t _tdocument_t _tusing_t _tthe_t _tconverter_t _tthat_t _tbest_t _tmatches_t _tthe_t _tgiven_t _tconversion_t _tproperties_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t. @_tparam_t _tprops_t _tthe_t _tconversion_t _tproperties_t _tto_t _tuse_t.
@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_CONV_CONVERSION_NOT_AVAILABLE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}
@_tmemberof_t _tSBMLDocument_t_t
SBMLDocument_t * SBMLDocument_create | ( | void | ) |
@_tendcond_t
@_tclass_t _tdoc_sbmldocument_default_level_t
@_tcond_t _tdoxygenIgnored_t
Model_t * SBMLDocument_createModel | ( | SBMLDocument_t * | d | ) |
_tCreates_t _ta_t _tnew_t _tModel_t_t _tstructure_t _tinside_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tModel_t_t _tstructure_t _tcreated_t
@_tmemberof_t _tSBMLDocument_t_t
SBMLDocument_t * SBMLDocument_createWithLevelAndVersion | ( | unsigned int | level, |
unsigned int | version | ||
) |
_tCreates_t _ta_t _tnew_t, _tempty_t _tSBMLDocument_t_t _tstructure_t _twith_t _tgiven_t _tvalues_t _tfor_t _tthe_t _tSBML_t _tLevel_t _tand_t _tVersion_t.
_tIf_t _tnot_t _tspecified_t, _tthe_t _tSBML_t _tLevel_t _tand_t _tVersion_t _tattributes_t _tdefault_t _tto_t _tthe_t _tmost_t _trecent_t _tSBML_t _tspecification_t (_tat_t _tthe_t _ttime_t _tthis_t _tlibSBML_t _twas_t _treleased_t).
@_tparam_t _tlevel_t _tan_t _tinteger_t _tfor_t _tthe_t _tSBML_t _tLevel_t. @_tparam_t _tversion_t _tan_t _tinteger_t _tfor_t _tthe_t _tVersion_t _twithin_t _tthe_t _tSBML_t _tLevel_t.
@_treturn_t _tthe_t _tSBMLDocument_t_t _tstructure_t _tcreated_t
@_tmemberof_t _tSBMLDocument_t_t
SBMLDocument_t * SBMLDocument_createWithSBMLNamespaces | ( | SBMLNamespaces_t * | sbmlns | ) |
_tCreates_t _ta_t _tnew_t _tSBMLDocument_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t @_tp_t _tsbmlns_t.
_tReturns_t _tNULL_t _tif_t _tthe_t @_tp_t _tsbmlns_t _tis_t _tinvalid_t.
@_tcopydetails_t _tdoc_what_are_sbmlnamespaces_t
@_tparam_t _tsbmlns_t _tan_t _tSBMLNamespaces_t_t _tstructure_t.
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_expandFunctionDefintions | ( | SBMLDocument_t * | d | ) |
_tRemoves_t _tany_t _tFunctionDefinition_t_t'_ts_t _tfrom_t _tthe_t _tdocument_t _tand_t _texpands_t _tany_t _tinstances_t _tof_t _ttheir_t _tuse_t _twithin_t &_tlt_t;_tmath_t&_tgt_t; _telements_t.
_tFor_t _texample_t _ta_t _tModel_t_t _tcontains_t _ta_t _tFunctionDefinition_t_t _twith_t _tid_t _tf_t _trepresenting_t _tthe_t _tmath_t _texpression_t: _tf_t(_tx_t, _ty_t) = _tx_t * _ty_t. _tThe_t _tmath_t _telement_t _tof_t _tthe_t _tKineticLaw_t_t _tuses_t _tf_t(_ts_t, _tp_t). _tThe_t _toutcome_t _tof_t _tthe_t _tfunction_t _tis_t _tthat_t _tthe_t _tmath_t _tof_t _tthe_t _tKineticLaw_t_t _tnow_t _trepresents_t _tthe_t _tmath_t _texpression_t: _ts_t * _tp_t _tand_t _tthe_t _tmodel_t _tno_t _tlonger_t _tcontains_t _tany_t _tFunctionDefinition_t_t'_ts_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _ttransformation_t _twas_t _tsuccessful_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tnote_t _tThis_t _tfunction_t _twill_t _tcheck_t _tthe_t _tconsistency_t _tof_t _ta_t _tmodel_t _tbefore_t _tattemptimg_t _tthe_t _ttransformation_t. _tIn_t _tthe_t _tcase_t _tof_t _ta_t _tmodel_t _twith_t _tinvalid_t _tSBML_t _tthe_t _ttransformation_t _twill_t _tnot_t _tbe_t _tdone_t _tand_t _tthe_t _tfunction_t _twill_t _treturn_t @_tc_t _tfalse_t.
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_expandInitialAssignments | ( | SBMLDocument_t * | d | ) |
_tRemoves_t _tany_t _tInitialAssignment_t_t'_ts_t _tfrom_t _tthe_t _tdocument_t _tand_t _treplaces_t _tthe_t _tappropriate_t _tvalues_t.
_tFor_t _texample_t _ta_t _tModel_t_t _tcontains_t _ta_t _tInitialAssignment_t_t _twith_t _tsymbol_t _tk_t _twhere_t _tk_t _tis_t _tthe_t _tid_t _tof_t _ta_t _tParameter_t_t. _tThe_t _toutcome_t _tof_t _tthe_t _tfunction_t _tis_t _tthat_t _tthe_t _tvalue_t _tattribute_t _tof_t _tthe_t _tParameter_t_t _tis_t _tthe_t _tvalue_t _tcalculated_t _tusing_t _tthe_t _tmath_t _texpression_t _tof_t _tthe_t _tInitialAssignment_t_t _tand_t _tthe_t _tcorresponding_t _tInitialAssignment_t_t _thas_t _tbeen_t _tremoved_t _tfrom_t _tthe_t _tModel_t_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _ttransformation_t _twas_t _tsuccessful_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tnote_t _tThis_t _tfunction_t _twill_t _tcheck_t _tthe_t _tconsistency_t _tof_t _ta_t _tmodel_t _tbefore_t _tattemptimg_t _tthe_t _ttransformation_t. _tIn_t _tthe_t _tcase_t _tof_t _ta_t _tmodel_t _twith_t _tinvalid_t _tSBML_t _tthe_t _ttransformation_t _twill_t _tnot_t _tbe_t _tdone_t _tand_t _tthe_t _tfunction_t _twill_t _treturn_t @_tc_t _tfalse_t. _tAs_t _tpart_t _tof_t _tthe_t _tprocess_t _tthe_t _tfunction_t _twill_t _tcheck_t _tthat_t _tit_t _thas_t _tvalues_t _tfor_t _tany_t _tcomponents_t _treferred_t _tto_t _tby_t _tthe_t _tmath_t _telements_t _tof_t _tInitialAssignment_t_t'_ts_t. _tIn_t _tthe_t _tcase_t _twhere_t _tnot_t _tall_t _tvalues_t _thave_t _tbeen_t _tdeclared_t _tthe_t _tparticular_t _tInitialAssignment_t_t _twill_t _tnot_t _tbe_t _tremoved_t _tand_t _tthe_t _tfunction_t _twill_t _treturn_t @_tc_t _tfalse_t.
@_tmemberof_t _tSBMLDocument_t_t
void SBMLDocument_free | ( | SBMLDocument_t * | d | ) |
_tFrees_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_getDefaultLevel | ( | ) |
@_treturn_t _tthe_t _tmost_t _trecent_t _tSBML_t _tspecification_t _tlevel_t (_tat_t _tthe_t _ttime_t _tthis_t _tlibSBML_t _twas_t _treleased_t).
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_getDefaultVersion | ( | ) |
@_treturn_t _tthe_t _tmost_t _trecent_t _tSBML_t _tspecification_t _tversion_t (_tat_t _tthe_t _ttime_t _tthis_t _tlibSBML_t _twas_t _treleased_t).
@_tmemberof_t _tSBMLDocument_t_t
const SBMLError_t * SBMLDocument_getError | ( | SBMLDocument_t * | d, |
unsigned int | n | ||
) |
_tReturns_t _tthe_t _tnth_t _terror_t _tor_t _twarning_t _tencountered_t _tduring_t _tparsing_t, _tconsistency_t _tchecking_t, _tor_t _tattempted_t _ttranslation_t _tof_t _tthis_t _tmodel_t.
_tCallers_t _tcan_t _tuse_t _tmethod_t _tXMLError_getSeverity_t() _ton_t _tthe_t _tresult_t _tto_t _tassess_t _tthe_t _tseverity_t _tof_t _tthe_t _tproblem_t. _tThe_t _tseverity_t _tlevels_t _trange_t _tfrom_t _tinformationl_t _tmessages_t _tto_t _tfatal_t _terrors_t.
@_treturn_t _tthe_t _terror_t _tor_t _twarning_t _tindexed_t _tby_t _tinteger_t @_tp_t _tn_t, _tor_t _treturn_t @_tc_t _tNULL_t _tif_t _tn_t > (_tSBMLDocument_getNumErrors_t() - _t1_t).
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_tparam_t _tn_t _tthe_t _tindex_t _tof_t _tthe_t _terror_t _tsought_t.
@_tsee_t _tSBMLDocument_getNumErrors_t(), _tSBMLDocument_setLevelAndVersion_t(), _tSBMLDocument_checkConsistency_t(), _tSBMLDocument_checkL1Compatibility_t(), _tSBMLDocument_checkL2v1Compatibility_t() _tSBMLDocument_checkL2v2Compatibility_t(), _tSBMLDocument_checkL2v3Compatibility_t(), _tSBMLDocument_checkL2v4Compatibility_t(), _tSBMLDocument_checkL2v5Compatibility_t(), _tSBMLDocument_checkL3v1Compatibility_t(), _tSBMLDocument_checkL3v2Compatibility_t(), _tSBMLReader_readSBML_t(), _tSBMLReader_readSBMLFromString_t().
@_tmemberof_t _tSBMLDocument_t_t
const SBMLErrorLog_t * SBMLDocument_getErrorLog | ( | SBMLDocument_t * | d | ) |
const SBMLError_t * SBMLDocument_getErrorWithSeverity | ( | SBMLDocument_t * | d, |
unsigned int | n, | ||
unsigned int | severity | ||
) |
_tReturns_t _tthe_t _tnth_t _terror_t _tor_t _twarning_t _twith_t _tthe_t _tgiven_t _tseverity_t _tencountered_t _tduring_t _tparsing_t, _tconsistency_t _tchecking_t, _tor_t _tattempted_t _ttranslation_t _tof_t _tthis_t _tmodel_t.
@_treturn_t _tthe_t _terror_t _tor_t _twarning_t _tindexed_t _tby_t _tinteger_t @_tp_t _tn_t, _tor_t _treturn_t @_tc_t _tNULL_t _tif_t _tn_t > (_tSBMLDocument_getNumErrorsWithSeverity_t() - _t1_t).
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_tparam_t _tn_t _tthe_t _tindex_t _tof_t _tthe_t _terror_t _tsought_t. @_tparam_t _tseverity_t _tthe_t _tseverity_t _tof_t _tthe_t _terror_t _tsought_t.
@_tsee_t _tSBMLDocument_getNumErrorsWithSeverity_t(), _tSBMLDocument_setLevelAndVersion_t(), _tSBMLDocument_checkConsistency_t(), _tSBMLDocument_checkL1Compatibility_t(), _tSBMLDocument_checkL2v1Compatibility_t() _tSBMLDocument_checkL2v2Compatibility_t(), _tSBMLDocument_checkL2v3Compatibility_t(), _tSBMLDocument_checkL2v4Compatibility_t(), _tSBMLDocument_checkL2v5Compatibility_t(), _tSBMLDocument_checkL3v1Compatibility_t(), _tSBMLDocument_checkL3v2Compatibility_t(), _tSBMLReader_readSBML_t(), _tSBMLReader_readSBMLFromString_t().
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_getLevel | ( | const SBMLDocument_t * | d | ) |
_tReturns_t _tthe_t _tSBML_t _tLevel_t _tof_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tSBML_t _tLevel_t _tnumber_t
@_tmemberof_t _tSBMLDocument_t_t
char * SBMLDocument_getLocationURI | ( | SBMLDocument_t * | d | ) |
_tGet_t _tthe_t _tlocation_t _tof_t _tthis_t _tSBMLDocument_t_t.
_tIf_t _tthis_t _tdocument_t _twas_t _tread_t _tfrom_t _ta_t _tfile_t _tor_t _thad_t _tits_t _tlocation_t _tset_t _tmanually_t, _tthat_t _tfilename_t _tor_t _tset_t _tlocation_t _twill_t _tbe_t _treturned_t, _totherwise_t, _tan_t _tempty_t _tstring_t _tis_t _treturned_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t _tto_t _tquery_t.
@_treturn_t _tThe_t _tfilename_t _tor_t _tset_t _tlocation_t _tof_t _tthe_t _tdocument_t, _tor_t _tan_t _tempty_t _tstring_t _tif_t _tno_t _tsuch_t _tinformation_t _tis_t _tfound_t.
@_tmemberof_t _tSBMLDocument_t_t
Model_t * SBMLDocument_getModel | ( | SBMLDocument_t * | d | ) |
_tReturns_t _tthe_t _tModel_t_t _tstructure_t _tstored_t _tin_t _tthis_t _tSBMLDocument_t_t _tstructure_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tModel_t_t _tcontained_t _tin_t _tthis_t _tSBMLDocument_t_t _tstructure_t.
@_tmemberof_t _tSBMLDocument_t_t
const XMLNamespaces_t * SBMLDocument_getNamespaces | ( | SBMLDocument_t * | d | ) |
_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthe_t _tXML_t _tcontent_t _tof_t _tthis_t _tSBML_t _tdocument_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tpointer_t _tto_t _tthe_t _tXMLNamespaces_t_t _tstructure_t _tassociated_t _twith_t _tthis_t _tSBML_t _tstructure_t.
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_getNumErrors | ( | const SBMLDocument_t * | d | ) |
_tReturns_t _tthe_t _tnumber_t _tof_t _terrors_t _tor_t _twarnings_t _tencountered_t _tduring_t _tparsing_t, _tconsistency_t _tchecking_t, _tor_t _tattempted_t _ttranslation_t _tof_t _tthis_t _tmodel_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _terrors_t _tor_t _twarnings_t _tencountered_t
@_tsee_t _tSBMLDocument_setLevelAndVersion_t(), _tSBMLDocument_checkConsistency_t(), _tSBMLDocument_checkL1Compatibility_t(), _tSBMLDocument_checkL2v1Compatibility_t() _tSBMLDocument_checkL2v2Compatibility_t(), _tSBMLDocument_checkL2v3Compatibility_t(), _tSBMLDocument_checkL2v4Compatibility_t(), _tSBMLDocument_checkL2v5Compatibility_t(), _tSBMLDocument_checkL3v1Compatibility_t(), _tSBMLDocument_checkL3v2Compatibility_t(), _tSBMLReader_readSBML_t(), _tSBMLReader_readSBMLFromString_t().
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_getNumErrorsWithSeverity | ( | const SBMLDocument_t * | d, |
unsigned int | severity | ||
) |
_tReturns_t _tthe_t _tnumber_t _tof_t _terrors_t _tor_t _twarnings_t _tencountered_t _tduring_t _tparsing_t, _tconsistency_t _tchecking_t, _tor_t _tattempted_t _ttranslation_t _tof_t _tthis_t _tmodel_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t. @_tparam_t _tseverity_t _tthe_t _tseverity_t _trequested_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _terrors_t _tor_t _twarnings_t _tencountered_t _twith_t _tthe_t _tgiven_t _tseverity_t _tlevel_t
@_tsee_t _tSBMLDocument_setLevelAndVersion_t(), _tSBMLDocument_checkConsistency_t(), _tSBMLDocument_checkL1Compatibility_t(), _tSBMLDocument_checkL2v1Compatibility_t() _tSBMLDocument_checkL2v2Compatibility_t(), _tSBMLDocument_checkL2v3Compatibility_t(), _tSBMLDocument_checkL2v4Compatibility_t(), _tSBMLDocument_checkL2v5Compatibility_t(), _tSBMLDocument_checkL3v1Compatibility_t(), _tSBMLDocument_checkL3v2Compatibility_t(), _tSBMLReader_readSBML_t(), _tSBMLReader_readSBMLFromString_t().
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_getPackageRequired | ( | SBMLDocument_t * | d, |
const char * | package | ||
) |
_tReturns_t _tthe_t <_tcode_t>_trequired_t</_tcode_t> _tattribute_t _tof_t _tthe_t _tgiven_t _tpackage_t _textension_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t _tto_t _tcheck_t. @_tparam_t _tpackage_t _tthe_t _tname_t _tor_t _tURI_t _tof_t _tthe_t _tpackage_t _textension_t. _tPassing_t _ta_t _tpackage_t _tname_t (_tor_t "_tnickname_t") _tis_t _tonly_t _tsupported_t _tif_t _tlibSBML_t _twas_t _tcompiled_t _twith_t _tsupport_t _tfor_t _tthat_t _tparticular_t _tpackage_t, _tsee_t _tthe_t _tinstallation_t _tdocumentation_t _tfor_t _tmore_t _tdetails_t. _tPassing_t _tthe_t _tpackage_t _tURI_t _tis_t _tsupported_t _tregardless_t _tof_t _tthe_t _tinstallation_t _tconfiguration_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tpackage_t _tis_t _tflagged_t _tas_t _tbeing_t _trequired_t _tin_t _tthis_t _tSBML_t _tdocument_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_getPkgRequired | ( | SBMLDocument_t * | d, |
const char * | package | ||
) |
_tReturns_t _tthe_t <_tcode_t>_trequired_t</_tcode_t> _tattribute_t _tof_t _tthe_t _tgiven_t _tpackage_t _textension_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t _tto_t _tcheck_t. @_tparam_t _tpackage_t _tthe_t _tname_t _tor_t _tURI_t _tof_t _tthe_t _tpackage_t _textension_t. _tPassing_t _ta_t _tpackage_t _tname_t (_tor_t "_tnickname_t") _tis_t _tonly_t _tsupported_t _tif_t _tlibSBML_t _twas_t _tcompiled_t _twith_t _tsupport_t _tfor_t _tthat_t _tparticular_t _tpackage_t, _tsee_t _tthe_t _tinstallation_t _tdocumentation_t _tfor_t _tmore_t _tdetails_t. _tPassing_t _tthe_t _tpackage_t _tURI_t _tis_t _tsupported_t _tregardless_t _tof_t _tthe_t _tinstallation_t _tconfiguration_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tpackage_t _tis_t _tflagged_t _tas_t _tbeing_t _trequired_t _tin_t _tthis_t _tSBML_t _tdocument_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tdeprecated_t _tReplaced_t _tin_t _tlibSBML_t _t5_t._t2_t._t0_t _tby_t _tSBMLDocument_getPackageRequired_t()
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_getVersion | ( | const SBMLDocument_t * | d | ) |
_tReturns_t _tthe_t _tVersion_t _twithin_t _tthe_t _tSBML_t _tLevel_t _tof_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tversion_t _tnumber_t
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_isSetModel | ( | const SBMLDocument_t * | d | ) |
_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tidentifier_t _tof_t _ta_t _tgiven_t _tSBMLDocument_t_t _tstructure_t _tis_t _tassigned_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tmodel_t _tobject_t _tof_t _tthis_t _tSBMLDocument_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_isSetPackageRequired | ( | SBMLDocument_t * | d, |
const char * | package | ||
) |
_tTests_t _twhether_t _tthe_t _trequired_t _tattribute_t _tof_t _tthe_t _tgiven_t _tpackage_t _textension_t _tis_t _tdefined_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t. @_tparam_t _tpackage_t _tthe_t _tname_t _tor_t _tURI_t _tof_t _tthe_t _tpackage_t _textension_t. _tPassing_t _ta_t _tpackage_t _tname_t (_tor_t "_tnickname_t") _tis_t _tonly_t _tsupported_t _tif_t _tlibSBML_t _twas_t _tcompiled_t _twith_t _tsupport_t _tfor_t _tthat_t _tparticular_t _tpackage_t, _tsee_t _tthe_t _tinstallation_t _tdocumentation_t _tfor_t _tmore_t _tdetails_t. _tPassing_t _tthe_t _tpackage_t _tURI_t _tis_t _tsupported_t _tregardless_t _tof_t _tthe_t _tinstallation_t _tconfiguration_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _trequired_t _tattribute_t _tof_t _tthe_t _tgiven_t _tpackage_t _textension_t _tis_t _tdefined_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_isSetPkgRequired | ( | SBMLDocument_t * | d, |
const char * | package | ||
) |
_tTests_t _twhether_t _tthe_t _trequired_t _tattribute_t _tof_t _tthe_t _tgiven_t _tpackage_t _textension_t _tis_t _tdefined_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t. @_tparam_t _tpackage_t _tthe_t _tname_t _tor_t _tURI_t _tof_t _tthe_t _tpackage_t _textension_t. _tPassing_t _ta_t _tpackage_t _tname_t (_tor_t "_tnickname_t") _tis_t _tonly_t _tsupported_t _tif_t _tlibSBML_t _twas_t _tcompiled_t _twith_t _tsupport_t _tfor_t _tthat_t _tparticular_t _tpackage_t, _tsee_t _tthe_t _tinstallation_t _tdocumentation_t _tfor_t _tmore_t _tdetails_t. _tPassing_t _tthe_t _tpackage_t _tURI_t _tis_t _tsupported_t _tregardless_t _tof_t _tthe_t _tinstallation_t _tconfiguration_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _trequired_t _tattribute_t _tof_t _tthe_t _tgiven_t _tpackage_t _textension_t _tis_t _tdefined_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tdeprecated_t _tReplaced_t _tin_t _tlibSBML_t _t5_t._t2_t._t0_t _tby_t _tSBMLDocument_isSetPackageRequired_t()
@_tmemberof_t _tSBMLDocument_t_t
void SBMLDocument_printErrors | ( | SBMLDocument_t * | d, |
FILE * | stream | ||
) |
_tPrints_t _tto_t _tthe_t _tgiven_t _toutput_t _tstream_t _tall_t _tthe_t _terrors_t _tor_t _twarnings_t _tencountered_t _tduring_t _tparsing_t, _tconsistency_t _tchecking_t, _tor_t _tattempted_t _ttranslation_t _tof_t _tthis_t _tmodel_t.
_tIf_t _tno_t _terrors_t _thave_t _toccurred_t, _ti_t._te_t., _tSBMLDocument_getNumErrors_t() == _t0_t, _tno_t _toutput_t _twill_t _tbe_t _tsent_t _tto_t _tthe_t _tstream_t.
_tThe_t _tformat_t _tof_t _tthe_t _toutput_t _tis_t:
_tN_t _terror_t(_ts_t): _tline_t _tNNN_t: (_tid_t) _tmessage_t
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_tparam_t _tstream_t _tthe_t _toutput_t _tstream_t _twhere_t _tthe_t _tmessages_t _tshould_t _tbe_t _tprinted_t.
@_tmemberof_t _tSBMLDocument_t_t
void SBMLDocument_setConsistencyChecks | ( | SBMLDocument_t * | d, |
SBMLErrorCategory_t | category, | ||
int | apply | ||
) |
_tAllows_t _tparticular_t _tvalidators_t _tto_t _tbe_t _tturned_t _ton_t _tor_t _toff_t _tprior_t _tto_t _tcalling_t _tcheckConsistency_t.
_tThe_t _tsecond_t _targument_t (@_tp_t _tcategory_t) _tto_t _tthis_t _tmethod_t _tindicates_t _twhich_t _tcategory_t _tof_t _tconsistency_t/_terror_t _tchecks_t _tare_t _tbeing_t _tturned_t _ton_t _tor_t _toff_t, _tand_t _tthe_t _tthird_t _targument_t (_tan_t _tinteger_t _ttreated_t _tas_t _ta_t _tboolean_t, _twith_t @_tc_t _tnonzero_t _tindicating_t @_tc_t _ttrue_t _tand_t @_tc_t _tzero_t _tindicating_t @_tc_t _tfalse_t) _tindicates_t _twhether_t _tto_t _tturn_t _ton_t (@_tc_t _ttrue_t) _tor_t _toff_t (@_tc_t _tfalse_t) _tthat_t _tparticular_t _tcategory_t _tof_t _tchecks_t. _tThe_t _tpossible_t _tcategories_t _tare_t _trepresented_t _tas_t _tvalues_t _tof_t _tthe_t _tenumeration_t _tSBMLErrorCategory_t_t. _tThe_t _tfollowing_t _tare_t _tthe_t _tpossible_t _tchoices_t:
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_GENERAL_CONSISTENCY_t, _tSBMLErrorCategory_t_t}: _tGeneral_t _toverall_t _tSBML_t _tconsistency_t.
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_IDENTIFIER_CONSISTENCY_t, _tSBMLErrorCategory_t_t}: _tConsistency_t _tof_t _tidentifiers_t. _tAn_t _texample_t _tof_t _tinconsistency_t _twould_t _tbe_t _tusing_t _ta_t _tspecies_t _tidentifier_t _tin_t _ta_t _treaction_t _trate_t _tformula_t _twithout_t _tfirst_t _thaving_t _tdeclared_t _tthe_t _tspecies_t.
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_UNITS_CONSISTENCY_t, _tSBMLErrorCategory_t_t}: _tConsistency_t _tof_t _tunits_t _tof_t _tmeasure_t.
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_MATHML_CONSISTENCY_t, _tSBMLErrorCategory_t_t}: _tConsistency_t _tof_t _tMathML_t _tconstructs_t.
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_SBO_CONSISTENCY_t, _tSBMLErrorCategory_t_t}: _tConsistency_t _tof_t _tSBO_t _tidentifiers_t.
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_OVERDETERMINED_MODEL_t, _tSBMLErrorCategory_t_t}: _tChecking_t _twhether_t _tthe_t _tsystem_t _tof_t _tequations_t _timplied_t _tby_t _ta_t _tmodel_t _tis_t _tmathematically_t _toverdetermined_t.
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_MODELING_PRACTICE_t, _tSBMLErrorCategory_t_t}: _tGeneral_t _tgood_t _tpractice_t _tin_t _tmodel_t _tconstruction_t.
_tBy_t _tdefault_t, _tall_t _tvalidation_t _tchecks_t _tare_t _tapplied_t _tto_t _tthe_t _tmodel_t _tin_t _tan_t _tSBMLDocument_t_t _tstructure_t @_tem_t _tunless_t _tsetConsistencyChecks_t() _tis_t _tcalled_t _tto_t _tindicate_t _tthat_t _tonly_t _ta_t _tsubset_t _tshould_t _tbe_t _tapplied_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_tparam_t _tcategory_t _ta_t _tvalue_t _tdrawn_t _tfrom_t _tSBMLErrorCategory_t_t _tindicating_t _tthe_t _tconsistency_t _tchecking_t/_tvalidation_t _tto_t _tbe_t _tturned_t _ton_t _tor_t _toff_t.
@_tparam_t _tapply_t _tan_t _tinteger_t _tindicating_t _twhether_t _tthe_t _tchecks_t _tindicated_t _tby_t @_tp_t _tcategory_t _tshould_t _tbe_t _tapplied_t _tor_t _tnot_t, _twith_t @_tc_t _tnonzero_t _tindicating_t @_tc_t _ttrue_t, _tand_t @_tc_t _tzero_t _tindicating_t @_tc_t _tfalse_t.
@_tnote_t _tThe_t _tdefault_t (_ti_t._te_t., _tperforming_t _tall_t _tchecks_t) _tapplies_t _tto_t _teach_t _tnew_t _tSBMLDocument_t_t _tstructure_t _tcreated_t. _tThis_t _tmeans_t _tthat_t _teach_t _ttime_t _ta_t _tmodel_t _tis_t _tread_t _tusing_t _tSBMLReader_readSBML_t(), _tSBMLReader_readSBMLFromString_t(), _tor_t _tthe_t _tglobal_t _tfunctions_t _treadSBML_t() _tand_t _treadSBMLFromString_t(), _ta_t _tnew_t _tSBMLDocument_t _tis_t _tcreated_t _tand_t _tfor_t _tthat_t _tdocument_t _tall_t _tchecks_t _tare_t _tenabled_t.
@_tsee_t _tSBMLDocument_checkConsistency_t()
@_tmemberof_t _tSBMLDocument_t_t
void SBMLDocument_setConsistencyChecksForConversion | ( | SBMLDocument_t * | d, |
SBMLErrorCategory_t | category, | ||
int | apply | ||
) |
_tAllows_t _tparticular_t _tvalidators_t _tto_t _tbe_t _tturned_t _ton_t _tor_t _toff_t _tprior_t _tto_t _tcalling_t _tsetLevelAndVersion_t.
_tThe_t _tsecond_t _targument_t (@_tp_t _tcategory_t) _tto_t _tthis_t _tmethod_t _tindicates_t _twhich_t _tcategory_t _tof_t _tconsistency_t/_terror_t _tchecks_t _tare_t _tbeing_t _tturned_t _ton_t _tor_t _toff_t, _tand_t _tthe_t _tsecond_t _targument_t (_ta_t _tboolean_t) _tindicates_t _twhether_t _tto_t _tturn_t _ton_t (_tvalue_t _tof_t @_tc_t _ttrue_t) _tor_t _toff_t (_tvalue_t _tof_t @_tc_t _tfalse_t) _tthat_t _tparticula_t _tcategory_t _tof_t _tchecks_t. _tThe_t _tpossible_t _tcategories_t _tare_t _trepresented_t _tas_t _tvalues_t _tof_t _tthe_t _tenumeration_t _tSBMLErrorCategory_t_t. _tThe_t _tfollowing_t _tare_t _tthe_t _tpossible_t _tchoices_t _tin_t _tlibSBML_t _tversion_t _t3_t._t0_t._t2_t:
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_GENERAL_CONSISTENCY_t, _tSBMLErrorCategory_t_t}: _tGeneral_t _toverall_t _tSBML_t _tconsistency_t.
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_IDENTIFIER_CONSISTENCY_t, _tSBMLErrorCategory_t_t}: _tConsistency_t _tof_t _tidentifiers_t. _tAn_t _texample_t _tof_t _tinconsistency_t _twould_t _tbe_t _tusing_t _ta_t _tspecies_t _tidentifier_t _tin_t _ta_t _treaction_t _trate_t _tformula_t _twithout_t _tfirst_t _thaving_t _tdeclared_t _tthe_t _tspecies_t.
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_UNITS_CONSISTENCY_t, _tSBMLErrorCategory_t_t}: _tConsistency_t _tof_t _tunits_t _tof_t _tmeasure_t.
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_MATHML_CONSISTENCY_t, _tSBMLErrorCategory_t_t}: _tConsistency_t _tof_t _tMathML_t _tconstructs_t.
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_SBO_CONSISTENCY_t, _tSBMLErrorCategory_t_t}: _tConsistency_t _tof_t _tSBO_t _tidentifiers_t.
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_OVERDETERMINED_MODEL_t, _tSBMLErrorCategory_t_t}: _tChecking_t _twhether_t _tthe_t _tsystem_t _tof_t _tequations_t _timplied_t _tby_t _ta_t _tmodel_t _tis_t _tmathematically_t _toverdetermined_t.
@_tli_t @_tsbmlconstant_t{_tLIBSBML_CAT_MODELING_PRACTICE_t, _tSBMLErrorCategory_t_t}: _tGeneral_t _tgood_t _tpractice_t _tin_t _tmodel_t _tconstruction_t.
_tBy_t _tdefault_t, _tall_t _tvalidation_t _tchecks_t _tare_t _tapplied_t _tto_t _tthe_t _tmodel_t _tin_t _tan_t _tSBMLDocument_t_t _tstructure_t @_tem_t _tunless_t _tsetConsistencyChecks_t() _tis_t _tcalled_t _tto_t _tindicate_t _tthat_t _tonly_t _ta_t _tsubset_t _tshould_t _tbe_t _tapplied_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_tparam_t _tcategory_t _ta_t _tvalue_t _tdrawn_t _tfrom_t _tSBMLErrorCategory_t_t _tindicating_t _tthe_t _tconsistency_t _tchecking_t/_tvalidation_t _tto_t _tbe_t _tturned_t _ton_t _tor_t _toff_t.
@_tparam_t _tapply_t _tan_t _tinteger_t _tindicating_t _twhether_t _tthe_t _tchecks_t _tindicated_t _tby_t @_tp_t _tcategory_t _tshould_t _tbe_t _tapplied_t _tor_t _tnot_t, _twith_t @_tc_t _tnonzero_t _tindicating_t @_tc_t _ttrue_t, _tand_t @_tc_t _tzero_t _tindicating_t @_tc_t _tfalse_t.
@_tnote_t _tThe_t _tdefault_t (_ti_t._te_t., _tperforming_t _tall_t _tchecks_t) _tapplies_t _tto_t _teach_t _tnew_t _tSBMLDocument_t_t _tstructure_t _tcreated_t. _tThis_t _tmeans_t _tthat_t _teach_t _ttime_t _ta_t _tmodel_t _tis_t _tread_t _tusing_t _tSBMLReader_readSBML_t(), _tSBMLReader_readSBMLFromString_t(), _tor_t _tthe_t _tglobal_t _tfunctions_t _treadSBML_t() _tand_t _treadSBMLFromString_t(), _ta_t _tnew_t _tSBMLDocument_t _tis_t _tcreated_t _tand_t _tfor_t _tthat_t _tdocument_t _tall_t _tchecks_t _tare_t _tenabled_t.
@_tsee_t _tSBMLDocument_setLevelAndVersionStrict_t()
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_setLevelAndVersion | ( | SBMLDocument_t * | d, |
unsigned int | level, | ||
unsigned int | version | ||
) |
_tSets_t _tthe_t _tSBML_t _tLevel_t _tand_t _tVersion_t _tof_t _tthis_t _tSBMLDocument_t_t, _tattempting_t _tto_t _tconvert_t _tthe_t _tmodel_t _tas_t _tneeded_t.
_tThis_t _tmethod_t _tis_t _tused_t _tto_t _tconvert_t _tmodels_t _tbetween_t _tLevels_t _tand_t _tVersions_t _tof_t _tSBML_t. _tGenerally_t, _tmodels_t _tcan_t _tbe_t _tconverted_t _tupward_t _twithout_t _tdifficulty_t (_te_t._tg_t., _tfrom_t _tSBML_t _tLevel_t _t1_t _tto_t _tLevel_t _t2_t, _tor_t _tfrom_t _tan_t _tearlier_t _tversion_t _tof_t _tLevel_t _t2_t _tto_t _tthe_t _tlatest_t _tversion_t _tof_t _tLevel_t _t2_t). _tSometimes_t _tmodels_t _tcan_t _tbe_t _ttranslated_t _tdownward_t _tas_t _twell_t, _tif_t _tthey_t _tdo_t _tnot_t _tuse_t _tconstructs_t _tspecific_t _tto_t _tmore_t _tadvanced_t _tLevels_t _tof_t _tSBML_t.
_tCallers_t _tcan_t _talso_t _tcheck_t _tcompatibility_t _tdirectly_t _tusing_t _tthe_t _tmethods_t _tSBMLDocument_checkL1Compatibility_t(), _tSBMLDocument_checkL2v1Compatibility_t(), _tSBMLDocument_checkL2v2Compatibility_t(), _tSBMLDocument_checkL2v3Compatibility_t(), _tSBMLDocument_checkL2v4Compatibility_t(), _tSBMLDocument_checkL2v5Compatibility_t(), _tSBMLDocument_checkL3v1Compatibility_t(), _tand_t _tSBMLDocument_checkL3v2Compatibility_t().
_tThe_t _tvalid_t _tcombinations_t _tas_t _tof_t _tthis_t _trelease_t _tof_t _tlibSBML_t _tare_t _tthe_t _tfollowing_t:
@_tli_t _tLevel_t _t1_t _tVersion_t _t1_t @_tli_t _tLevel_t _t1_t _tVersion_t _t2_t @_tli_t _tLevel_t _t2_t _tVersion_t _t1_t @_tli_t _tLevel_t _t2_t _tVersion_t _t2_t @_tli_t _tLevel_t _t2_t _tVersion_t _t3_t @_tli_t _tLevel_t _t2_t _tVersion_t _t4_t @_tli_t _tLevel_t _t2_t _tVersion_t _t5_t @_tli_t _tLevel_t _t3_t _tVersion_t _t1_t @_tli_t _tLevel_t _t3_t _tVersion_t _t2_t
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_tparam_t _tlevel_t _tthe_t _tdesired_t _tSBML_t _tLevel_t.
@_tparam_t _tversion_t _tthe_t _tdesired_t _tVersion_t _twithin_t _tthe_t _tSBML_t _tLevel_t.
@_tnote_t _tCalling_t _tthis_t _tmethod_t _twill_t _tnot_t @_tem_t _tnecessarily_t _tlead_t _tto_t _tsuccessful_t _tconversion_t. _tIf_t _tthe_t _tconversion_t _tfails_t, _tit_t _twill_t _tbe_t _tlogged_t _tin_t _tthe_t _terror_t _tlist_t _tassociated_t _twith_t _tthis_t _tSBMLDocument_t_t _tstructure_t. _tCallers_t _tshould_t _tconsult_t _tSBMLDocument_getNumErrors_t() _tto_t _tfind_t _tout_t _tif_t _tthe_t _tconversion_t _tsucceeded_t _twithout_t _tproblems_t. _tFor_t _tconversions_t _tfrom_t _tLevel_t _t2_t _tto_t _tLevel_t _t1_t, _tcallers_t _tcan_t _talso_t _tcheck_t _tthe_t _tLevel_t _tof_t _tthe_t _tmodel_t _tafter_t _tcalling_t _tthis_t _tmethod_t _tto_t _tfind_t _tout_t _twhether_t _tit_t _tis_t _tLevel_t _t1_t. (_tIf_t _tthe_t _tconversion_t _tto_t _tLevel_t _t1_t _tfailed_t, _tthe_t _tLevel_t _tof_t _tthis_t _tmodel_t _twill_t _tbe_t _tleft_t _tunchanged_t.)
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_setLevelAndVersionNonStrict | ( | SBMLDocument_t * | d, |
unsigned int | level, | ||
unsigned int | version | ||
) |
_tSets_t _tthe_t _tSBML_t _tLevel_t _tand_t _tVersion_t _tof_t _tthis_t _tSBMLDocument_t_t, _tattempting_t _tto_t _tconvert_t _tthe_t _tmodel_t _tas_t _tneeded_t.
_tThis_t _tmethod_t _tis_t _tused_t _tto_t _tconvert_t _tmodels_t _tbetween_t _tLevels_t _tand_t _tVersions_t _tof_t _tSBML_t. _tGenerally_t, _tmodels_t _tcan_t _tbe_t _tconverted_t _tupward_t _twithout_t _tdifficulty_t (_te_t._tg_t., _tfrom_t _tSBML_t _tLevel_t _t1_t _tto_t _tLevel_t _t2_t, _tor_t _tfrom_t _tan_t _tearlier_t _tversion_t _tof_t _tLevel_t _t2_t _tto_t _tthe_t _tlatest_t _tversion_t _tof_t _tLevel_t _t2_t). _tSometimes_t _tmodels_t _tcan_t _tbe_t _ttranslated_t _tdownward_t _tas_t _twell_t, _tif_t _tthey_t _tdo_t _tnot_t _tuse_t _tconstructs_t _tspecific_t _tto_t _tmore_t _tadvanced_t _tLevels_t _tof_t _tSBML_t.
_tCallers_t _tcan_t _talso_t _tcheck_t _tcompatibility_t _tdirectly_t _tusing_t _tthe_t _tmethods_t _tSBMLDocument_checkL1Compatibility_t(), _tSBMLDocument_checkL2v1Compatibility_t(), _tSBMLDocument_checkL2v2Compatibility_t(), _tSBMLDocument_checkL2v3Compatibility_t(), _tSBMLDocument_checkL2v4Compatibility_t(), _tSBMLDocument_checkL2v5Compatibility_t(), _tSBMLDocument_checkL3v1Compatibility_t(), _tand_t _tSBMLDocument_checkL3v2Compatibility_t().
_tThe_t _tvalid_t _tcombinations_t _tas_t _tof_t _tthis_t _trelease_t _tof_t _tlibSBML_t _tare_t _tthe_t _tfollowing_t:
@_tli_t _tLevel_t _t1_t _tVersion_t _t1_t @_tli_t _tLevel_t _t1_t _tVersion_t _t2_t @_tli_t _tLevel_t _t2_t _tVersion_t _t1_t @_tli_t _tLevel_t _t2_t _tVersion_t _t2_t @_tli_t _tLevel_t _t2_t _tVersion_t _t3_t @_tli_t _tLevel_t _t2_t _tVersion_t _t4_t @_tli_t _tLevel_t _t2_t _tVersion_t _t5_t @_tli_t _tLevel_t _t3_t _tVersion_t _t1_t @_tli_t _tLevel_t _t3_t _tVersion_t _t2_t
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_tparam_t _tlevel_t _tthe_t _tdesired_t _tSBML_t _tLevel_t.
@_tparam_t _tversion_t _tthe_t _tdesired_t _tVersion_t _twithin_t _tthe_t _tSBML_t _tLevel_t.
@_tnote_t _tCalling_t _tthis_t _tmethod_t _twill_t _tnot_t @_tem_t _tnecessarily_t _tlead_t _tto_t _tsuccessful_t _tconversion_t. _tIf_t _tthe_t _tconversion_t _tfails_t, _tit_t _twill_t _tbe_t _tlogged_t _tin_t _tthe_t _terror_t _tlist_t _tassociated_t _twith_t _tthis_t _tSBMLDocument_t_t _tstructure_t. _tCallers_t _tshould_t _tconsult_t _tSBMLDocument_getNumErrors_t() _tto_t _tfind_t _tout_t _tif_t _tthe_t _tconversion_t _tsucceeded_t _twithout_t _tproblems_t. _tFor_t _tconversions_t _tfrom_t _tLevel_t _t2_t _tto_t _tLevel_t _t1_t, _tcallers_t _tcan_t _talso_t _tcheck_t _tthe_t _tLevel_t _tof_t _tthe_t _tmodel_t _tafter_t _tcalling_t _tthis_t _tmethod_t _tto_t _tfind_t _tout_t _twhether_t _tit_t _tis_t _tLevel_t _t1_t. (_tIf_t _tthe_t _tconversion_t _tto_t _tLevel_t _t1_t _tfailed_t, _tthe_t _tLevel_t _tof_t _tthis_t _tmodel_t _twill_t _tbe_t _tleft_t _tunchanged_t.)
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_setLevelAndVersionStrict | ( | SBMLDocument_t * | d, |
unsigned int | level, | ||
unsigned int | version | ||
) |
_tSets_t _tthe_t _tSBML_t _tLevel_t _tand_t _tVersion_t _tof_t _tthis_t _tSBMLDocument_t_t, _tattempting_t _tto_t _tconvert_t _tthe_t _tmodel_t _tas_t _tneeded_t.
_tThis_t _tmethod_t _tis_t _tused_t _tto_t _tconvert_t _tmodels_t _tbetween_t _tLevels_t _tand_t _tVersions_t _tof_t _tSBML_t. _tGenerally_t, _tmodels_t _tcan_t _tbe_t _tconverted_t _tupward_t _twithout_t _tdifficulty_t (_te_t._tg_t., _tfrom_t _tSBML_t _tLevel_t _t1_t _tto_t _tLevel_t _t2_t, _tor_t _tfrom_t _tan_t _tearlier_t _tversion_t _tof_t _tLevel_t _t2_t _tto_t _tthe_t _tlatest_t _tversion_t _tof_t _tLevel_t _t2_t). _tSometimes_t _tmodels_t _tcan_t _tbe_t _ttranslated_t _tdownward_t _tas_t _twell_t, _tif_t _tthey_t _tdo_t _tnot_t _tuse_t _tconstructs_t _tspecific_t _tto_t _tmore_t _tadvanced_t _tLevels_t _tof_t _tSBML_t.
_tCallers_t _tcan_t _talso_t _tcheck_t _tcompatibility_t _tdirectly_t _tusing_t _tthe_t _tmethods_t _tSBMLDocument_checkL1Compatibility_t(), _tSBMLDocument_checkL2v1Compatibility_t(), _tSBMLDocument_checkL2v2Compatibility_t(), _tSBMLDocument_checkL2v3Compatibility_t(), _tSBMLDocument_checkL2v4Compatibility_t(), _tSBMLDocument_checkL2v5Compatibility_t(), _tSBMLDocument_checkL3v1Compatibility_t(), _tand_t _tSBMLDocument_checkL3v2Compatibility_t().
_tThe_t _tvalid_t _tcombinations_t _tas_t _tof_t _tthis_t _trelease_t _tof_t _tlibSBML_t _tare_t _tthe_t _tfollowing_t:
@_tli_t _tLevel_t _t1_t _tVersion_t _t1_t @_tli_t _tLevel_t _t1_t _tVersion_t _t2_t @_tli_t _tLevel_t _t2_t _tVersion_t _t1_t @_tli_t _tLevel_t _t2_t _tVersion_t _t2_t @_tli_t _tLevel_t _t2_t _tVersion_t _t3_t @_tli_t _tLevel_t _t2_t _tVersion_t _t4_t @_tli_t _tLevel_t _t2_t _tVersion_t _t5_t @_tli_t _tLevel_t _t3_t _tVersion_t _t1_t @_tli_t _tLevel_t _t3_t _tVersion_t _t2_t
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_tparam_t _tlevel_t _tthe_t _tdesired_t _tSBML_t _tLevel_t.
@_tparam_t _tversion_t _tthe_t _tdesired_t _tVersion_t _twithin_t _tthe_t _tSBML_t _tLevel_t.
@_tnote_t _tCalling_t _tthis_t _tmethod_t _twill_t _tnot_t @_tem_t _tnecessarily_t _tlead_t _tto_t _tsuccessful_t _tconversion_t. _tIf_t _tthe_t _tconversion_t _tfails_t, _tit_t _twill_t _tbe_t _tlogged_t _tin_t _tthe_t _terror_t _tlist_t _tassociated_t _twith_t _tthis_t _tSBMLDocument_t_t _tstructure_t. _tCallers_t _tshould_t _tconsult_t _tSBMLDocument_getNumErrors_t() _tto_t _tfind_t _tout_t _tif_t _tthe_t _tconversion_t _tsucceeded_t _twithout_t _tproblems_t. _tFor_t _tconversions_t _tfrom_t _tLevel_t _t2_t _tto_t _tLevel_t _t1_t, _tcallers_t _tcan_t _talso_t _tcheck_t _tthe_t _tLevel_t _tof_t _tthe_t _tmodel_t _tafter_t _tcalling_t _tthis_t _tmethod_t _tto_t _tfind_t _tout_t _twhether_t _tit_t _tis_t _tLevel_t _t1_t. (_tIf_t _tthe_t _tconversion_t _tto_t _tLevel_t _t1_t _tfailed_t, _tthe_t _tLevel_t _tof_t _tthis_t _tmodel_t _twill_t _tbe_t _tleft_t _tunchanged_t.)
_tStrict_t _tconversion_t _tapplies_t _tthe_t _tadditional_t _tcriteria_t _tthat_t _tboth_t _tthe_t _tsource_t _tand_t _tthe_t _ttarget_t _tmodel_t _tmust_t _tbe_t _tconsistent_t _tSBML_t. _tUsers_t _tcan_t _tcontrol_t _tthe_t _tconsistency_t _tchecks_t _tthat_t _tare_t _tapplied_t _tusing_t _tthe_t _tSBMLDocument_setConsistencyChecks_t() _tfunction_t. _tIf_t _teither_t _tthe_t _tsource_t _tor_t _tthe_t _tpotential_t _ttarget_t _tmodel_t _thave_t _tvalidation_t _terrors_t, _tthe_t _tconversion_t _tis_t _tnot_t _tperformed_t. _tWhen_t _ta_t _tstrict_t _tconversion_t _tis_t _tsuccessful_t, _tthe_t _tunderlying_t _tSBML_t _tstructure_t _tmodel_t _tis_t _taltered_t _tto_t _treflect_t _tthe_t _tnew_t _tlevel_t _tand_t _tversion_t. _tThus_t _tinformation_t _tthat_t _tcannot_t _tbe_t _tconverted_t (_te_t._tg_t. _tsboTerms_t) _twill_t _tbe_t _tlost_t.
@_tmemberof_t _tSBMLDocument_t_t
void SBMLDocument_setLocationURI | ( | SBMLDocument_t * | d, |
const char * | location | ||
) |
_tSets_t _tthe_t _tlocation_t _tof_t _tthis_t _tSBMLDocument_t_t.
_tCalled_t _tautomatically_t _twhen_t _treadSBMLFromFile_t() _tis_t _tused_t, _tbut_t _tmay_t _tbe_t _tset_t _tmanually_t _tas_t _twell_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t. @_tparam_t _tlocation_t _tthe_t _tlocation_t _tURI_t _tof_t _tthe_t _tdocument_t.
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_setModel | ( | SBMLDocument_t * | d, |
const Model_t * | m | ||
) |
_tSets_t _tthe_t _tmodel_t _tcontained_t _tin_t _tthe_t _tgiven_t _tSBMLDocument_t_t _tstructure_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tModel_t_t _tstructure_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_tparam_t _tm_t _tthe_t _tnew_t _tModel_t_t _tstructure_t _tto_t _tuse_t.
@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t}
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_setPackageRequired | ( | SBMLDocument_t * | d, |
const char * | package, | ||
int | flag | ||
) |
_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t <_tcode_t>_trequired_t</_tcode_t> _tattribute_t _tfor_t _tthe_t _tgiven_t _tpackage_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t. @_tparam_t _tpackage_t _tthe_t _tname_t _tor_t _tURI_t _tof_t _tthe_t _tpackage_t _textension_t. _tPassing_t _ta_t _tpackage_t _tname_t (_tor_t "_tnickname_t") _tis_t _tonly_t _tsupported_t _tif_t _tlibSBML_t _twas_t _tcompiled_t _twith_t _tsupport_t _tfor_t _tthat_t _tparticular_t _tpackage_t, _tsee_t _tthe_t _tinstallation_t _tdocumentation_t _tfor_t _tmore_t _tdetails_t. _tPassing_t _tthe_t _tpackage_t _tURI_t _tis_t _tsupported_t _tregardless_t _tof_t _tthe_t _tinstallation_t _tconfiguration_t. @_tparam_t _tflag_t _tinteger_t, _twith_t @_tc_t _tnonzero_t _tindicating_t @_tc_t _ttrue_t, _tand_t @_tc_t _tzero_t _tindicating_t @_tc_t _tfalse_t.
@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_PKG_UNKNOWN_VERSION_t, _tOperationReturnValues_t_t}
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_setPkgRequired | ( | SBMLDocument_t * | d, |
const char * | package, | ||
int | flag | ||
) |
_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t <_tcode_t>_trequired_t</_tcode_t> _tattribute_t _tfor_t _tthe_t _tgiven_t _tpackage_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t. @_tparam_t _tpackage_t _tthe_t _tname_t _tor_t _tURI_t _tof_t _tthe_t _tpackage_t _textension_t. _tPassing_t _ta_t _tpackage_t _tname_t (_tor_t "_tnickname_t") _tis_t _tonly_t _tsupported_t _tif_t _tlibSBML_t _twas_t _tcompiled_t _twith_t _tsupport_t _tfor_t _tthat_t _tparticular_t _tpackage_t, _tsee_t _tthe_t _tinstallation_t _tdocumentation_t _tfor_t _tmore_t _tdetails_t. _tPassing_t _tthe_t _tpackage_t _tURI_t _tis_t _tsupported_t _tregardless_t _tof_t _tthe_t _tinstallation_t _tconfiguration_t. @_tparam_t _tflag_t _tinteger_t, _twith_t @_tc_t _tnonzero_t _tindicating_t @_tc_t _ttrue_t, _tand_t @_tc_t _tzero_t _tindicating_t @_tc_t _tfalse_t.
@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_PKG_UNKNOWN_VERSION_t, _tOperationReturnValues_t_t}
@_tdeprecated_t _tReplaced_t _tin_t _tlibSBML_t _t5_t._t2_t._t0_t _tby_t _tSBMLDocument_setPackageRequired_t()
@_tmemberof_t _tSBMLDocument_t_t
int SBMLDocument_setSBMLNamespaces | ( | SBMLDocument_t * | d, |
SBMLNamespaces_t * | sbmlns | ||
) |
_tSets_t _tthe_t _tSBMLNamespaces_t_t _ton_t _tthe_t _tgiven_t _tSBMLDocument_t_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t _tto_t _tchange_t. @_tparam_t _tsbmlns_t _tthe_t _tSBMLNamespaces_t_t _tstructure_t _tto_t _tset_t.
@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}
@_tmemberof_t _tSBMLDocument_t_t
unsigned int SBMLDocument_validateSBML | ( | SBMLDocument_t * | d | ) |
_tPerforms_t _tconsistency_t _tchecking_t _tand_t _tvalidation_t _ton_t _tthe_t _tgiven_t _tSBML_t _tdocument_t.
_tIf_t _tthis_t _tmethod_t _treturns_t _ta_t _tnonzero_t _tvalue_t (_tmeaning_t, _tone_t _tor_t _tmore_t _tconsistency_t _tchecks_t _thave_t _tfailed_t _tfor_t _tSBML_t _tdocument_t), _tthe_t _tfailures_t _tmay_t _tbe_t _tdue_t _tto_t _twarnings_t @_tem_t _tor_t _terrors_t. _tCallers_t _tshould_t _tinspect_t _tthe_t _tseverity_t _tflag_t _tin_t _tthe_t _tindividual_t _tSBMLError_t_t _tstructures_t _treturned_t _tby_t _tSBMLDocument_getError_t() _tto_t _tdetermine_t _tthe_t _tnature_t _tof_t _tthe_t _tfailures_t.
@_tnote_t _tunlike_t _tSBMLDocument_checkConsistency_t(), _tthis_t _tmethod_t _twill_t _twrite_t _tthe_t _tdocument_t _tin_t _torder_t _tto_t _tdetermine_t _tall_t _terrors_t _tfor_t _tthe_t _tdocument_t. _tThis_t _twill_t _talso_t _tclear_t _tthe_t _terror_t _tlog_t.
@_tparam_t _td_t _tthe_t _tSBMLDocument_t_t _tstructure_t.
@_treturn_t _tthe_t _tnumber_t _tof_t _tfailed_t _tchecks_t (_terrors_t) _tencountered_t.
@_tsee_t _tSBMLDocument_checkConsistency_t()
@_tmemberof_t _tSBMLDocument_t_t