libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
SBase.cpp File Reference

Implementation of SBase_t, the base object of all SBML objects. More...

Include dependency graph for SBase.cpp:

Functions

int SBase_addCVTerm (SBase_t *sb, CVTerm_t *term)
 @_tendcond_t
 
int SBase_addCVTermNewBag (SBase_t *sb, CVTerm_t *term)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCVTerm_t_t _tto_t _tthis_t _tSBML_t _tstructure_t _tcreating_t _ta_t _tnew_t _tbBag_t _telement_t _twith_t _tthe_t _tsame_t _tidentifier_t.
 
int SBase_appendAnnotation (SBase_t *sb, const XMLNode_t *annotation)
 _tAppends_t _tthe_t _tannotation_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.
 
int SBase_appendAnnotationString (SBase_t *sb, const char *annotation)
 _tAppends_t _tthe_t _tannotation_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.
 
int SBase_appendNotes (SBase_t *sb, const XMLNode_t *notes)
 _tAppends_t _tthe_t _tnotes_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.
 
int SBase_appendNotesString (SBase_t *sb, const char *notes)
 _tAppends_t _tthe_t _tnotes_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.
 
List_tSBase_getAllElements (SBase_t *sb)
 _tReturns_t _ta_t _tList_t_t _tstructure_t _tof_t _tall_t _tchild_t _tSBase_t_t _tstructures_t, _tincluding_t _tthose_t _tnested_t _tto_t _tan_t _tarbitrary_t _tdepth_t.
 
List_tSBase_getAllElementsFromPlugins (SBase_t *sb)
 _tReturns_t _ta_t _tList_t_t _tof_t _tall_t _tchild_t _tSBase_t_t _tstructures_t _tcontained_t _tin_t _tSBML_t _tpackage_t _tplug_t-_tins_t.
 
const SBase_tSBase_getAncestorOfType (SBase_t *sb, int type, const char *pkgName)
 _tReturns_t _tthe_t _tancestor_t _tSBase_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t _tthat_t _tcorresponds_t _tto_t _tthe_t _tgiven_t _ttype_t.
 
XMLNode_tSBase_getAnnotation (SBase_t *sb)
 _tReturns_t _tthe_t _tannotation_t _tfrom_t _tgiven_t _tSBML_t _tstructure_t.
 
char * SBase_getAnnotationString (SBase_t *sb)
 _tReturns_t _tthe_t _tannotation_t _tstring_t _tfrom_t _tgiven_t _tSBML_t _tstructure_t.
 
unsigned int SBase_getColumn (const SBase_t *sb)
 _tReturns_t _tthe_t _tcolumn_t _tnumber_t _ton_t _twhich_t _tthe_t _tgiven_t _tstructure_t _tfirst_t _tappears_t _tin_t _tthe_t _tXML_t _trepresentation_t _tof_t _tthe_t _tSBML_t _tdocument_t, _tor_t <_tcode_t>_t0_t</_tcode_t> _tif_t _tthe_t _tobject_t _twas_t _tcreated_t, _tnot_t _tread_t _tfrom_t _ta_t _tfile_t.
 
CVTerm_tSBase_getCVTerm (SBase_t *sb, unsigned int n)
 _tReturns_t _tthe_t _tnth_t _tCVTerm_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tof_t _tthis_t _tSBML_t _tstructure_t.
 
List_tSBase_getCVTerms (SBase_t *sb)
 _tReturns_t _ta_t _tlist_t _tof_t _tCVTerm_t _tstructures_t _tin_t _tthe_t _tannotations_t _tof_t _tthis_t _tSBML_t _tstructure_t.
 
SBase_tSBase_getElementByMetaId (SBase_t *sb, const char *metaid)
 _tReturns_t _tthe_t _tfirst_t _tchild_t _telement_t _tit_t _tcan_t _tfind_t _twith_t _ta_t _tspecific_t "_tmetaid_t" _tattribute_t _tvalue_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tstructure_t _tis_t _tfound_t.
 
SBase_tSBase_getElementBySId (SBase_t *sb, const char *id)
 _tReturns_t _tthe_t _tfirst_t _tchild_t _telement_t _tfound_t _tthat_t _thas_t _tthe_t _tgiven_t @_tp_t _tid_t _tin_t _tthe_t _tmodel_t-_twide_t @_tc_t _tSId_t _tnamespace_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tstructure_t _tis_t _tfound_t.
 
SBase_tSBase_getElementFromPluginsByMetaId (SBase_t *sb, const char *metaid)
 _tReturns_t _tthe_t _tfirst_t _tchild_t _telement_t _tit_t _tcan_t _tfind_t _twith_t _tthe_t _tgiven_t @_tp_t _tmetaid_t _tfrom_t _tall_t _tplug_t-_tins_t _tassociated_t _twith_t _tthis_t _telement_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tstructure_t _tis_t _tfound_t.
 
SBase_tSBase_getElementFromPluginsBySId (SBase_t *sb, const char *id)
 _tReturns_t _tthe_t _tfirst_t _tchild_t _telement_t _tfound_t _tthat_t _thas_t _tthe_t _tgiven_t @_tp_t _tid_t _tin_t _tthe_t _tmodel_t-_twide_t _tSId_t _tnamespace_t _tfrom_t _tall_t _tplug_t-_tins_t _tassociated_t _twith_t _tthis_t _telement_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tstructure_t _tis_t _tfound_t.
 
const char * SBase_getElementName (const SBase_t *sb)
 _tReturns_t _tthe_t _tXML_t _telement_t _tname_t _tof_t _tthe_t _tgiven_t _tstructure_t.
 
const char * SBase_getIdAttribute (const SBase_t *sb)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.
 
unsigned int SBase_getLevel (const SBase_t *sb)
 _tReturns_t _tthe_t _tSBML_t _tLevel_t _tof_t _tthe_t _toverall_t _tSBML_t _tdocument_t.
 
unsigned int SBase_getLine (const SBase_t *sb)
 _tReturns_t _tthe_t _tline_t _tnumber_t _ton_t _twhich_t _tthe_t _tgiven_t _tstructure_t _tfirst_t _tappears_t _tin_t _tthe_t _tXML_t _trepresentation_t _tof_t _tthe_t _tSBML_t _tdocument_t, _tor_t <_tcode_t>_t0_t</_tcode_t> _tif_t _tthe_t _tobject_t _twas_t _tcreated_t, _tnot_t _tread_t _tfrom_t _ta_t _tfile_t.
 
const char * SBase_getMetaId (SBase_t *sb)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.
 
const Model_tSBase_getModel (const SBase_t *sb)
 _tReturns_t _tthe_t _tModel_t_t _tstructure_t _tin_t _twhich_t _tthe_t _tgiven_t _tinstance_t _tis_t _tlocated_t.
 
ModelHistory_tSBase_getModelHistory (SBase_t *sb)
 _tReturns_t _tthe_t _tModelHistory_t_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.
 
const char * SBase_getName (const SBase_t *sb)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.
 
XMLNode_tSBase_getNotes (SBase_t *sb)
 _tReturns_t _tthe_t _tnotes_t _tfrom_t _tgiven_t _tSBML_t _tstructure_t.
 
char * SBase_getNotesString (SBase_t *sb)
 _tReturns_t _tthe_t _tnotes_t _tstring_t _tfrom_t _tgiven_t _tSBML_t _tstructure_t.
 
unsigned int SBase_getNumCVTerms (SBase_t *sb)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tCVTerm_t _tstructures_t _tin_t _tthe_t _tannotations_t _tof_t _tthis_t _tSBML_t _tstructure_t.
 
int SBase_getNumPlugins (const SBase_t *sb)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tplug_t-_tin_t _tstructures_t (_textenstion_t _tinterfaces_t) _tfor_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t _tpackage_t _textensions_t _tknown_t.
 
char * SBase_getPackageName (const SBaseExtensionPoint_t *sb)
 _tReturns_t _tthe_t _tpackage_t _tname_t _tfor_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t
 
const SBase_tSBase_getParentSBMLObject (SBase_t *sb)
 _tReturns_t _tthe_t _tparent_t _tSBase_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.
 
SBasePlugin_tSBase_getPlugin (SBase_t *sb, const char *package)
 _tReturns_t _ta_t _tplug_t-_tin_t _tstructure_t (_textension_t _tinterface_t) _tfor_t _tan_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t _tpackage_t _textension_t _twith_t _tthe_t _tgiven_t _tpackage_t _tname_t _tor_t _tURI_t.
 
BiolQualifierType_t SBase_getResourceBiologicalQualifier (SBase_t *sb, const char *resource)
 _tReturns_t _tthe_t _tBiological_t _tQualifier_t _tassociated_t _twith_t _tthis_t _tresource_t, @_tsbmlconstant_t{_tBQB_UNKNOWN_t, _tBiolQualifierType_t_t} _tif_t _tthe_t _tresource_t _tdoes_t _tnot_t _texist_t.
 
ModelQualifierType_t SBase_getResourceModelQualifier (SBase_t *sb, const char *resource)
 _tReturns_t _tthe_t _tModel_t _tQualifier_t _tassociated_t _twith_t _tthis_t _tresource_t, @_tsbmlconstant_t{_tBQM_UNKNOWN_t, _tModelQualifierType_t_t} _tif_t _tthe_t _tresource_t _tdoes_t _tnot_t _texist_t.
 
const SBMLDocument_tSBase_getSBMLDocument (SBase_t *sb)
 _tReturns_t _tthe_t _tparent_t _tSBMLDocument_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.
 
int SBase_getSBOTerm (const SBase_t *sb)
 _tReturns_t _tthe_t _tinteger_t _tportion_t _tof_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsboTerm_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.
 
char * SBase_getSBOTermAsURL (const SBase_t *sb)
 _tReturns_t _tthe_t _tidentifiers_t._torg_t _tURL_t _trepresentation_t _tof_t _tthe_t "_tsboTerm_t" _tattribute_t _tof_t _tthis_t _tstructure_t.
 
char * SBase_getSBOTermID (const SBase_t *sb)
 _tReturns_t _tthe_t _tstring_t _trepresentation_t _tof_t _tthe_t "_tsboTerm_t" _tattribute_t _tof_t _tthis_t _tstructure_t.
 
int SBase_getTypeCode (const SBase_t *sb)
 _tReturns_t _tthe_t _tlibSBML_t _ttype_t _tcode_t _tfor_t _tthis_t _tstructure_t.
 
void * SBase_getUserData (const SBase_t *sb)
 _tReturns_t _tthe_t _tuser_t _tdata_t _tthat_t _thas_t _tbeen_t _tpreviously_t _tset_t _tby_t _tsetUserData_t().
 
unsigned int SBase_getVersion (const SBase_t *sb)
 _tReturns_t _tthe_t _tVersion_t _twithin_t _tthe_t _tSBML_t _tLevel_t _tof_t _tthe_t _toverall_t _tSBML_t _tdocument_t.
 
int SBase_hasValidLevelVersionNamespaceCombination (SBase_t *sb)
 _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 _tstructure_t'_ts_t _tlevel_t/_tversion_t _tand_t _tnamespace_t _tvalues_t _tcorrespond_t _tto_t _ta_t _tvalid_t _tSBML_t _tspecification_t.
 
int SBase_isSetAnnotation (const SBase_t *sb)
 _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 _tgiven_t _tstructure_t'_ts_t "_tannotation_t" _tsubelement_t _tis_t _tset_t.
 
int SBase_isSetIdAttribute (const SBase_t *sb)
 _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 _tgiven_t _tstructure_t'_ts_t "_tid_t" _tattribute_t _tis_t _tset_t.
 
int SBase_isSetMetaId (const SBase_t *sb)
 _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 _tgiven_t _tstructure_t'_ts_t "_tmetaid_t" _tattribute_t _tis_t _tset_t.
 
int SBase_isSetModelHistory (SBase_t *sb)
 _tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tModelHistory_t_t _tof_t _ta_t _tgiven_t _tSBase_t_t _tstructure_t _tis_t _tassigned_t.
 
int SBase_isSetName (const SBase_t *sb)
 _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 _tgiven_t _tstructure_t'_ts_t "_tname_t" _tattribute_t _tis_t _tset_t.
 
int SBase_isSetNotes (const SBase_t *sb)
 _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 _tgiven_t _tstructure_t'_ts_t "_tnotes_t" _tsubelement_t _tis_t _tset_t.
 
int SBase_isSetSBOTerm (const SBase_t *sb)
 _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 _tgiven_t _tstructure_t'_ts_t "_tsboTerm_t" _tattribute_t _tis_t _tset_t.
 
int SBase_isSetUserData (const SBase_t *sb)
 _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 _tstructure_t'_ts_t _tuser_t _tdata_t _tobject_t _thas_t _tbeen_t _tset_t.
 
int SBase_removeTopLevelAnnotationElement (SBase_t *sb, const char *name)
 _tRemoves_t _tthe_t _ttop_t-_tlevel_t _telement_t _twithin_t _tthe_t "_tannotation_t" _tsubelement_t _tof_t _tthis_t _tSBML_t _tstructure_t _twith_t _tthe_t _tgiven_t _tname_t.
 
int SBase_removeTopLevelAnnotationElementWithURI (SBase_t *sb, const char *name, const char *uri)
 _tRemoves_t _tthe_t _ttop_t-_tlevel_t _telement_t _twithin_t _tthe_t "_tannotation_t" _tsubelement_t _tof_t _tthis_t _tSBML_t _tstructure_t _twith_t _tthe_t _tgiven_t _tname_t _tand_t _tURI_t.
 
void SBase_renameMetaIdRefs (SBase_t *sb, const char *oldid, const char *newid)
 _tRenames_t _tall_t _tthe_t _tmeta_t-_tidentifier_t _tattributes_t _ton_t _tthis_t _telement_t.
 
void SBase_renameSIdRefs (SBase_t *sb, const char *oldid, const char *newid)
 _tRenames_t _tall_t _tthe_t @_tc_t _tSIdRef_t _tattributes_t _ton_t _tthis_t _telement_t, _tincluding_t _tany_t _tfound_t _tin_t _tMathML_t _tcontent_t (_tif_t _tsuch_t _texists_t).
 
void SBase_renameUnitSIdRefs (SBase_t *sb, const char *oldid, const char *newid)
 _tRenames_t _tall_t _tthe_t @_tc_t _tUnitSIdRef_t _tattributes_t _ton_t _tthis_t _telement_t.
 
int SBase_replaceTopLevelAnnotationElement (SBase_t *sb, const XMLNode_t *annotation)
 _tReplaces_t _tthe_t _tgiven_t _ttop_t-_tlevel_t _telement_t _twithin_t _tthe_t "_tannotation_t" _tsubelement_t _tof_t _tthis_t _tSBML_t _tstructure_t _tand_t _twith_t _tthe_t _tannotation_t _telement_t _tsupplied_t.
 
int SBase_replaceTopLevelAnnotationElementString (SBase_t *sb, const char *annotation)
 _tReplaces_t _tthe_t _tgiven_t _ttop_t-_tlevel_t _telement_t _twithin_t _tthe_t "_tannotation_t" _tsubelement_t _tof_t _tthis_t _tSBML_t _tstructure_t _tand_t _twith_t _tthe_t _tannotation_t _telement_t _tsupplied_t.
 
int SBase_setAnnotation (SBase_t *sb, const XMLNode_t *annotation)
 _tSets_t _tthe_t _tannotation_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.
 
int SBase_setAnnotationString (SBase_t *sb, const char *annotation)
 _tSets_t _tthe_t _tannotation_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.
 
int SBase_setIdAttribute (SBase_t *sb, const char *id)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.
 
int SBase_setMetaId (SBase_t *sb, const char *metaid)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.
 
int SBase_setModelHistory (SBase_t *sb, ModelHistory_t *history)
 _tSet_t _tthe_t _tModelHistory_t_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.
 
int SBase_setName (SBase_t *sb, const char *name)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.
 
int SBase_setNamespaces (SBase_t *sb, XMLNamespaces_t *xmlns)
 _tSets_t _tthe_t _tnamespaces_t _trelevant_t _tof_t _tthis_t _tSBML_t _tstructure_t.
 
int SBase_setNotes (SBase_t *sb, const XMLNode_t *notes)
 _tSets_t _tthe_t _tnotes_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.
 
int SBase_setNotesString (SBase_t *sb, const char *notes)
 _tSets_t _tthe_t _tnotes_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.
 
int SBase_setNotesStringAddMarkup (SBase_t *sb, const char *notes)
 _tSets_t _tthe_t _tnotes_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.
 
int SBase_setSBOTerm (SBase_t *sb, int value)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsboTerm_t" _tattribute_t.
 
int SBase_setSBOTermID (SBase_t *sb, const char *sboid)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsboTerm_t" _tattribute_t _tby_t _tstring_t.
 
int SBase_setUserData (SBase_t *sb, void *userData)
 _tSets_t _tthe_t _tuser_t _tdata_t _tof_t _tthis_t _tnode_t.
 
int SBase_unsetAnnotation (SBase_t *sb)
 _tUnsets_t _tthe_t "_tannotation_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tstructure_t.
 
int SBase_unsetCVTerms (SBase_t *sb)
 _tClears_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tof_t _tthis_t _tSBML_t _tstructure_t.
 
int SBase_unsetIdAttribute (SBase_t *sb)
 _tUnsets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.
 
int SBase_unsetMetaId (SBase_t *sb)
 _tUnsets_t _tthe_t "_tmetaid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.
 
int SBase_unsetModelHistory (SBase_t *sb)
 _tUnsets_t _tthe_t _tModelHistory_t_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.
 
int SBase_unsetName (SBase_t *sb)
 _tUnsets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.
 
int SBase_unsetNotes (SBase_t *sb)
 _tUnsets_t _tthe_t "_tnotes_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tstructure_t.
 
int SBase_unsetSBOTerm (SBase_t *sb)
 _tUnsets_t _tthe_t "_tsboTerm_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.
 
int SBase_unsetUserData (SBase_t *sb)
 _tUnsets_t _tthe_t _tuser_t _tdata_t _tof_t _tthis_t _tnode_t.
 

Detailed Description

Implementation of SBase_t, the base object of all SBML objects.

Author
Ben Bornstein

Function Documentation

◆ SBase_addCVTerm()

int SBase_addCVTerm ( SBase_t sb,
CVTerm_t term 
)

@_tendcond_t

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCVTerm_t_t _tto_t _tthis_t _tSBML_t _tstructure_t.

@_tcond_t _tdoxygenIgnored_t

Examples
addCVTerms.c, addingEvidenceCodes_1.c, and addingEvidenceCodes_2.c.

◆ SBase_addCVTermNewBag()

int SBase_addCVTermNewBag ( SBase_t sb,
CVTerm_t term 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCVTerm_t_t _tto_t _tthis_t _tSBML_t _tstructure_t _tcreating_t _ta_t _tnew_t _tbBag_t _telement_t _twith_t _tthe_t _tsame_t _tidentifier_t.

@_tparam_t _tsb_t _tthe_t _tstructure_t _tto_t _tadd_t _tthe_t _tCVTerm_t_t _tto_t. @_tparam_t _tterm_t _tthe_t _tCVTerm_t_t _tto_t _tassign_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_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tThe_t _tannotation_t _tconstructed_t _tfrom_t _ta_t _tCVTerm_t_t _tuses_t _tthe_t _tmetaid_t _tof_t _tthe_t _tstructure_t _tto_t _tidentify_t _tit_t. _tAdding_t _ta_t _tCVTerm_t_t _tto_t _tan_t _tstructure_t _twhere_t _tthe_t '_tmetaId_t' _tattribute_t _thas_t _tnot_t _tbeen_t _tset_t _twill_t _tfail_t _twith_t _tthe_t _treturn_t _tvalue_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}.

@_tmemberof_t _tSBase_t_t

◆ SBase_appendAnnotation()

int SBase_appendAnnotation ( SBase_t sb,
const XMLNode_t annotation 
)

_tAppends_t _tthe_t _tannotation_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tgiven_t _tSBML_t _tstructure_t. @_tparam_t _tannotation_t _tthe_t _tXMLNode_t_t _tstructure_t _trepresenting_t _tthe_t _tannotation_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}

@_tmemberof_t _tSBase_t_t

Examples
addingEvidenceCodes_2.c.

◆ SBase_appendAnnotationString()

int SBase_appendAnnotationString ( SBase_t sb,
const char *  annotation 
)

_tAppends_t _tthe_t _tannotation_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tgiven_t _tSBML_t _tstructure_t. @_tparam_t _tannotation_t _tthe_t _tstring_t _trepresenting_t _tthe_t _tannotation_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}

@_tmemberof_t _tSBase_t_t

Examples
appendAnnotation.c.

◆ SBase_appendNotes()

int SBase_appendNotes ( SBase_t sb,
const XMLNode_t notes 
)

_tAppends_t _tthe_t _tnotes_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tgiven_t _tSBML_t _tstructure_t. @_tparam_t _tnotes_t _tthe_t _tXMLNode_t_t _tstructure_t _trepresenting_t _tthe_t _tnotes_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSBase_t_t

◆ SBase_appendNotesString()

int SBase_appendNotesString ( SBase_t sb,
const char *  notes 
)

_tAppends_t _tthe_t _tnotes_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tgiven_t _tSBML_t _tstructure_t. @_tparam_t _tnotes_t _tthe_t _tstring_t _trepresenting_t _tthe_t _tnotes_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSBase_t_t

◆ SBase_getAllElements()

List_t * SBase_getAllElements ( SBase_t sb)

_tReturns_t _ta_t _tList_t_t _tstructure_t _tof_t _tall_t _tchild_t _tSBase_t_t _tstructures_t, _tincluding_t _tthose_t _tnested_t _tto_t _tan_t _tarbitrary_t _tdepth_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tin_t _tquestion_t.

@_treturn_t _ta_t _tpointer_t _tto_t _ta_t _tList_t_t _tof_t _tpointers_t _tto_t _tall_t _tchildren_t _tstructures_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getAllElementsFromPlugins()

List_t * SBase_getAllElementsFromPlugins ( SBase_t sb)

_tReturns_t _ta_t _tList_t_t _tof_t _tall_t _tchild_t _tSBase_t_t _tstructures_t _tcontained_t _tin_t _tSBML_t _tpackage_t _tplug_t-_tins_t.

@_tcopydetails_t _tdoc_what_are_plugins_t

_tThis_t _tmethod_t _twalks_t _tdown_t _tthe_t _tlist_t _tof_t _tall_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t _tpackages_t _tused_t _tby_t _tthis_t _tstructure_t _tand_t _treturns_t _tall_t _tchild_t _tstructures_t _tdefined_t _tby_t _tthose_t _tpackages_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tin_t _tquestion_t.

@_treturn_t _ta_t _tpointer_t _tto_t _ta_t _tList_t_t _tof_t _tpointers_t _tto_t _tall_t _tchildren_t _tstructures_t _tfrom_t _tplug_t-_tins_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getAncestorOfType()

const SBase_t * SBase_getAncestorOfType ( SBase_t sb,
int  type,
const char *  pkgName 
)

_tReturns_t _tthe_t _tancestor_t _tSBase_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t _tthat_t _tcorresponds_t _tto_t _tthe_t _tgiven_t _ttype_t.

_tThis_t _tfunction_t _tallows_t _tany_t _tstructure_t _tto_t _tdetermine_t _tits_t _texact_t _tlocation_t/_tfunction_t _twithin_t _ta_t _tmodel_t. _tFor_t _texample_t _ta_t _tStoichiometryMath_t_t _tstructure_t _thas_t _tancestors_t _tof_t _ttype_t _tSpeciesReference_t_t, _tListOf_t_t(_tProducts_t/_tReactants_t), _tReaction_t_t, _tListOfReactions_t_t _tand_t _tModel_t_t; _tany_t _tof_t _twhich_t _tcan_t _tbe_t _taccessed_t _tvia_t _tthis_t _tfunction_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t. @_tparam_t _ttype_t _tthe_t _ttypecode_t (_tint_t) _tof_t _tthe_t _tstructure_t _tto_t _tbe_t _treturned_t. @_tparam_t _tpkgName_t _tthe_t _tname_t _tof_t _tthe_t _tpackage_t _tthat_t _tdefines_t _tthe_t @_tp_t _ttype_t .

@_treturn_t _tthe_t _tancestor_t _tSBase_t_t _tstructure_t _tof_t _tthis_t _tSBML_t _tstructure_t _twith_t _tthe_t _tcorresponding_t _ttypecode_t (_tint_t), _tNULL_t _tif_t _tthere_t _tis_t _tno_t _tancestor_t _tof_t _tthis_t _ttype_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getAnnotation()

XMLNode_t * SBase_getAnnotation ( SBase_t sb)

_tReturns_t _tthe_t _tannotation_t _tfrom_t _tgiven_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.

@_treturn_t _tthe_t _tXMLNode_t_t _tstructure_t _trepresenting_t _tthe_t _tannotation_t _tfrom_t _tthis_t _tstructure_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getAnnotationString()

char * SBase_getAnnotationString ( SBase_t sb)

_tReturns_t _tthe_t _tannotation_t _tstring_t _tfrom_t _tgiven_t _tSBML_t _tstructure_t.

_tThe_t _tstring_t _tis_t _towned_t _tby_t _tthe_t _tcaller_t _tand_t _tshould_t _tbe_t _tfreed_t (_twith_t _tfree_t()) _twhen_t _tno_t _tlonger_t _tneeded_t.

@_tparam_t _tsb_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.

@_treturn_t _tthe_t _tstring_t (_tchar_t*) _trepresenting_t _tthe_t _tannotation_t _tfrom_t _tthis_t _tstructure_t.

@_tmemberof_t _tSBase_t_t

Examples
printAnnotation.c.

◆ SBase_getColumn()

unsigned int SBase_getColumn ( const SBase_t sb)

_tReturns_t _tthe_t _tcolumn_t _tnumber_t _ton_t _twhich_t _tthe_t _tgiven_t _tstructure_t _tfirst_t _tappears_t _tin_t _tthe_t _tXML_t _trepresentation_t _tof_t _tthe_t _tSBML_t _tdocument_t, _tor_t <_tcode_t>_t0_t</_tcode_t> _tif_t _tthe_t _tobject_t _twas_t _tcreated_t, _tnot_t _tread_t _tfrom_t _ta_t _tfile_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_treturn_t _tthe_t _tcolumn_t _tnumber_t _tof_t _tthis_t _tSBML_t _tstructure_t, _tor_t <_tcode_t>_t0_t</_tcode_t> _tif_t _tno_t _tsuch_t _tvalue_t.

@_tsee_t _tSBase_getLine_t().

@_tmemberof_t _tSBase_t_t

◆ SBase_getCVTerm()

CVTerm_t * SBase_getCVTerm ( SBase_t sb,
unsigned int  n 
)

_tReturns_t _tthe_t _tnth_t _tCVTerm_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tof_t _tthis_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tstructure_t _tto_t _tget_t _tCVTerm_t_t'_ts_t _tfrom_t. @_tparam_t _tn_t _tunsigned_t _tint_t _tthe_t _tindex_t _tof_t _tthe_t _tCVTerm_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tCVTerm_t_t _tin_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tfor_t _tthis_t _tSBML_t _tstructure_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 _tSBase_t_t

◆ SBase_getCVTerms()

List_t * SBase_getCVTerms ( SBase_t sb)

_tReturns_t _ta_t _tlist_t _tof_t _tCVTerm_t _tstructures_t _tin_t _tthe_t _tannotations_t _tof_t _tthis_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tstructure_t _tto_t _tgetCVTerms_t _tfrom_t.

@_treturn_t _tthe_t _tlist_t _tof_t _tCVTerms_t _tfor_t _tthis_t _tSBML_t _tstructure_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getElementByMetaId()

SBase_t * SBase_getElementByMetaId ( SBase_t sb,
const char *  metaid 
)

_tReturns_t _tthe_t _tfirst_t _tchild_t _telement_t _tit_t _tcan_t _tfind_t _twith_t _ta_t _tspecific_t "_tmetaid_t" _tattribute_t _tvalue_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tstructure_t _tis_t _tfound_t.

@_tcopydetails_t _tdoc_what_is_metaid_t

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tin_t _tquestion_t. @_tparam_t _tmetaid_t _tstring_t _trepresenting_t _tthe_t "_tmetaid_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tstructure_t _tto_t _tfind_t.

@_treturn_t _tpointer_t _tto_t _tthe_t _tfirst_t _telement_t _tfound_t _twith_t _tthe_t _tgiven_t _tmeta_t-_tidentifier_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getElementBySId()

SBase_t * SBase_getElementBySId ( SBase_t sb,
const char *  id 
)

_tReturns_t _tthe_t _tfirst_t _tchild_t _telement_t _tfound_t _tthat_t _thas_t _tthe_t _tgiven_t @_tp_t _tid_t _tin_t _tthe_t _tmodel_t-_twide_t @_tc_t _tSId_t _tnamespace_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tstructure_t _tis_t _tfound_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tin_t _tquestion_t. @_tparam_t _tid_t _tstring_t _trepresenting_t _tthe_t "_tid_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tstructure_t _tto_t _tfind_t.

@_treturn_t _tpointer_t _tto_t _tthe_t _tfirst_t _telement_t _tfound_t _twith_t _tthe_t _tgiven_t _tidentifier_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getElementFromPluginsByMetaId()

SBase_t * SBase_getElementFromPluginsByMetaId ( SBase_t sb,
const char *  metaid 
)

_tReturns_t _tthe_t _tfirst_t _tchild_t _telement_t _tit_t _tcan_t _tfind_t _twith_t _tthe_t _tgiven_t @_tp_t _tmetaid_t _tfrom_t _tall_t _tplug_t-_tins_t _tassociated_t _twith_t _tthis_t _telement_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tstructure_t _tis_t _tfound_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tin_t _tquestion_t. @_tparam_t _tmetaid_t _tstring_t _trepresenting_t _tthe_t _tmetaid_t _tof_t _tstructures_t _tto_t _tfind_t.

@_treturn_t _tpointer_t _tto_t _tthe_t _tfirst_t _telement_t _tfound_t _twith_t _tthe_t _tgiven_t @_tp_t _tmetaid_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getElementFromPluginsBySId()

SBase_t * SBase_getElementFromPluginsBySId ( SBase_t sb,
const char *  id 
)

_tReturns_t _tthe_t _tfirst_t _tchild_t _telement_t _tfound_t _tthat_t _thas_t _tthe_t _tgiven_t @_tp_t _tid_t _tin_t _tthe_t _tmodel_t-_twide_t _tSId_t _tnamespace_t _tfrom_t _tall_t _tplug_t-_tins_t _tassociated_t _twith_t _tthis_t _telement_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tstructure_t _tis_t _tfound_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tin_t _tquestion_t. @_tparam_t _tid_t _tstring_t _trepresenting_t _tthe_t _tid_t _tof_t _tstructures_t _tto_t _tfind_t.

@_treturn_t _tpointer_t _tto_t _tthe_t _tfirst_t _telement_t _tfound_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getElementName()

const char * SBase_getElementName ( const SBase_t sb)

_tReturns_t _tthe_t _tXML_t _telement_t _tname_t _tof_t _tthe_t _tgiven_t _tstructure_t.

_tThis_t _tis_t _toverridden_t _tby_t _tsubclasses_t _tto_t _treturn_t _ta_t _tstring_t _tappropriate_t _tto_t _tthe_t _tSBML_t _tcomponent_t. _tFor_t _texample_t, _tModel_t _tdefines_t _tit_t _tas_t _treturning_t "_tmodel_t", _tCompartmentType_t _tdefines_t _tit_t _tas_t _treturning_t "_tcompartmentType_t", _tetc_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_tsee_t _tSBase_getPackageName_t() @_tsee_t _tSBase_getTypeCode_t()

@_tmemberof_t _tSBase_t_t

Examples
printAnnotation.c, and printNotes.c.

◆ SBase_getIdAttribute()

const char * SBase_getIdAttribute ( const SBase_t sb)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t @_tp_t _tsb_t

@_tmemberof_t _tSBase_t_t

◆ SBase_getLevel()

unsigned int SBase_getLevel ( const SBase_t sb)

_tReturns_t _tthe_t _tSBML_t _tLevel_t _tof_t _tthe_t _toverall_t _tSBML_t _tdocument_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tSBML_t _tlevel_t _tof_t _tthe_t _tgiven_t _tstructure_t.

@_tsee_t _tSBase_getVersion_t()

@_tmemberof_t _tSBase_t_t

◆ SBase_getLine()

unsigned int SBase_getLine ( const SBase_t sb)

_tReturns_t _tthe_t _tline_t _tnumber_t _ton_t _twhich_t _tthe_t _tgiven_t _tstructure_t _tfirst_t _tappears_t _tin_t _tthe_t _tXML_t _trepresentation_t _tof_t _tthe_t _tSBML_t _tdocument_t, _tor_t <_tcode_t>_t0_t</_tcode_t> _tif_t _tthe_t _tobject_t _twas_t _tcreated_t, _tnot_t _tread_t _tfrom_t _ta_t _tfile_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_treturn_t _tthe_t _tline_t _tnumber_t _tof_t _tthe_t _tgiven_t _tstructure_t, _tor_t <_tcode_t>_t0_t</_tcode_t> _tif_t _tno_t _tsuch_t _tvalue_t.

@_tsee_t _tSBase_getColumn_t().

@_tmemberof_t _tSBase_t_t

◆ SBase_getMetaId()

const char * SBase_getMetaId ( SBase_t sb)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaid_t" _tattribute_t _tof_t @_tp_t _tsb_t

@_tmemberof_t _tSBase_t_t

Examples
addingEvidenceCodes_2.c.

◆ SBase_getModel()

const Model_t * SBase_getModel ( const SBase_t sb)

_tReturns_t _tthe_t _tModel_t_t _tstructure_t _tin_t _twhich_t _tthe_t _tgiven_t _tinstance_t _tis_t _tlocated_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_treturn_t _tthe_t _tparent_t _tModel_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tstructure_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getModelHistory()

ModelHistory_t * SBase_getModelHistory ( SBase_t sb)

_tReturns_t _tthe_t _tModelHistory_t_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.

@_treturn_t _tthe_t _tModelHistory_t_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getName()

const char * SBase_getName ( const SBase_t sb)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t @_tp_t _tsb_t

@_tmemberof_t _tSBase_t_t

◆ SBase_getNotes()

XMLNode_t * SBase_getNotes ( SBase_t sb)

_tReturns_t _tthe_t _tnotes_t _tfrom_t _tgiven_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.

@_treturn_t _tthe_t _tXMLNode_t_t _tstructure_t _trepresenting_t _tthe_t _tnotes_t _tfrom_t _tthis_t _tstructure_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getNotesString()

char * SBase_getNotesString ( SBase_t sb)

_tReturns_t _tthe_t _tnotes_t _tstring_t _tfrom_t _tgiven_t _tSBML_t _tstructure_t.

_tThe_t _tstring_t _tis_t _towned_t _tby_t _tthe_t _tcaller_t _tand_t _tshould_t _tbe_t _tfreed_t (_twith_t _tfree_t()) _twhen_t _tno_t _tlonger_t _tneeded_t.

@_tparam_t _tsb_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.

@_treturn_t _tthe_t _tstring_t (_tchar_t*) _trepresenting_t _tthe_t _tnotes_t _tfrom_t _tthis_t _tstructure_t.

@_tmemberof_t _tSBase_t_t

Examples
printNotes.c.

◆ SBase_getNumCVTerms()

unsigned int SBase_getNumCVTerms ( SBase_t sb)

_tReturns_t _tthe_t _tnumber_t _tof_t _tCVTerm_t _tstructures_t _tin_t _tthe_t _tannotations_t _tof_t _tthis_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tstructure_t _tto_t _tgetCVTerms_t _tfrom_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tCVTerms_t _tfor_t _tthis_t _tSBML_t _tstructure_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getNumPlugins()

int SBase_getNumPlugins ( const SBase_t sb)

_tReturns_t _tthe_t _tnumber_t _tof_t _tplug_t-_tin_t _tstructures_t (_textenstion_t _tinterfaces_t) _tfor_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t _tpackage_t _textensions_t _tknown_t.

@_tcopydetails_t _tdoc_what_are_plugins_t

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tplug_t-_tin_t _tstructures_t (_textension_t _tinterfaces_t) _tof_t _tpackage_t _textensions_t _tknown_t _tby_t _tthis_t _tinstance_t _tof_t _tlibSBML_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getPackageName()

char * SBase_getPackageName ( const SBaseExtensionPoint_t sb)

_tReturns_t _tthe_t _tpackage_t _tname_t _tfor_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_treturn_t _tthe_t _tpackage_t _tname_t _tfor_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t _tor_t _tNULL_t.

@_tsee_t _tSBase_getElementName_t() @_tsee_t _tSBase_getTypeCode_t()

@_tmemberof_t _tSBase_t_t

◆ SBase_getParentSBMLObject()

const SBase_t * SBase_getParentSBMLObject ( SBase_t sb)

_tReturns_t _tthe_t _tparent_t _tSBase_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_treturn_t _tthe_t _tparent_t _tSBase_t _tof_t _tthis_t _tSBML_t _tstructure_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getPlugin()

SBasePlugin_t * SBase_getPlugin ( SBase_t sb,
const char *  package 
)

_tReturns_t _ta_t _tplug_t-_tin_t _tstructure_t (_textension_t _tinterface_t) _tfor_t _tan_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t _tpackage_t _textension_t _twith_t _tthe_t _tgiven_t _tpackage_t _tname_t _tor_t _tURI_t.

_tThe_t _treturned_t _tplug_t-_tin_t _twill_t _tbe_t _tthe_t _tappropriate_t _ttype_t _tof_t _tplugin_t _trequested_t: _tcalling_t _tSBase_getPlugin_t(_tmodel_t, "_tfbc_t") _twill_t _treturn_t _tan_t _tFbcModelPlugin_t; _tcalling_t _tSBase_getPlugin_t(_tparameter_t, "_tcomp_t") _twill_t _treturn_t _tCompSBasePlugin_t, _tetc_t.

_tIf_t _tno_t _tsuch_t _tplugin_t _texists_t, _tNULL_t _tis_t _treturned_t.

@_tcopydetails_t _tdoc_what_are_plugins_t

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t. @_tparam_t _tpackage_t _tthe_t _tname_t _tor_t _tURI_t _tof_t _tthe_t _tpackage_t.

@_treturn_t _tthe_t _tplug_t-_tin_t _tstructure_t (_tthe_t _tlibSBML_t _textension_t _tinterface_t) _tof_t _ta_t _tpackage_t _textension_t _twith_t _tthe_t _tgiven_t _tpackage_t _tname_t _tor_t _tURI_t.

@_tmemberof_t _tSBase_t_t

Examples
spec_example1.c.

◆ SBase_getResourceBiologicalQualifier()

BiolQualifierType_t SBase_getResourceBiologicalQualifier ( SBase_t sb,
const char *  resource 
)

_tReturns_t _tthe_t _tBiological_t _tQualifier_t _tassociated_t _twith_t _tthis_t _tresource_t, @_tsbmlconstant_t{_tBQB_UNKNOWN_t, _tBiolQualifierType_t_t} _tif_t _tthe_t _tresource_t _tdoes_t _tnot_t _texist_t.

@_tparam_t _tsb_t _tthe_t _tstructure_t _tto_t _tquery_t. @_tparam_t _tresource_t _tstring_t _trepresenting_t _tthe_t _tresource_t; _te_t._tg_t., <_tcode_t>"_thttp_t://_twww_t._tgeneontology_t._torg_t/#_tGO_t:_t0005892_t"</_tcode_t>.

@_treturn_t _tthe_t #_tBiolQualifierType_t_t _tassociated_t _twith_t _tthe_t _tresource_t

@_tmemberof_t _tSBase_t_t

◆ SBase_getResourceModelQualifier()

ModelQualifierType_t SBase_getResourceModelQualifier ( SBase_t sb,
const char *  resource 
)

_tReturns_t _tthe_t _tModel_t _tQualifier_t _tassociated_t _twith_t _tthis_t _tresource_t, @_tsbmlconstant_t{_tBQM_UNKNOWN_t, _tModelQualifierType_t_t} _tif_t _tthe_t _tresource_t _tdoes_t _tnot_t _texist_t.

@_tparam_t _tsb_t _tthe_t _tstructure_t _tto_t _tquery_t. @_tparam_t _tresource_t _tstring_t _trepresenting_t _tthe_t _tresource_t; _te_t._tg_t., <_tcode_t>"_thttp_t://_twww_t._tgeneontology_t._torg_t/#_tGO_t:_t0005892_t"</_tcode_t>.

@_treturn_t _tthe_t #_tModelQualifierType_t_t _tassociated_t _twith_t _tthe_t _tresource_t

@_tmemberof_t _tSBase_t_t

◆ SBase_getSBMLDocument()

const SBMLDocument_t * SBase_getSBMLDocument ( SBase_t sb)

_tReturns_t _tthe_t _tparent_t _tSBMLDocument_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_treturn_t _tthe_t _tparent_t _tSBMLDocument_t _tof_t _tthis_t _tSBML_t _tstructure_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getSBOTerm()

int SBase_getSBOTerm ( const SBase_t sb)

_tReturns_t _tthe_t _tinteger_t _tportion_t _tof_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsboTerm_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.

@_tcopydetails_t _tdoc_sbo_terms_t @_tcopydetails_t _tdoc_sbo_terms_addendum_t

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsboTerm_t" _tattribute_t _tas_t _tan_t _tinteger_t, _tor_t @_tc_t -_t1_t _tif_t _tthe_t _tvalue_t _tis_t _tnot_t _tset_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getSBOTermAsURL()

char * SBase_getSBOTermAsURL ( const SBase_t sb)

_tReturns_t _tthe_t _tidentifiers_t._torg_t _tURL_t _trepresentation_t _tof_t _tthe_t "_tsboTerm_t" _tattribute_t _tof_t _tthis_t _tstructure_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsboTerm_t" _tattribute_t _tas_t _ta_t _tstring_t _tof_t _tthe_t _tform_t <_tcode_t>_thttp_t://_tidentifiers_t._torg_t/_tbiomodels_t._tsbo_t/_tSBO_t:_tNNNNNNN_t</_tcode_t>, _tor_t @_tc_t _tNULL_t _tif_t _tthe_t _tvalue_t _tis_t _tnot_t _tset_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getSBOTermID()

char * SBase_getSBOTermID ( const SBase_t sb)

_tReturns_t _tthe_t _tstring_t _trepresentation_t _tof_t _tthe_t "_tsboTerm_t" _tattribute_t _tof_t _tthis_t _tstructure_t.

@_tcopydetails_t _tdoc_sbo_terms_t @_tcopydetails_t _tdoc_sbo_terms_addendum_t

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsboTerm_t" _tattribute_t _tas_t _ta_t _tstring_t _tof_t _tthe_t _tform_t _tSBO_t:_tNNNNNNN_t, _tor_t @_tc_t _tNULL_t _tif_t _tthe_t _tvalue_t _tis_t _tnot_t _tset_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_getTypeCode()

int SBase_getTypeCode ( const SBase_t sb)

_tReturns_t _tthe_t _tlibSBML_t _ttype_t _tcode_t _tfor_t _tthis_t _tstructure_t.

_tThis_t _tmethod_t _tMAY_t _treturn_t _tthe_t _ttypecode_t _tof_t _tthis_t _tSBML_t _tstructure_t _tor_t _tit_t _tMAY_t _treturn_t @_tsbmlconstant_t{_tSBML_UNKNOWN_t, _tSBMLTypeCode_t_t}. _tThat_t _tis_t, _tsubclasses_t _tof_t _tSBase_t _tare_t _tnot_t _trequired_t _tto_t _timplement_t _tthis_t _tmethod_t _tto_t _treturn_t _ta_t _ttypecode_t. _tThis_t _tmethod_t _tis_t _tmeant_t _tprimarily_t _tfor_t _tthe_t _tLibSBML_t _tC_t _tinterface_t _twhere_t _tclass_t _tand_t _tsubclass_t _tinformation_t _tis_t _tnot_t _treadily_t _tavailable_t.

@_tnote_t _tIn_t _tlibSBML_t _t5_t, _tthe_t _ttype_t _tof_t _treturn_t _tvalue_t _thas_t _tbeen_t _tchanged_t _tfrom_t _ttypecode_t (_tint_t) _tto_t _tint_t. _tThe_t _treturn_t _tvalue_t _tis_t _tone_t _tof_t _tenum_t _tvalues_t _tdefined_t _tfor_t _teach_t _tpackage_t. _tFor_t _texample_t, _treturn_t _tvalues_t _twill_t _tbe_t _tone_t _tof_t _ttypecode_t (_tint_t) _tif_t _tthis_t _tstructure_t _tis_t _tdefined_t _tin_t _tSBML_t _tcore_t _tpackage_t, _treturn_t _tvalues_t _twill_t _tbe_t _tone_t _tof_t #_tSBMLLayoutTypeCode_t_t _tif_t _tthis_t _tstructure_t _tis_t _tdefined_t _tin_t _tLayout_t _textension_t (_ti_t._te_t. _tsimilar_t _tenum_t _ttypes_t _tare_t _tdefined_t _tin_t _teach_t _tpackage_t _textension_t _tfor_t _teach_t _tSBase_t _tsubclass_t) _tThe_t _tvalue_t _tof_t _teach_t _ttypecode_t _tcan_t _tbe_t _tduplicated_t _tbetween_t _tthose_t _tof_t _tdifferent_t _tpackages_t. _tThus_t, _tto_t _tdistinguish_t _tthe_t _ttypecodes_t _tof_t _tdifferent_t _tpackages_t, _tnot_t _tonly_t _tthe_t _treturn_t _tvalue_t _tof_t _tSBase_getTypeCode_t() _tbut_t _talso_t _tthat_t _tof_t _tSBase_getPackageName_t() _tmust_t _tbe_t _tchecked_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_treturn_t _tthe_t _ttypecode_t (_tint_t _tvalue_t) _tof_t _tthis_t _tSBML_t _tstructure_t _tor_t @_tsbmlconstant_t{_tSBML_UNKNOWN_t, _tSBMLTypeCode_t_t} (_tdefault_t).

@_tsee_t _tSBase_getElementName_t() @_tsee_t _tSBase_getPackageName_t()

@_tmemberof_t _tSBase_t_t

◆ SBase_getUserData()

void * SBase_getUserData ( const SBase_t sb)

_tReturns_t _tthe_t _tuser_t _tdata_t _tthat_t _thas_t _tbeen_t _tpreviously_t _tset_t _tby_t _tsetUserData_t().

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tin_t _tquestion_t. @_treturn_t _tthe_t _tuser_t _tdata_t _tof_t _tthis_t _tnode_t. _tNULL_t _tif_t _tno_t _tuser_t _tdata_t _thas_t _tbeen_t. @_tsee_t _tSBase_setUserData_t

@_tmemberof_t _tSBase_t_t

◆ SBase_getVersion()

unsigned int SBase_getVersion ( const SBase_t sb)

_tReturns_t _tthe_t _tVersion_t _twithin_t _tthe_t _tSBML_t _tLevel_t _tof_t _tthe_t _toverall_t _tSBML_t _tdocument_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t _tthe_t _tSBML_t _tversion_t _tof_t _tthe_t _tgiven_t _tstructure_t.

@_tsee_t _tSBase_getLevel_t()

@_tmemberof_t _tSBase_t_t

◆ SBase_hasValidLevelVersionNamespaceCombination()

int SBase_hasValidLevelVersionNamespaceCombination ( SBase_t sb)

_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 _tstructure_t'_ts_t _tlevel_t/_tversion_t _tand_t _tnamespace_t _tvalues_t _tcorrespond_t _tto_t _ta_t _tvalid_t _tSBML_t _tspecification_t.

_tThe_t _tvalid_t _tcombinations_t _tof_t _tSBML_t _tLevel_t, _tVersion_t _tand_t _tNamespace_t _tas_t _tof_t _tthis_t _trelease_t _tof_t _tlibSBML_t _tare_t _tthe_t _tfollowing_t: <_tul_t> <_tli_t> _tLevel_t&_tnbsp_t;_t1_t _tVersion_t&_tnbsp_t;_t2_t "_thttp_t://_twww_t._tsbml_t._torg_t/_tsbml_t/_tlevel1_t" <_tli_t> _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t1_t "_thttp_t://_twww_t._tsbml_t._torg_t/_tsbml_t/_tlevel2_t" <_tli_t> _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t2_t "_thttp_t://_twww_t._tsbml_t._torg_t/_tsbml_t/_tlevel2_t/_tversion2_t" <_tli_t> _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t3_t "_thttp_t://_twww_t._tsbml_t._torg_t/_tsbml_t/_tlevel2_t/_tversion3_t" <_tli_t> _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t4_t "_thttp_t://_twww_t._tsbml_t._torg_t/_tsbml_t/_tlevel2_t/_tversion4_t" <_tli_t> _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t5_t "_thttp_t://_twww_t._tsbml_t._torg_t/_tsbml_t/_tlevel2_t/_tversion5_t" <_tli_t> _tLevel_t&_tnbsp_t;_t3_t _tVersion_t&_tnbsp_t;_t1_t "_thttp_t://_twww_t._tsbml_t._torg_t/_tsbml_t/_tlevel3_t/_tversion1_t" <_tli_t> _tLevel_t&_tnbsp_t;_t3_t _tVersion_t&_tnbsp_t;_t2_t "_thttp_t://_twww_t._tsbml_t._torg_t/_tsbml_t/_tlevel3_t/_tversion2_t" </_tul_t>

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tlevel_t, _tversion_t _tand_t _tnamespace_t _tvalues_t _tof_t _tthis_t _tSBML_t _tstructure_t _tcorrespond_t _tto_t _ta_t _tvalid_t _tset_t _tof_t _tvalues_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_isSetAnnotation()

int SBase_isSetAnnotation ( const SBase_t sb)

_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 _tgiven_t _tstructure_t'_ts_t "_tannotation_t" _tsubelement_t _tis_t _tset_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tannotation_t" _tsubelement_t _tof_t _tthis_t _tSBML_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSBase_t_t

Examples
printAnnotation.c.

◆ SBase_isSetIdAttribute()

int SBase_isSetIdAttribute ( const SBase_t sb)

_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 _tgiven_t _tstructure_t'_ts_t "_tid_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tto_t _tquery_t

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tSBML_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_isSetMetaId()

int SBase_isSetMetaId ( const SBase_t sb)

_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 _tgiven_t _tstructure_t'_ts_t "_tmetaid_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tmetaid_t" _tattribute_t _tof_t _tthis_t _tSBML_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSBase_t_t

Examples
addingEvidenceCodes_1.c, and addingEvidenceCodes_2.c.

◆ SBase_isSetModelHistory()

int SBase_isSetModelHistory ( SBase_t sb)

_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tModelHistory_t_t _tof_t _ta_t _tgiven_t _tSBase_t_t _tstructure_t _tis_t _tassigned_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tModelHistory_t_t _tof_t _tthis_t _tSBase_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_isSetName()

int SBase_isSetName ( const SBase_t sb)

_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 _tgiven_t _tstructure_t'_ts_t "_tname_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tto_t _tquery_t

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tSBML_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_isSetNotes()

int SBase_isSetNotes ( const SBase_t sb)

_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 _tgiven_t _tstructure_t'_ts_t "_tnotes_t" _tsubelement_t _tis_t _tset_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tnotes_t" _tsubelement_t _tof_t _tthis_t _tSBML_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSBase_t_t

Examples
printNotes.c.

◆ SBase_isSetSBOTerm()

int SBase_isSetSBOTerm ( const SBase_t sb)

_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 _tgiven_t _tstructure_t'_ts_t "_tsboTerm_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tsboTerm_t" _tattribute_t _tof_t _tthis_t _tSBML_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_isSetUserData()

int SBase_isSetUserData ( const SBase_t sb)

_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 _tstructure_t'_ts_t _tuser_t _tdata_t _tobject_t _thas_t _tbeen_t _tset_t.

@_tparam_t _tsb_t _tdefines_t _tthe_t _tnode_t _tof_t _twhich_t _tthe_t _tuser_t _tdata_t _tshould_t _tbe_t _tqueried_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tuser_t _tdata_t _tobject_t _tof_t _tthis_t _tSBML_t _tstructure_t _thas_t _tbeen_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_removeTopLevelAnnotationElement()

int SBase_removeTopLevelAnnotationElement ( SBase_t sb,
const char *  name 
)

_tRemoves_t _tthe_t _ttop_t-_tlevel_t _telement_t _twithin_t _tthe_t "_tannotation_t" _tsubelement_t _tof_t _tthis_t _tSBML_t _tstructure_t _twith_t _tthe_t _tgiven_t _tname_t.

_tSBML_t _tplaces_t _ta_t _tfew_t _trestrictions_t _ton_t _tthe_t _torganization_t _tof_t _tthe_t _tcontent_t _tof_t _tannotations_t; _tthese_t _tare_t _tintended_t _tto_t _thelp_t _tsoftware_t _ttools_t _tread_t _tand_t _twrite_t _tthe_t _tdata_t _tas_t _twell_t _tas_t _thelp_t _treduce_t _tconflicts_t _tbetween_t _tannotations_t _tadded_t _tby_t _tdifferent_t _ttools_t. _tPlease_t _tsee_t _tthe_t _tSBML_t _tspecifications_t _tfor_t _tmore_t _tdetails_t.

_tCalling_t _tthis_t _tmethod_t _tallows_t _ta_t _tparticular_t _tannotation_t _telement_t _tto_t _tbe_t _tremoved_t _twhilst_t _tthe_t _tremaining_t _tannotations_t _tremain_t _tintact_t.

@_tparam_t _tsb_t _tSBase_t_t _tstructure_t _tcontaining_t _tthe_t _tannotation_t _tto_t _tbe_t _taltered_t. @_tparam_t _tname_t _ta_t _tstring_t _trepresenting_t _tthe_t _tname_t _tof_t _tthe_t _ttop_t _tlevel_t _tannotation_t _telement_t _tthat_t _tis_t _tto_t _tbe_t _tremoved_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_ANNOTATION_NAME_NOT_FOUND_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_ANNOTATION_NS_NOT_FOUND_t, _tOperationReturnValues_t_t}

@_tsee_t _tSBase_removeTopLevelAnnotationElementWithURI_t (_tSBase_t_t *, _tconst_t _tchar_t *, _tconst_t _tchar_t *) @_tsee_t _tSBase_replaceTopLevelAnnotationElement_t (_tSBase_t_t *, _tXMLNode_t_t *) @_tsee_t _tSBase_replaceTopLevelAnnotationElementString_t (_tSBase_t_t *, _tchar_t *)

@_tmemberof_t _tSBase_t_t

◆ SBase_removeTopLevelAnnotationElementWithURI()

int SBase_removeTopLevelAnnotationElementWithURI ( SBase_t sb,
const char *  name,
const char *  uri 
)

_tRemoves_t _tthe_t _ttop_t-_tlevel_t _telement_t _twithin_t _tthe_t "_tannotation_t" _tsubelement_t _tof_t _tthis_t _tSBML_t _tstructure_t _twith_t _tthe_t _tgiven_t _tname_t _tand_t _tURI_t.

_tSBML_t _tplaces_t _ta_t _tfew_t _trestrictions_t _ton_t _tthe_t _torganization_t _tof_t _tthe_t _tcontent_t _tof_t _tannotations_t; _tthese_t _tare_t _tintended_t _tto_t _thelp_t _tsoftware_t _ttools_t _tread_t _tand_t _twrite_t _tthe_t _tdata_t _tas_t _twell_t _tas_t _thelp_t _treduce_t _tconflicts_t _tbetween_t _tannotations_t _tadded_t _tby_t _tdifferent_t _ttools_t. _tPlease_t _tsee_t _tthe_t _tSBML_t _tspecifications_t _tfor_t _tmore_t _tdetails_t.

_tCalling_t _tthis_t _tmethod_t _tallows_t _ta_t _tparticular_t _tannotation_t _telement_t _tto_t _tbe_t _tremoved_t _twhilst_t _tthe_t _tremaining_t _tannotations_t _tremain_t _tintact_t.

@_tparam_t _tsb_t _tSBase_t_t _tstructure_t _tcontaining_t _tthe_t _tannotation_t _tto_t _tbe_t _taltered_t. @_tparam_t _tname_t _ta_t _tstring_t _trepresenting_t _tthe_t _tname_t _tof_t _tthe_t _ttop_t _tlevel_t _tannotation_t _telement_t _tthat_t _tis_t _tto_t _tbe_t _tremoved_t. @_tparam_t _turi_t _ta_t _tstring_t _tthat_t _tis_t _tused_t _tto_t _tcheck_t _tboth_t _tthe_t _tname_t _tand_t _tURI_t _tof_t _tthe_t _ttop_t _tlevel_t _telement_t _tto_t _tbe_t _tremoved_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_ANNOTATION_NAME_NOT_FOUND_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_ANNOTATION_NS_NOT_FOUND_t, _tOperationReturnValues_t_t}

@_tsee_t _tSBase_removeTopLevelAnnotationElement_t (_tSBase_t_t *, _tconst_t _tchar_t *) @_tsee_t _tSBase_replaceTopLevelAnnotationElement_t (_tSBase_t_t *, _tXMLNode_t_t *) @_tsee_t _tSBase_replaceTopLevelAnnotationElementString_t (_tSBase_t_t *, _tchar_t *)

@_tmemberof_t _tSBase_t_t

◆ SBase_renameMetaIdRefs()

void SBase_renameMetaIdRefs ( SBase_t sb,
const char *  oldid,
const char *  newid 
)

_tRenames_t _tall_t _tthe_t _tmeta_t-_tidentifier_t _tattributes_t _ton_t _tthis_t _telement_t.

@_tcopydetails_t _tdoc_what_is_metaidref_t

_tThis_t _tmethod_t _tworks_t _tby_t _tlooking_t _tat_t _tall_t _tmeta_t-_tidentifier_t _tattribute_t _tvalues_t, _tcomparing_t _tthe_t _tidentifiers_t _tto_t _tthe_t _tvalue_t _tof_t @_tp_t _toldid_t. _tIf_t _tany_t _tmatches_t _tare_t _tfound_t, _tthe_t _tmatching_t _tidentifiers_t _tare_t _treplaced_t _twith_t @_tp_t _tnewid_t. _tThe_t _tmethod_t _tdoes_t @_tem_t _tnot_t _tdescend_t _tinto_t _tchild_t _telements_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tin_t _tquestion_t. @_tparam_t _toldid_t _tthe_t _told_t _tidentifier_t. @_tparam_t _tnewid_t _tthe_t _tnew_t _tidentifier_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_renameSIdRefs()

void SBase_renameSIdRefs ( SBase_t sb,
const char *  oldid,
const char *  newid 
)

_tRenames_t _tall_t _tthe_t @_tc_t _tSIdRef_t _tattributes_t _ton_t _tthis_t _telement_t, _tincluding_t _tany_t _tfound_t _tin_t _tMathML_t _tcontent_t (_tif_t _tsuch_t _texists_t).

@_tcopydetails_t _tdoc_what_is_sidref_t

_tThis_t _tmethod_t _tworks_t _tby_t _tlooking_t _tat_t _tall_t _tattributes_t _tand_t (_tif_t _tappropriate_t) _tmathematical_t _tformulas_t, _tcomparing_t _tthe_t _tidentifiers_t _tto_t _tthe_t _tvalue_t _tof_t @_tp_t _toldid_t. _tIf_t _tany_t _tmatches_t _tare_t _tfound_t, _tthe_t _tmatching_t _tidentifiers_t _tare_t _treplaced_t _twith_t @_tp_t _tnewid_t. _tThe_t _tmethod_t _tdoes_t @_tem_t _tnot_t _tdescend_t _tinto_t _tchild_t _telements_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tin_t _tquestion_t. @_tparam_t _toldid_t _tthe_t _told_t _tidentifier_t. @_tparam_t _tnewid_t _tthe_t _tnew_t _tidentifier_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_renameUnitSIdRefs()

void SBase_renameUnitSIdRefs ( SBase_t sb,
const char *  oldid,
const char *  newid 
)

_tRenames_t _tall_t _tthe_t @_tc_t _tUnitSIdRef_t _tattributes_t _ton_t _tthis_t _telement_t.

@_tcopydetails_t _tdoc_what_is_unitsidref_t

_tThis_t _tmethod_t _tworks_t _tby_t _tlooking_t _tat_t _tall_t _tunit_t _tidentifier_t _tattribute_t _tvalues_t (_tincluding_t, _tif_t _tappropriate_t, _tinside_t _tmathematical_t _tformulas_t), _tcomparing_t _tthe_t _tunit_t _tidentifiers_t _tto_t _tthe_t _tvalue_t _tof_t @_tp_t _toldid_t. _tIf_t _tany_t _tmatches_t _tare_t _tfound_t, _tthe_t _tmatching_t _tidentifiers_t _tare_t _treplaced_t _twith_t @_tp_t _tnewid_t. _tThe_t _tmethod_t _tdoes_t @_tem_t _tnot_t _tdescend_t _tinto_t _tchild_t _telements_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t _tin_t _tquestion_t. @_tparam_t _toldid_t _tthe_t _told_t _tidentifier_t. @_tparam_t _tnewid_t _tthe_t _tnew_t _tidentifier_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_replaceTopLevelAnnotationElement()

int SBase_replaceTopLevelAnnotationElement ( SBase_t sb,
const XMLNode_t annotation 
)

_tReplaces_t _tthe_t _tgiven_t _ttop_t-_tlevel_t _telement_t _twithin_t _tthe_t "_tannotation_t" _tsubelement_t _tof_t _tthis_t _tSBML_t _tstructure_t _tand_t _twith_t _tthe_t _tannotation_t _telement_t _tsupplied_t.

_tSBML_t _tplaces_t _ta_t _tfew_t _trestrictions_t _ton_t _tthe_t _torganization_t _tof_t _tthe_t _tcontent_t _tof_t _tannotations_t; _tthese_t _tare_t _tintended_t _tto_t _thelp_t _tsoftware_t _ttools_t _tread_t _tand_t _twrite_t _tthe_t _tdata_t _tas_t _twell_t _tas_t _thelp_t _treduce_t _tconflicts_t _tbetween_t _tannotations_t _tadded_t _tby_t _tdifferent_t _ttools_t. _tPlease_t _tsee_t _tthe_t _tSBML_t _tspecifications_t _tfor_t _tmore_t _tdetails_t.

_tThis_t _tmethod_t _tdetermines_t _tthe_t _tname_t _tof_t _tthe_t _telement_t _tto_t _tbe_t _treplaced_t _tfrom_t _tthe_t _tannotation_t _targument_t. _tFunctionally_t _tit_t _tis_t _tequivalent_t _tto_t _tcalling_t <_tcode_t> _tSBase_removeTopLevelAnnotationElement_t(_tsb_t, _tname_t); _tSBase_appendAnnotation_t(_tsb_t, _tannotation_with_name_t); </_tcode_t> _twith_t _tthe_t _texception_t _tthat_t _tthe_t _tplacement_t _tof_t _tthe_t _tannotation_t _telement_t _tremains_t _tthe_t _tsame_t.

@_tparam_t _tsb_t _tSBase_t_t _tstructure_t _tcontaining_t _tthe_t _tannotation_t _tto_t _tbe_t _taltered_t. @_tparam_t _tannotation_t _tXMLNode_t _trepresenting_t _tthe_t _treplacement_t _ttop_t _tlevel_t _tannotation_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_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tsee_t _tSBase_removeTopLevelAnnotationElement_t (_tSBase_t_t *, _tconst_t _tchar_t *) @_tsee_t _tSBase_removeTopLevelAnnotationElementWithURI_t (_tSBase_t_t *, _tconst_t _tchar_t *, _tconst_t _tchar_t *) @_tsee_t _tSBase_replaceTopLevelAnnotationElementString_t (_tSBase_t_t *, _tchar_t *)

@_tmemberof_t _tSBase_t_t

◆ SBase_replaceTopLevelAnnotationElementString()

int SBase_replaceTopLevelAnnotationElementString ( SBase_t sb,
const char *  annotation 
)

_tReplaces_t _tthe_t _tgiven_t _ttop_t-_tlevel_t _telement_t _twithin_t _tthe_t "_tannotation_t" _tsubelement_t _tof_t _tthis_t _tSBML_t _tstructure_t _tand_t _twith_t _tthe_t _tannotation_t _telement_t _tsupplied_t.

_tSBML_t _tplaces_t _ta_t _tfew_t _trestrictions_t _ton_t _tthe_t _torganization_t _tof_t _tthe_t _tcontent_t _tof_t _tannotations_t; _tthese_t _tare_t _tintended_t _tto_t _thelp_t _tsoftware_t _ttools_t _tread_t _tand_t _twrite_t _tthe_t _tdata_t _tas_t _twell_t _tas_t _thelp_t _treduce_t _tconflicts_t _tbetween_t _tannotations_t _tadded_t _tby_t _tdifferent_t _ttools_t. _tPlease_t _tsee_t _tthe_t _tSBML_t _tspecifications_t _tfor_t _tmore_t _tdetails_t.

_tThis_t _tmethod_t _tdetermines_t _tthe_t _tname_t _tof_t _tthe_t _telement_t _tto_t _tbe_t _treplaced_t _tfrom_t _tthe_t _tannotation_t _targument_t. _tFunctionally_t _tit_t _tis_t _tequivalent_t _tto_t _tcalling_t <_tcode_t> _tSBase_removeTopLevelAnnotationElement_t(_tsb_t, _tname_t); _tSBase_appendAnnotation_t(_tsb_t, _tannotation_with_name_t); </_tcode_t> _twith_t _tthe_t _texception_t _tthat_t _tthe_t _tplacement_t _tof_t _tthe_t _tannotation_t _telement_t _tremains_t _tthe_t _tsame_t.

@_tparam_t _tsb_t _tSBase_t_t _tstructure_t _tcontaining_t _tthe_t _tannotation_t _tto_t _tbe_t _taltered_t. @_tparam_t _tannotation_t _tstring_t _trepresenting_t _tthe_t _treplacement_t _ttop_t _tlevel_t _tannotation_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_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tsee_t _tSBase_removeTopLevelAnnotationElement_t (_tSBase_t_t *, _tconst_t _tchar_t *) @_tsee_t _tSBase_removeTopLevelAnnotationElementWithURI_t (_tSBase_t_t *, _tconst_t _tchar_t *, _tconst_t _tchar_t *) @_tsee_t _tSBase_replaceTopLevelAnnotationElement_t (_tSBase_t_t *, _tXMLNode_t_t *)

@_tmemberof_t _tSBase_t_t

◆ SBase_setAnnotation()

int SBase_setAnnotation ( SBase_t sb,
const XMLNode_t annotation 
)

_tSets_t _tthe_t _tannotation_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tgiven_t _tSBML_t _tstructure_t. @_tparam_t _tannotation_t _tthe_t _tXMLNode_t_t _tstructure_t _trepresenting_t _tthe_t _tannotation_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 _tSBase_t_t

◆ SBase_setAnnotationString()

int SBase_setAnnotationString ( SBase_t sb,
const char *  annotation 
)

_tSets_t _tthe_t _tannotation_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tgiven_t _tSBML_t _tstructure_t. @_tparam_t _tannotation_t _tthe_t _tstring_t _trepresenting_t _tthe_t _tannotation_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}

@_tmemberof_t _tSBase_t_t

◆ SBase_setIdAttribute()

int SBase_setIdAttribute ( SBase_t sb,
const char *  id 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.

_tThe_t _tstring_t @_tp_t _tid_t _tis_t _tcopied_t. _tThe_t _tvalue_t _tof_t @_tp_t _tmetaid_t _tmust_t _tbe_t _tan_t _tidentifier_t _tconforming_t _tto_t _tthe_t _tsyntax_t _tdefined_t _tby_t _tSBML_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t

@_tparam_t _tid_t _tthe_t _tidentifier_t _tstring_t _tto_t _tuse_t _tas_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaid_t" _tattribute_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_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _tthe_t _tid_t _tset_t _tto_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tid_t" _tattribute_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_setMetaId()

int SBase_setMetaId ( SBase_t sb,
const char *  metaid 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.

_tThe_t _tstring_t @_tp_t _tmetaid_t _tis_t _tcopied_t. _tThe_t _tvalue_t _tof_t @_tp_t _tmetaid_t _tmust_t _tbe_t _tan_t _tidentifier_t _tconforming_t _tto_t _tthe_t _tsyntax_t _tdefined_t _tby_t _tthe_t _tXML_t _t1_t._t0_t _tdata_t _ttype_t _tID_t. _tAmong_t _tother_t _tthings_t, _tthis_t _ttype_t _trequires_t _tthat_t _ta_t _tvalue_t _tis_t _tunique_t _tamong_t _tall_t _tthe_t _tvalues_t _tof_t _ttype_t _tXML_t _tID_t _tin_t _tan_t _tSBMLDocument_t_t. _tAlthough_t _tSBML_t _tonly_t _tuses_t _tXML_t _tID_t _tfor_t _tthe_t "_tmetaid_t" _tattribute_t, _tcallers_t _tshould_t _tbe_t _tcareful_t _tif_t _tthey_t _tuse_t _tXML_t _tID_t'_ts_t _tin_t _tXML_t _tportions_t _tof_t _ta_t _tmodel_t _tthat_t _tare_t _tnot_t _tdefined_t _tby_t _tSBML_t, _tsuch_t _tas_t _tin_t _tthe_t _tapplication_t-_tspecific_t _tcontent_t _tof_t _tthe_t "_tannotation_t" _tsubelement_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_tparam_t _tmetaid_t _tthe_t _tidentifier_t _tstring_t _tto_t _tuse_t _tas_t _tthe_t _tvalue_t _tof_t _tthe_t "_tmetaid_t" _tattribute_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_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _tthe_t _tmetaid_t _tset_t _tto_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tmetaid_t" _tattribute_t.

@_tmemberof_t _tSBase_t_t

Examples
addingEvidenceCodes_1.c, and addingEvidenceCodes_2.c.

◆ SBase_setModelHistory()

int SBase_setModelHistory ( SBase_t sb,
ModelHistory_t history 
)

_tSet_t _tthe_t _tModelHistory_t_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t. @_tparam_t _thistory_t _tthe_t _tModelHistory_t_t _tstructure_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 _tSBase_t_t

◆ SBase_setName()

int SBase_setName ( SBase_t sb,
const char *  name 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.

_tThe_t _tstring_t @_tp_t _tname_t _tis_t _tcopied_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t

@_tparam_t _tname_t _tthe_t _tstring_t _tto_t _tuse_t _tas_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_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_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _tthe_t _tname_t _tset_t _tto_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tname_t" _tattribute_t.

@_tmemberof_t _tSBase_t_t

◆ SBase_setNamespaces()

int SBase_setNamespaces ( SBase_t sb,
XMLNamespaces_t xmlns 
)

_tSets_t _tthe_t _tnamespaces_t _trelevant_t _tof_t _tthis_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_tparam_t _txmlns_t _tthe_t _tnamespaces_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 _tSBase_t_t

◆ SBase_setNotes()

int SBase_setNotes ( SBase_t sb,
const XMLNode_t notes 
)

_tSets_t _tthe_t _tnotes_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tgiven_t _tSBML_t _tstructure_t. @_tparam_t _tnotes_t _tthe_t _tXMLNode_t_t _tstructure_t _trepresenting_t _tthe_t _tnotes_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 _tSBase_t_t

Examples
createExampleSBML.c.

◆ SBase_setNotesString()

int SBase_setNotesString ( SBase_t sb,
const char *  notes 
)

_tSets_t _tthe_t _tnotes_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tgiven_t _tSBML_t _tstructure_t. @_tparam_t _tnotes_t _tthe_t _tstring_t _trepresenting_t _tthe_t _tnotes_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSBase_t_t

Examples
createExampleSBML.c.

◆ SBase_setNotesStringAddMarkup()

int SBase_setNotesStringAddMarkup ( SBase_t sb,
const char *  notes 
)

_tSets_t _tthe_t _tnotes_t _tfor_t _tthe_t _tgiven_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tgiven_t _tSBML_t _tstructure_t. @_tparam_t _tnotes_t _tthe_t _tstring_t _trepresenting_t _tthe_t _tnotes_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSBase_t_t

◆ SBase_setSBOTerm()

int SBase_setSBOTerm ( SBase_t sb,
int  value 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsboTerm_t" _tattribute_t.

@_tcopydetails_t _tdoc_sbo_terms_t @_tcopydetails_t _tdoc_sbo_terms_addendum_t

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t. @_tparam_t _tvalue_t _tthe_t _tNNNNNNN_t _tinteger_t _tportion_t _tof_t _tthe_t _tSBO_t _tidentifier_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_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSBase_t_t

◆ SBase_setSBOTermID()

int SBase_setSBOTermID ( SBase_t sb,
const char *  sboid 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsboTerm_t" _tattribute_t _tby_t _tstring_t.

@_tcopydetails_t _tdoc_sbo_terms_t @_tcopydetails_t _tdoc_sbo_terms_addendum_t

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_tparam_t _tsboid_t _tthe_t _tSBO_t _tidentifier_t _tstring_t _tof_t _tthe_t _tform_t _tSBO_t:_tNNNNNNN_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_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSBase_t_t

◆ SBase_setUserData()

int SBase_setUserData ( SBase_t sb,
void *  userData 
)

_tSets_t _tthe_t _tuser_t _tdata_t _tof_t _tthis_t _tnode_t.

_tThis_t _tcan_t _tbe_t _tused_t _tby_t _tthe_t _tapplication_t _tdeveloper_t _tto_t _tattach_t _tcustom_t _tinformation_t _tto_t _tthe_t _tnode_t. _tIn_t _tcase_t _tof_t _ta_t _tdeep_t _tcopy_t _tthis_t _tattribute_t _twill_t _tpassed_t _tas_t _tit_t _tis_t. _tThe_t _tattribute_t _twill_t _tbe_t _tnever_t _tinterpreted_t _tby_t _tthis_t _tclass_t.

@_tparam_t _tsb_t _tdefines_t _tthe_t _tnode_t _tof_t _twhich_t _tthe_t _tuser_t _tdata_t _tshould_t _tbe_t _tset_t. @_tparam_t _tuserData_t _tspecifies_t _tthe_t _tnew_t _tuser_t _tdata_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_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSBase_t_t

◆ SBase_unsetAnnotation()

int SBase_unsetAnnotation ( SBase_t sb)

_tUnsets_t _tthe_t "_tannotation_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_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 _tSBase_t_t

Examples
unsetAnnotation.c.

◆ SBase_unsetCVTerms()

int SBase_unsetCVTerms ( SBase_t sb)

_tClears_t _tthe_t _tlist_t _tof_t _tCVTerm_t_t'_ts_t _tof_t _tthis_t _tSBML_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tstructure_t _tto_t _tclear_t _tCVTerm_t_t'_ts_t _tfrom_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}

@_tmemberof_t _tSBase_t_t

◆ SBase_unsetIdAttribute()

int SBase_unsetIdAttribute ( SBase_t sb)

_tUnsets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_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}

@_tmemberof_t _tSBase_t_t

◆ SBase_unsetMetaId()

int SBase_unsetMetaId ( SBase_t sb)

_tUnsets_t _tthe_t "_tmetaid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_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}

@_tmemberof_t _tSBase_t_t

◆ SBase_unsetModelHistory()

int SBase_unsetModelHistory ( SBase_t sb)

_tUnsets_t _tthe_t _tModelHistory_t_t _tof_t _tthe_t _tgiven_t _tSBase_t_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_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}

@_tmemberof_t _tSBase_t_t

◆ SBase_unsetName()

int SBase_unsetName ( SBase_t sb)

_tUnsets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_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}

@_tmemberof_t _tSBase_t_t

◆ SBase_unsetNotes()

int SBase_unsetNotes ( SBase_t sb)

_tUnsets_t _tthe_t "_tnotes_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_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 _tSBase_t_t

Examples
unsetNotes.c.

◆ SBase_unsetSBOTerm()

int SBase_unsetSBOTerm ( SBase_t sb)

_tUnsets_t _tthe_t "_tsboTerm_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tstructure_t.

@_tparam_t _tsb_t _tthe_t _tSBase_t_t _tstructure_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSBase_t_t

◆ SBase_unsetUserData()

int SBase_unsetUserData ( SBase_t sb)

_tUnsets_t _tthe_t _tuser_t _tdata_t _tof_t _tthis_t _tnode_t.

@_tparam_t _tsb_t _tdefines_t _tthe_t _tnode_t _tof_t _twhich_t _tthe_t _tuser_t _tdata_t _tshould_t _tbe_t _tunset_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_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSBase_t_t