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

Implementation of SpeciesReference_t and ListOfSpeciesReferences_t. More...

Include dependency graph for SpeciesReference.cpp:

Functions

SpeciesReference_tListOfSpeciesReferences_getById (ListOf_t *lo, const char *sid)
 _tReturns_t _tthe_t _tSpeciesReference_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.
 
SpeciesReference_tListOfSpeciesReferences_removeById (ListOf_t *lo, const char *sid)
 _tRemoves_t _ta_t _tSpeciesReference_t_t _tstructure_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
SpeciesReference_tSpeciesReference_clone (const SpeciesReference_t *sr)
 _tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
SpeciesReference_tSpeciesReference_create (unsigned int level, unsigned int version)
 @_tendcond_t
 
SpeciesReference_tSpeciesReference_createModifier (unsigned int level, unsigned int version)
 _tCreates_t _ta_t _tnew_t _tModifierSpeciesReference_t (_tSpeciesReference_t_t) _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
 
SpeciesReference_tSpeciesReference_createModifierWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tModifierSpeciesReference_t (_tSpeciesReference_t_t) _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
 
StoichiometryMath_tSpeciesReference_createStoichiometryMath (SpeciesReference_t *sr)
 _tCreates_t _ta_t _tnew_t, _tempty_t _tStoichiometryMath_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t @_tp_t _tsr_t _tSpeciesReference_t_t, _tand_t _treturns_t _tit_t.
 
SpeciesReference_tSpeciesReference_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tSpeciesReference_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
 
void SpeciesReference_free (SpeciesReference_t *sr)
 _tFrees_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_getConstant (const SpeciesReference_t *sr)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t.
 
int SpeciesReference_getDenominator (const SpeciesReference_t *sr)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tdenominator_t" _tattribute_t, _tfor_t _tthe_t _tcase_t _tof_t _ta_t _trational_t-_tnumbered_t _tstoichiometry_t _tor_t _ta_t _tmodel_t _tin_t _tSBML_t _tLevel_t _t1_t.
 
const char * SpeciesReference_getId (const SpeciesReference_t *sr)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
const char * SpeciesReference_getName (const SpeciesReference_t *sr)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
const XMLNamespaces_tSpeciesReference_getNamespaces (const SpeciesReference_t *sr)
 _tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tSpeciesReference_t_t _tstructure_t.
 
const char * SpeciesReference_getSpecies (const SpeciesReference_t *sr)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
double SpeciesReference_getStoichiometry (const SpeciesReference_t *sr)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tstoichiometry_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
StoichiometryMath_tSpeciesReference_getStoichiometryMath (SpeciesReference_t *sr)
 _tGet_t _tthe_t _tcontent_t _tof_t _tthe_t "_tstoichiometryMath_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_hasRequiredAttributes (SpeciesReference_t *sr)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tSpeciesReference_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
void SpeciesReference_initDefaults (SpeciesReference_t *sr)
 _tInitializes_t _tthe_t _tattributes_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tto_t _ttheir_t _tdefaults_t:
 
int SpeciesReference_isModifier (const SpeciesReference_t *sr)
 _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 _tSpeciesReference_t_t _tstructure_t _tis_t _ta_t _tmodifier_t.
 
int SpeciesReference_isSetConstant (const SpeciesReference_t *sr)
 _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 "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tset_t.
 
int SpeciesReference_isSetId (const SpeciesReference_t *sr)
 _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 "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tset_t.
 
int SpeciesReference_isSetName (const SpeciesReference_t *sr)
 _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 "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tset_t.
 
int SpeciesReference_isSetSpecies (const SpeciesReference_t *sr)
 _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 "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tset_t.
 
int SpeciesReference_isSetStoichiometry (const SpeciesReference_t *sr)
 _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 "_tstoichiometry_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tset_t.
 
int SpeciesReference_isSetStoichiometryMath (const SpeciesReference_t *sr)
 _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 "_tstoichiometryMath_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tnon_t-_tempty_t.
 
int SpeciesReference_setConstant (SpeciesReference_t *sr, int value)
 _tAssign_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _ta_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_setDenominator (SpeciesReference_t *sr, int value)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tdenominator_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_setId (SpeciesReference_t *sr, const char *sid)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_setName (SpeciesReference_t *sr, const char *name)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_setSpecies (SpeciesReference_t *sr, const char *sid)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_setStoichiometry (SpeciesReference_t *sr, double value)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tstoichiometry_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_setStoichiometryMath (SpeciesReference_t *sr, const StoichiometryMath_t *math)
 _tSets_t _tthe_t _tcontent_t _tof_t _tthe_t "_tstoichiometryMath_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_unsetConstant (SpeciesReference_t *sr)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_unsetId (SpeciesReference_t *sr)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_unsetName (SpeciesReference_t *sr)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_unsetSpecies (SpeciesReference_t *sr)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_unsetStoichiometry (SpeciesReference_t *sr)
 _tUnsets_t _tthe_t _tcontent_t _tof_t _tthe_t "_tstoichiometry_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 
int SpeciesReference_unsetStoichiometryMath (SpeciesReference_t *sr)
 _tUnsets_t _tthe_t _tcontent_t _tof_t _tthe_t "_tstoichiometryMath_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.
 

Detailed Description

Implementation of SpeciesReference_t and ListOfSpeciesReferences_t.

Author
Ben Bornstein

Function Documentation

◆ ListOfSpeciesReferences_getById()

SpeciesReference_t * ListOfSpeciesReferences_getById ( ListOf_t lo,
const char *  sid 
)

_tReturns_t _tthe_t _tSpeciesReference_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.

@_tparam_t _tlo_t _tthe_t _tListOfSpeciesReferences_t_t _tstructure_t _tto_t _tsearch_t. @_tparam_t _tsid_t _tthe_t "_tid_t" _tattribute_t _tvalue_t _tbeing_t _tsought_t.

@_treturn_t _titem_t _tin_t _tthe_t @_tp_t _tlo_t _tListOfSpeciesReferences_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tor_t _ta_t _tnull_t _tpointer_t _tif_t _tno_t _tsuch_t _titem_t _texists_t.

@_tsee_t _tListOf_t_t

@_tmemberof_t _tListOfSpeciesReferences_t_t

◆ ListOfSpeciesReferences_removeById()

SpeciesReference_t * ListOfSpeciesReferences_removeById ( ListOf_t lo,
const char *  sid 
)

_tRemoves_t _ta_t _tSpeciesReference_t_t _tstructure_t _tbased_t _ton_t _tits_t _tidentifier_t.

_tThe_t _tcaller_t _towns_t _tthe_t _treturned_t _titem_t _tand_t _tis_t _tresponsible_t _tfor_t _tdeleting_t _tit_t.

@_tparam_t _tlo_t _tthe_t _tlist_t _tof_t _tSpeciesReference_t_t _tstructures_t _tto_t _tsearch_t. @_tparam_t _tsid_t _tthe_t "_tid_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tstructure_t _tto_t _tremove_t.

@_treturn_t _tThe_t _tSpeciesReference_t_t _tstructure_t _tremoved_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _tno_t _tsuch_t _titem_t _texists_t _tin_t @_tp_t _tlo_t.

@_tsee_t _tListOf_t_t

@_tmemberof_t _tListOfSpeciesReferences_t_t

◆ SpeciesReference_clone()

SpeciesReference_t * SpeciesReference_clone ( const SpeciesReference_t sr)

_tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tSpeciesReference_t_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_create()

SpeciesReference_t * SpeciesReference_create ( unsigned int  level,
unsigned int  version 
)

@_tendcond_t

_tCreates_t _ta_t _tnew_t _tSpeciesReference_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t _tvalues_t.

@_tcond_t _tdoxygenIgnored_t

◆ SpeciesReference_createModifier()

SpeciesReference_t * SpeciesReference_createModifier ( unsigned int  level,
unsigned int  version 
)

_tCreates_t _ta_t _tnew_t _tModifierSpeciesReference_t (_tSpeciesReference_t_t) _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.

@_tparam_t _tlevel_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t _tLevel_t _tto_t _tassign_t _tto_t _tthis_t _tSpeciesReference_t_t.

@_tparam_t _tversion_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t _tVersion_t _tto_t _tassign_t _tto_t _tthis_t _tSpeciesReference_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tSpeciesReference_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_createModifierWithNS()

SpeciesReference_t * SpeciesReference_createModifierWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tModifierSpeciesReference_t (_tSpeciesReference_t_t) _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.

@_tparam_t _tsbmlns_t _tSBMLNamespaces_t_t, _ta_t _tpointer_t _tto_t _tan_t _tSBMLNamespaces_t_t _tstructure_t _tto_t _tassign_t _tto_t _tthis_t _tmodifier_t _tSpeciesReference_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tSpeciesReference_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_createStoichiometryMath()

StoichiometryMath_t * SpeciesReference_createStoichiometryMath ( SpeciesReference_t sr)

_tCreates_t _ta_t _tnew_t, _tempty_t _tStoichiometryMath_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t @_tp_t _tsr_t _tSpeciesReference_t_t, _tand_t _treturns_t _tit_t.

@_treturn_t _tthe_t _tnewly_t _tcreated_t _tStoichiometryMath_t_t _tstructure_t _tinstance_t.

@_tsee_t _tReaction_addReactant_t() @_tsee_t _tReaction_addProduct_t()

@_tnote_t _tThis_t _tfunction_t _thas_t _tno_t _teffect_t _ton_t _tSBML_t _tLevel_t _t1_t _tor_t _tLevel_t _t3_t _tSpeciesReference_t_t _telements_t, _tneither_t _tof_t _twhich_t _thave_t _tStoichiometryMath_t_t _tchildren_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_createWithNS()

SpeciesReference_t * SpeciesReference_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tSpeciesReference_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.

@_tparam_t _tsbmlns_t _tSBMLNamespaces_t_t, _ta_t _tpointer_t _tto_t _tan_t _tSBMLNamespaces_t_t _tstructure_t _tto_t _tassign_t _tto_t _tthis_t _tSpeciesReference_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tSpeciesReference_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_free()

void SpeciesReference_free ( SpeciesReference_t sr)

_tFrees_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_getConstant()

int SpeciesReference_getConstant ( const SpeciesReference_t sr)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t _tconstant_t _tattribute_t _tof_t _tthis_t _tSpeciesReference_t_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_getDenominator()

int SpeciesReference_getDenominator ( const SpeciesReference_t sr)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tdenominator_t" _tattribute_t, _tfor_t _tthe_t _tcase_t _tof_t _ta_t _trational_t-_tnumbered_t _tstoichiometry_t _tor_t _ta_t _tmodel_t _tin_t _tSBML_t _tLevel_t _t1_t.

_tThe_t "_tdenominator_t" _tattribute_t _tis_t _tonly_t _tactually_t _twritten_t _tout_t _tin_t _tthe_t _tcase_t _tof_t _tan_t _tSBML_t _tLevel_t _t1_t _tmodel_t. _tIn_t _tSBML_t _tLevel_t _t2_t, _trational_t-_tnumber_t _tstoichiometries_t _tare_t _twritten_t _tas_t _tMathML_t _telements_t _tin_t _tthe_t "_tstoichiometryMath_t" _tsubelement_t. _tHowever_t, _tas_t _ta_t _tconvenience_t _tto_t _tusers_t, _tlibSBML_t _tallows_t _tthe_t _tcreation_t _tand_t _tmanipulation_t _tof_t _trational_t-_tnumber_t _tstoichiometries_t _tby_t _tsupplying_t _tthe_t _tnumerator_t _tand_t _tdenominator_t _tdirectly_t _trather_t _tthan_t _thaving_t _tto_t _tmanually_t _tcreate_t _tan_t _tASTNode_t_t _tstructure_t. _tLibSBML_t _twill_t _twrite_t _tout_t _tthe_t _tappropriate_t _tconstructs_t (_teither_t _ta_t _tcombination_t _tof_t "_tstoichiometry_t" _tand_t "_tdenominator_t" _tin_t _tthe_t _tcase_t _tof_t _tSBML_t _tLevel_t _t1_t, _tor_t _ta_t "_tstoichiometryMath_t" _tsubelement_t _tin_t _tthe_t _tcase_t _tof_t _tSBML_t _tLevel_t _t2_t). _tHowever_t, _tas_t _tthe_t "_tstoichiometryMath_t" _tsubelement_t _twas_t _tremoved_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t, _tautomatic_t _ttranslation_t _tof_t _tthe_t "_tdenominator_t" _tattribute_t _tis_t _tno_t _tlonger_t _tsupported_t _tfor_t _tthat_t _tlevel_t.

_tThis_t _tfunction_t _treturns_t _t0_t _tif_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tis_t _ta_t _tModifer_t (_tsee_t _tSpeciesReference_isModifier_t()).

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t _tdenominator_t _tof_t _tthis_t _tSpeciesReference_t_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_getId()

const char * SpeciesReference_getId ( const SpeciesReference_t sr)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t _tidentifier_t _tof_t _tthe_t _tSpeciesReference_t_t _tinstance_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_getName()

const char * SpeciesReference_getName ( const SpeciesReference_t sr)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t _tname_t _tof_t _tthe_t _tSpeciesReference_t_t _tinstance_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_getNamespaces()

const XMLNamespaces_t * SpeciesReference_getNamespaces ( const SpeciesReference_t sr)

_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tSpeciesReference_t_t _tstructure_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t.

@_treturn_t _tpointer_t _tto_t _tthe_t _tXMLNamespaces_t_t _tstructure_t _tassociated_t _twith_t _tthis_t _tstructure_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_getSpecies()

const char * SpeciesReference_getSpecies ( const SpeciesReference_t sr)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t "_tspecies_t" _tattribute_t _tvalue_t.

@_tmemberof_t _tSpeciesReference_t_t

Examples
printAnnotation.c, and printNotes.c.

◆ SpeciesReference_getStoichiometry()

double SpeciesReference_getStoichiometry ( const SpeciesReference_t sr)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tstoichiometry_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

_tThis_t _tfunction_t _treturns_t @_tc_t _t0_t _tif_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tis_t _ta_t _tModifer_t (_tsee_t _tSpeciesReference_isModifier_t()).

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t "_tstoichiometry_t" _tattribute_t _tvalue_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_getStoichiometryMath()

StoichiometryMath_t * SpeciesReference_getStoichiometryMath ( SpeciesReference_t sr)

_tGet_t _tthe_t _tcontent_t _tof_t _tthe_t "_tstoichiometryMath_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

_tThis_t _tfunction_t _treturns_t _tNULL_t _tif_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tis_t _ta_t _tModifer_t (_tsee_t _tSpeciesReference_isModifier_t()).

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t _tstoichiometryMath_t _tof_t _tthis_t _tSpeciesReference_t_t.

@_tnote_t _tThis_t _tfunction_t _thas_t _tno_t _teffect_t _ton_t _tSBML_t _tLevel_t _t1_t _tor_t _tLevel_t _t3_t _tSpeciesReference_t_t _tobjects_t, _tneither_t _tof_t _twhich_t _thave_t _tStoichiometryMath_t_t _tchildren_t.

@_tmemberof_t _tSpeciesReference_t_t

Examples
printUnits.c.

◆ SpeciesReference_hasRequiredAttributes()

int SpeciesReference_hasRequiredAttributes ( SpeciesReference_t sr)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tSpeciesReference_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

_tThe_t _trequired_t _tattributes_t _tfor_t _ta_t _tSpeciesReference_t_t _tstructure_t _tare_t: @_tli_t _tspecies_t @_tli_t _tconstant_t (_tin_t _tL3_t _tonly_t)

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tcheck_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tobject_t _thave_t _tbeen_t _tdefined_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_initDefaults()

void SpeciesReference_initDefaults ( SpeciesReference_t sr)

_tInitializes_t _tthe_t _tattributes_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tto_t _ttheir_t _tdefaults_t:

@_tli_t _tstoichiometry_t _tis_t _tset_t _tto_t @_tc_t _t1_t @_tli_t _tdenominator_t _tis_t _tset_t _tto_t @_tc_t _t1_t

_tThis_t _tfunction_t _thas_t _tno_t _teffect_t _tif_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tis_t _ta_t _tmodifer_t (_tsee_t _tSpeciesReference_isModifier_t()).

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_isModifier()

int SpeciesReference_isModifier ( const SpeciesReference_t sr)

_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 _tSpeciesReference_t_t _tstructure_t _tis_t _ta_t _tmodifier_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tSpeciesReference_t_t _trepresents_t _ta_t _tmodifier_t _tspecies_t, @_tc_t _t0_t (_tfalse_t)_tif_t _tit_t _tis_t _ta_t _tplain_t _tSpeciesReference_t_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_isSetConstant()

int SpeciesReference_isSetConstant ( const SpeciesReference_t sr)

_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 "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_isSetId()

int SpeciesReference_isSetId ( const SpeciesReference_t sr)

_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 "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

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

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_isSetName()

int SpeciesReference_isSetName ( const SpeciesReference_t sr)

_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 "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

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

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_isSetSpecies()

int SpeciesReference_isSetSpecies ( const SpeciesReference_t sr)

_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 "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_isSetStoichiometry()

int SpeciesReference_isSetStoichiometry ( const SpeciesReference_t sr)

_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 "_tstoichiometry_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tstoichiometry_t" _tattribute_t _tof_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_isSetStoichiometryMath()

int SpeciesReference_isSetStoichiometryMath ( const SpeciesReference_t sr)

_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 "_tstoichiometryMath_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t _tis_t _tnon_t-_tempty_t.

_tThis_t _tfunction_t _treturns_t _tfalse_t _tif_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tis_t _ta_t _tModifer_t (_tsee_t _tSpeciesReference_isModifier_t()).

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tstoichiometryMath_t" _tsubelement_t _thas_t _tcontent_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpeciesReference_t_t

Examples
printUnits.c.

◆ SpeciesReference_setConstant()

int SpeciesReference_setConstant ( SpeciesReference_t sr,
int  value 
)

_tAssign_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _ta_t _tSpeciesReference_t_t _tstructure_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tvalue_t _tthe_t _tvalue_t _tto_t _tassign_t _tas_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tSpeciesReference_t_t, _teither_t @_tc_t _tzero_t _tfor_t _tfalse_t _tor_t @_tc_t _tnonzero_t _tfor_t _ttrue_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 _tSpeciesReference_t_t

Examples
spec_example1.c.

◆ SpeciesReference_setDenominator()

int SpeciesReference_setDenominator ( SpeciesReference_t sr,
int  value 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tdenominator_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

_tThe_t "_tdenominator_t" _tattribute_t _tis_t _tonly_t _tactually_t _twritten_t _tout_t _tin_t _tthe_t _tcase_t _tof_t _tan_t _tSBML_t _tLevel_t _t1_t _tmodel_t. _tIn_t _tSBML_t _tLevel_t _t2_t, _trational_t-_tnumber_t _tstoichiometries_t _tare_t _twritten_t _tas_t _tMathML_t _telements_t _tin_t _tthe_t "_tstoichiometryMath_t" _tsubelement_t. _tHowever_t, _tas_t _ta_t _tconvenience_t _tto_t _tusers_t, _tlibSBML_t _tallows_t _tthe_t _tcreation_t _tand_t _tmanipulation_t _tof_t _trational_t-_tnumber_t _tstoichiometries_t _tby_t _tsupplying_t _tthe_t _tnumerator_t _tand_t _tdenominator_t _tdirectly_t _trather_t _tthan_t _thaving_t _tto_t _tmanually_t _tcreate_t _tan_t _tASTNode_t_t _tstructure_t. _tLibSBML_t _twill_t _twrite_t _tout_t _tthe_t _tappropriate_t _tconstructs_t (_teither_t _ta_t _tcombination_t _tof_t "_tstoichiometry_t" _tand_t "_tdenominator_t" _tin_t _tthe_t _tcase_t _tof_t _tSBML_t _tLevel_t _t1_t, _tor_t _ta_t "_tstoichiometryMath_t" _tsubelement_t _tin_t _tthe_t _tcase_t _tof_t _tSBML_t _tLevel_t _t2_t). _tHowever_t, _tas_t _tthe_t "_tstoichiometryMath_t" _tsubelement_t _twas_t _tremoved_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t, _tautomatic_t _ttranslation_t _tof_t _tthe_t "_tdenominator_t" _tattribute_t _tis_t _tno_t _tlonger_t _tsupported_t _tfor_t _tthat_t _tlevel_t.

_tThis_t _tfunction_t _thas_t _tno_t _teffect_t _tif_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tis_t _ta_t _tModifer_t (_tsee_t _tSpeciesReference_isModifier_t()).

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tvalue_t _tthe_t _tvalue_t _tto_t _tassign_t _tto_t _tthe_t "_tdenominator_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_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_setId()

int SpeciesReference_setId ( SpeciesReference_t sr,
const char *  sid 
)

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

_tThe_t _tstring_t _tin_t @_tp_t _tsid_t _twill_t _tbe_t _tcopied_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tsid_t _tthe_t _tidentifier_t _tstring_t _tthat_t _twill_t _tbe_t _tcopied_t _tand_t _tassigned_t _tas_t _tthe_t "_tid_t" _tattribute_t _tvalue_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 _tan_t @_tp_t _tsid_t _tof_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tid_t" _tattribute_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_setName()

int SpeciesReference_setName ( SpeciesReference_t sr,
const char *  name 
)

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

_tThe_t _tstring_t _tin_t @_tp_t _tsid_t _twill_t _tbe_t _tcopied_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tname_t _tthe_t _tidentifier_t _tstring_t _tthat_t _twill_t _tbe_t _tcopied_t _tand_t _tassigned_t _tas_t _tthe_t "_tname_t" _tattribute_t _tvalue_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 _tSpeciesReference_t_t

◆ SpeciesReference_setSpecies()

int SpeciesReference_setSpecies ( SpeciesReference_t sr,
const char *  sid 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

_tThe_t _tstring_t _tin_t @_tp_t _tsid_t _twill_t _tbe_t _tcopied_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tsid_t _tthe_t _tidentifier_t _tstring_t _tthat_t _twill_t _tbe_t _tcopied_t _tand_t _tassigned_t _tas_t _tthe_t "_tspecies_t" _tattribute_t _tvalue_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}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _tan_t @_tp_t _tsid_t _tof_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tspecies_t" _tattribute_t.

@_tmemberof_t _tSpeciesReference_t_t

Examples
createExampleSBML.c, and spec_example1.c.

◆ SpeciesReference_setStoichiometry()

int SpeciesReference_setStoichiometry ( SpeciesReference_t sr,
double  value 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tstoichiometry_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

_tThis_t _tfunction_t _thas_t _tno_t _teffect_t _tif_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tis_t _ta_t _tModifer_t (_tsee_t _tSpeciesReference_isModifier_t()).

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tvalue_t _tthe_t _tvalue_t _tto_t _tassign_t _tto_t _tthe_t "_tstoichiometry_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_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSpeciesReference_t_t

Examples
spec_example1.c.

◆ SpeciesReference_setStoichiometryMath()

int SpeciesReference_setStoichiometryMath ( SpeciesReference_t sr,
const StoichiometryMath_t math 
)

_tSets_t _tthe_t _tcontent_t _tof_t _tthe_t "_tstoichiometryMath_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

_tThis_t _tfunction_t _thas_t _tno_t _teffect_t _tif_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tis_t _ta_t _tModifer_t (_tsee_t _tSpeciesReference_isModifier_t()).

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tmath_t _tthe_t _tStoichiometryMath_t_t _tstructure_t _tto_t _tuse_t _tin_t _tthe_t _tgiven_t _tSpeciesReference_t_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t}

@_tnote_t _tThis_t _tfunction_t _thas_t _tno_t _teffect_t _ton_t _tSBML_t _tLevel_t _t1_t _tor_t _tLevel_t _t3_t _tSpeciesReference_t_t _telements_t, _tneither_t _tof_t _twhich_t _thave_t _tStoichiometryMath_t_t _tchildren_t.

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_unsetConstant()

int SpeciesReference_unsetConstant ( SpeciesReference_t sr)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_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_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_unsetId()

int SpeciesReference_unsetId ( SpeciesReference_t sr)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_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_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_unsetName()

int SpeciesReference_unsetName ( SpeciesReference_t sr)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_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_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_unsetSpecies()

int SpeciesReference_unsetSpecies ( SpeciesReference_t sr)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_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_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_unsetStoichiometry()

int SpeciesReference_unsetStoichiometry ( SpeciesReference_t sr)

_tUnsets_t _tthe_t _tcontent_t _tof_t _tthe_t "_tstoichiometry_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

_tThis_t _tfunction_t _thas_t _tno_t _teffect_t _tif_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tis_t _ta_t _tModifer_t (_tsee_t _tSpeciesReference_isModifier_t()).

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_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_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSpeciesReference_t_t

◆ SpeciesReference_unsetStoichiometryMath()

int SpeciesReference_unsetStoichiometryMath ( SpeciesReference_t sr)

_tUnsets_t _tthe_t _tcontent_t _tof_t _tthe_t "_tstoichiometryMath_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tSpeciesReference_t_t _tstructure_t.

_tThis_t _tfunction_t _thas_t _tno_t _teffect_t _tif_t _tthe_t _tSpeciesReference_t_t _tstructure_t _tis_t _ta_t _tModifer_t (_tsee_t _tSpeciesReference_isModifier_t()).

@_tparam_t _tsr_t _tthe_t _tSpeciesReference_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_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tnote_t _tThis_t _tfunction_t _thas_t _tno_t _teffect_t _ton_t _tSBML_t _tLevel_t _t1_t _tor_t _tLevel_t _t3_t _tSpeciesReference_t_t _telements_t, _tneither_t _tof_t _twhich_t _thave_t _tStoichiometryMath_t_t _tchildren_t.

@_tmemberof_t _tSpeciesReference_t_t