libSBML C API
libSBML 5.20.4 C API
|
Implementations of Reaction_t and ListOfReactions_t. More...
Functions | |
Reaction_t * | ListOfReactions_getById (ListOf_t *lo, const char *sid) |
_tReturns_t _tthe_t _tReaction_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t. | |
Reaction_t * | ListOfReactions_removeById (ListOf_t *lo, const char *sid) |
_tRemoves_t _ta_t _tReaction_t_t _tstructure_t _tbased_t _ton_t _tits_t _tidentifier_t. | |
int | Reaction_addModifier (Reaction_t *r, const SpeciesReference_t *msr) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tmodifier_t (_tmodifier_t _tSpeciesReference_t_t) _tto_t _tthis_t _tReaction_t_t. | |
int | Reaction_addModifierBySpecies (Reaction_t *r, const Species_t *s, const char *id) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tobject_t _tas_t _ta_t _tmodifier_t _tto_t _tthis_t _tReaction_t_t. | |
int | Reaction_addProduct (Reaction_t *r, const SpeciesReference_t *sr) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tproduct_t (_tSpeciesReference_t_t) _tto_t _tthis_t _tReaction_t_t. | |
int | Reaction_addProductBySpecies (Reaction_t *r, const Species_t *s, double stoichiometry, const char *id, int constant) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tobject_t _tas_t _ta_t _tproduct_t _tto_t _tthis_t _tReaction_t_t. | |
int | Reaction_addReactant (Reaction_t *r, const SpeciesReference_t *sr) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _treactant_t (_tSpeciesReference_t_t) _tto_t _tthis_t _tReaction_t_t. | |
int | Reaction_addReactantBySpecies (Reaction_t *r, const Species_t *s, double stoichiometry, const char *id, int constant) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tobject_t _tas_t _ta_t _treactant_t _tto_t _tthis_t _tReaction_t_t. | |
Reaction_t * | Reaction_clone (const Reaction_t *r) |
@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tReaction_t_t. | |
Reaction_t * | Reaction_create (unsigned int level, unsigned int version) |
@_tendcond_t | |
KineticLaw_t * | Reaction_createKineticLaw (Reaction_t *r) |
_tCreates_t _ta_t _tnew_t _tKineticLaw_t_t _tfor_t _tthis_t _tReaction_t_t _tand_t _treturns_t _tit_t. | |
SpeciesReference_t * | Reaction_createModifier (Reaction_t *r) |
_tCreates_t _ta_t _tnew_t _tSpeciesReference_t, _tadds_t _tit_t _tto_t _tthis_t _tReaction_t_t'_ts_t _tlist_t _tof_t _tmodifiers_t _tand_t _treturns_t _tit_t. | |
SpeciesReference_t * | Reaction_createProduct (Reaction_t *r) |
_tCreates_t _ta_t _tnew_t _tSpeciesReference_t, _tadds_t _tit_t _tto_t _tthis_t _tReaction_t_t'_ts_t _tlist_t _tof_t _tproducts_t _tand_t _treturns_t _tit_t. | |
SpeciesReference_t * | Reaction_createReactant (Reaction_t *r) |
_tCreates_t _ta_t _tnew_t _tSpeciesReference_t, _tadds_t _tit_t _tto_t _tthis_t _tReaction_t_t'_ts_t _tlist_t _tof_t _treactants_t _tand_t _treturns_t _tit_t. | |
Reaction_t * | Reaction_createWithNS (SBMLNamespaces_t *sbmlns) |
_tCreates_t _ta_t _tnew_t _tReaction_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t. | |
void | Reaction_free (Reaction_t *r) |
_tFrees_t _tthe_t _tgiven_t _tReaction_t_t. | |
const char * | Reaction_getCompartment (const Reaction_t *r) |
@_treturn_t _tthe_t _tcompartment_t _tof_t _tthis_t _tReaction_t_t. | |
int | Reaction_getFast (const Reaction_t *r) |
@_treturn_t _tthe_t _tfast_t _tstatus_t _tof_t _tthis_t _tReaction_t_t. | |
const char * | Reaction_getId (const Reaction_t *r) |
@_treturn_t _tthe_t _tid_t _tof_t _tthis_t _tReaction_t_t. | |
KineticLaw_t * | Reaction_getKineticLaw (Reaction_t *r) |
@_treturn_t _tthe_t _tKineticLaw_t_t _tof_t _tthis_t _tReaction_t_t. | |
ListOf_t * | Reaction_getListOfModifiers (Reaction_t *r) |
@_treturn_t _tthe_t _tlist_t _tof_t _tModifiers_t _tfor_t _tthis_t _tReaction_t_t. | |
ListOf_t * | Reaction_getListOfProducts (Reaction_t *r) |
@_treturn_t _tthe_t _tlist_t _tof_t _tProducts_t _tfor_t _tthis_t _tReaction_t_t. | |
ListOf_t * | Reaction_getListOfReactants (Reaction_t *r) |
@_treturn_t _tthe_t _tlist_t _tof_t _tReactants_t _tfor_t _tthis_t _tReaction_t_t. | |
SpeciesReference_t * | Reaction_getModifier (Reaction_t *r, unsigned int n) |
@_treturn_t _tthe_t _tnth_t _tmodifier_t (_tmodifier_t _tSpeciesReference_t_t) _tof_t _tthis_t _tReaction_t_t. | |
SpeciesReference_t * | Reaction_getModifierBySpecies (Reaction_t *r, const char *species) |
@_treturn_t _tthe_t _tmodifier_t (_tmodifier_t _tSpeciesReference_t_t) _tin_t _tthis_t _tReaction_t_t _twith_t _tthe_t _tgiven_t _tspecies_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tmodifier_t _texists_t. | |
const char * | Reaction_getName (const Reaction_t *r) |
@_treturn_t _tthe_t _tname_t _tof_t _tthis_t _tReaction_t_t. | |
const XMLNamespaces_t * | Reaction_getNamespaces (Reaction_t *r) |
_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tReaction_t_t _tstructure_t. | |
unsigned int | Reaction_getNumModifiers (const Reaction_t *r) |
@_treturn_t _tthe_t _tnumber_t _tof_t _tmodifiers_t (_tmodifier_t _tSpeciesReference_t_t'_ts_t) _tin_t _tthis_t _tReaction_t_t. | |
unsigned int | Reaction_getNumProducts (const Reaction_t *r) |
@_treturn_t _tthe_t _tnumber_t _tof_t _tproducts_t (_tSpeciesReference_t_t'_ts_t) _tin_t _tthis_t _tReaction_t_t. | |
unsigned int | Reaction_getNumReactants (const Reaction_t *r) |
@_treturn_t _tthe_t _tnumber_t _tof_t _treactants_t (_tSpeciesReference_t_t'_ts_t) _tin_t _tthis_t _tReaction_t_t. | |
SpeciesReference_t * | Reaction_getProduct (Reaction_t *r, unsigned int n) |
@_treturn_t _tthe_t _tnth_t _tproduct_t (_tSpeciesReference_t_t) _tof_t _tthis_t _tReaction_t_t. | |
SpeciesReference_t * | Reaction_getProductBySpecies (Reaction_t *r, const char *species) |
@_treturn_t _tthe_t _tproduct_t (_tSpeciesReference_t_t) _tin_t _tthis_t _tReaction_t_t _twith_t _tthe_t _tgiven_t _tspecies_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tproduct_t _texists_t. | |
SpeciesReference_t * | Reaction_getReactant (Reaction_t *r, unsigned int n) |
@_treturn_t _tthe_t _tnth_t _treactant_t (_tSpeciesReference_t_t) _tof_t _tthis_t _tReaction_t_t. | |
SpeciesReference_t * | Reaction_getReactantBySpecies (Reaction_t *r, const char *species) |
@_treturn_t _tthe_t _treactant_t (_tSpeciesReference_t_t) _tin_t _tthis_t _tReaction_t_t _twith_t _tthe_t _tgiven_t _tspecies_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _treactant_t _texists_t. | |
int | Reaction_getReversible (const Reaction_t *r) |
@_treturn_t _tthe_t _treversible_t _tstatus_t _tof_t _tthis_t _tReaction_t_t. | |
int | Reaction_hasRequiredAttributes (Reaction_t *r) |
_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 _tReaction_t_t _tstructure_t _thave_t _tbeen_t _tset_t. | |
void | Reaction_initDefaults (Reaction_t *r) |
_tInitializes_t _tthe_t _tfields_t _tof_t _tthis_t _tReaction_t_t _tto_t _ttheir_t _tdefaults_t: | |
int | Reaction_isSetCompartment (const Reaction_t *r) |
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tKineticLaw_t_t _tof_t _tthis_t _tReaction_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t. | |
int | Reaction_isSetFast (const Reaction_t *r) |
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tfast_t _tstatus_t _tof_t _tthis_t _tReaction_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t. | |
int | Reaction_isSetId (const Reaction_t *r) |
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tid_t _tof_t _tthis_t _tReaction_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t. | |
int | Reaction_isSetKineticLaw (const Reaction_t *r) |
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tKineticLaw_t_t _tof_t _tthis_t _tReaction_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t. | |
int | Reaction_isSetName (const Reaction_t *r) |
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tname_t _tof_t _tthis_t _tReaction_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t. | |
int | Reaction_isSetReversible (const Reaction_t *r) |
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _treversible_t _tattribute_t _tof_t _tthis_t _tReaction_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t. | |
SpeciesReference_t * | Reaction_removeModifier (Reaction_t *r, unsigned int n) |
_tRemoves_t _tthe_t _tnth_t _tmodifier_t _tSpeciesReference_t_t _tstructure_t _tfrom_t _tthis_t _tReaction_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t. | |
SpeciesReference_t * | Reaction_removeModifierBySpecies (Reaction_t *r, const char *species) |
_tRemoves_t _tthe_t _tmodifier_t _tSpeciesReference_t_t _tstructure_t _twith_t _tthe_t _tgiven_t "_tspecies_t" _tattribute_t _tfrom_t _tthis_t _tReaction_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t. | |
SpeciesReference_t * | Reaction_removeProduct (Reaction_t *r, unsigned int n) |
_tRemoves_t _tthe_t _tnth_t _tproduct_t _tSpeciesReference_t_t _tstructure_t _tfrom_t _tthis_t _tReaction_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t. | |
SpeciesReference_t * | Reaction_removeProductBySpecies (Reaction_t *r, const char *species) |
_tRemoves_t _tthe_t _tproduct_t _tSpeciesReference_t_t _tstructure_t _twith_t _tthe_t _tgiven_t "_tspecies_t" _tattribute_t _tfrom_t _tthis_t _tReaction_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t. | |
SpeciesReference_t * | Reaction_removeReactant (Reaction_t *r, unsigned int n) |
_tRemoves_t _tthe_t _tnth_t _treactant_t _tSpeciesReference_t_t _tstructure_t _tfrom_t _tthis_t _tReaction_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t. | |
SpeciesReference_t * | Reaction_removeReactantBySpecies (Reaction_t *r, const char *species) |
_tRemoves_t _tthe_t _treactant_t _tSpeciesReference_t_t _tstructure_t _twith_t _tthe_t _tgiven_t "_tspecies_t" _tattribute_t _tfrom_t _tthis_t _tReaction_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t. | |
int | Reaction_setCompartment (Reaction_t *r, const char *compartment) |
_tSets_t _tthe_t _tcompartment_t _tof_t _tthis_t _tReaction_t_t _tto_t _ta_t _tcopy_t _tof_t _tcompartment_t. | |
int | Reaction_setFast (Reaction_t *r, int value) |
_tSets_t _tthe_t _tfast_t _tstatus_t _tof_t _tthis_t _tReaction_t_t _tto_t _tvalue_t (_tboolean_t). | |
int | Reaction_setId (Reaction_t *r, const char *sid) |
_tSets_t _tthe_t _tid_t _tof_t _tthis_t _tReaction_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tsid_t. | |
int | Reaction_setKineticLaw (Reaction_t *r, const KineticLaw_t *kl) |
_tSets_t _tthe_t _tKineticLaw_t_t _tof_t _tthis_t _tReaction_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t. | |
int | Reaction_setName (Reaction_t *r, const char *name) |
_tSets_t _tthe_t _tname_t _tof_t _tthis_t _tReaction_t_t _tto_t _ta_t _tcopy_t _tof_t _tname_t. | |
int | Reaction_setReversible (Reaction_t *r, int value) |
_tSets_t _tthe_t _treversible_t _tstatus_t _tof_t _tthis_t _tReaction_t_t _tto_t _tvalue_t (_tboolean_t). | |
int | Reaction_unsetCompartment (Reaction_t *r) |
_tUnsets_t _tthe_t _tcompartment_t _tof_t _tthis_t _tReaction_t_t. | |
int | Reaction_unsetFast (Reaction_t *r) |
_tUnsets_t _tthe_t _tfast_t _tstatus_t _tof_t _tthis_t _tReation_t_t. | |
int | Reaction_unsetKineticLaw (Reaction_t *r) |
_tUnsets_t _tthe_t _tKineticLaw_t_t _tof_t _tthis_t _tReaction_t_t. | |
int | Reaction_unsetName (Reaction_t *r) |
_tUnsets_t _tthe_t _tname_t _tof_t _tthis_t _tReaction_t_t. | |
int | Reaction_unsetReversible (Reaction_t *r) |
_tUnsets_t _tthe_t _treversible_t _tstatus_t _tof_t _tthis_t _tReaction_t_t. | |
Implementations of Reaction_t and ListOfReactions_t.
Reaction_t * ListOfReactions_getById | ( | ListOf_t * | lo, |
const char * | sid | ||
) |
_tReturns_t _tthe_t _tReaction_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.
@_tparam_t _tlo_t _tthe_t _tListOfReactions_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 _tListOfReactions_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 _tListOfReactions_t_t
Reaction_t * ListOfReactions_removeById | ( | ListOf_t * | lo, |
const char * | sid | ||
) |
_tRemoves_t _ta_t _tReaction_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 _tReaction_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 _tReaction_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 _tListOfReactions_t_t
int Reaction_addModifier | ( | Reaction_t * | r, |
const SpeciesReference_t * | msr | ||
) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tmodifier_t (_tmodifier_t _tSpeciesReference_t_t) _tto_t _tthis_t _tReaction_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}
@_tmemberof_t _tReaction_t_t
int Reaction_addModifierBySpecies | ( | Reaction_t * | r, |
const Species_t * | s, | ||
const char * | id | ||
) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tobject_t _tas_t _ta_t _tmodifier_t _tto_t _tthis_t _tReaction_t_t.
@_tparam_t _tr_t _tthe_t _tReaction_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tmodifier_t _tis_t _tadded_t. @_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _tto_t _tbe_t _tadded_t _tas_t _tmodifier_t. @_tparam_t _tid_t _tthe_t _tstring_t _tto_t _tbe_t _tused_t _tas_t _tthe_t _tid_t _tof_t _tthe_t _tSpeciesReference_t_t _tthat_t _twill_t _tbe_t _tcreated_t.
@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}
@_tnote_t _tthe_t _tSpecies_t_t _tstructure_t _titself_t _tis_t _tNOT_t _tadded_t _tto_t _tthe_t _tmodel_t
@_tmemberof_t _tReaction_t_t
int Reaction_addProduct | ( | Reaction_t * | r, |
const SpeciesReference_t * | sr | ||
) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tproduct_t (_tSpeciesReference_t_t) _tto_t _tthis_t _tReaction_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_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}
@_tmemberof_t _tReaction_t_t
int Reaction_addProductBySpecies | ( | Reaction_t * | r, |
const Species_t * | s, | ||
double | stoichiometry, | ||
const char * | id, | ||
int | constant | ||
) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tobject_t _tas_t _ta_t _tproduct_t _tto_t _tthis_t _tReaction_t_t.
@_tparam_t _tr_t _tthe_t _tReaction_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tproduct_t _tis_t _tadded_t. @_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _tto_t _tbe_t _tadded_t _tas_t _tproduct_t. @_tparam_t _tstoichiometry_t _tthe_t _tstoichiometry_t _tof_t _tthe_t _tadded_t _tproduct_t. @_tparam_t _tid_t _tthe_t _tstring_t _tto_t _tbe_t _tused_t _tas_t _tthe_t _tid_t _tof_t _tthe_t _tSpeciesReference_t_t _tthat_t _twill_t _tbe_t _tcreated_t. @_tparam_t _tconstant_t _tan_t _tattribute_t _tspecifying_t _twhether_t _tthe_t _tSpeciesReference_t_t _tis_t _tconstant_t _tor_t _tnot_t.
@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}
@_tnote_t _tthe_t _tSpecies_t_t _tstructure_t _titself_t _tis_t _tNOT_t _tadded_t _tto_t _tthe_t _tmodel_t
@_tmemberof_t _tReaction_t_t
int Reaction_addReactant | ( | Reaction_t * | r, |
const SpeciesReference_t * | sr | ||
) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _treactant_t (_tSpeciesReference_t_t) _tto_t _tthis_t _tReaction_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_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}
@_tmemberof_t _tReaction_t_t
int Reaction_addReactantBySpecies | ( | Reaction_t * | r, |
const Species_t * | s, | ||
double | stoichiometry, | ||
const char * | id, | ||
int | constant | ||
) |
_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tobject_t _tas_t _ta_t _treactant_t _tto_t _tthis_t _tReaction_t_t.
@_tparam_t _tr_t _tthe_t _tReaction_t_t _tstructure_t _tto_t _twhich_t _tthe_t _treactant_t _tis_t _tadded_t. @_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _tto_t _tbe_t _tadded_t _tas_t _treactant_t. @_tparam_t _tstoichiometry_t _tthe_t _tstoichiometry_t _tof_t _tthe_t _tadded_t _treactant_t. @_tparam_t _tid_t _tthe_t _tstring_t _tto_t _tbe_t _tused_t _tas_t _tthe_t _tid_t _tof_t _tthe_t _tSpeciesReference_t_t _tthat_t _twill_t _tbe_t _tcreated_t. @_tparam_t _tconstant_t _tan_t _tattribute_t _tspecifying_t _twhether_t _tthe_t _tcreated_t _tSpeciesReference_t_t _tis_t _tconstant_t _tor_t _tnot_t.
@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}
@_tnote_t _tthe_t _tSpecies_t_t _tstructure_t _titself_t _tis_t _tNOT_t _tadded_t _tto_t _tthe_t _tmodel_t
@_tmemberof_t _tReaction_t_t
Reaction_t * Reaction_clone | ( | const Reaction_t * | r | ) |
@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
Reaction_t * Reaction_create | ( | unsigned int | level, |
unsigned int | version | ||
) |
@_tendcond_t
@_tclass_t _tdoc_warning_reaction_cant_ignore_fast_t
@_tcond_t _tdoxygenIgnored_t
KineticLaw_t * Reaction_createKineticLaw | ( | Reaction_t * | r | ) |
_tCreates_t _ta_t _tnew_t _tKineticLaw_t_t _tfor_t _tthis_t _tReaction_t_t _tand_t _treturns_t _tit_t.
_tIf_t _tthis_t _tReaction_t_t _thad_t _ta_t _tprevious_t _tKineticLaw_t_t, _tit_t _twill_t _tbe_t _tdestroyed_t.
@_tmemberof_t _tReaction_t_t
SpeciesReference_t * Reaction_createModifier | ( | Reaction_t * | r | ) |
_tCreates_t _ta_t _tnew_t _tSpeciesReference_t, _tadds_t _tit_t _tto_t _tthis_t _tReaction_t_t'_ts_t _tlist_t _tof_t _tmodifiers_t _tand_t _treturns_t _tit_t.
@_tmemberof_t _tReaction_t_t
SpeciesReference_t * Reaction_createProduct | ( | Reaction_t * | r | ) |
_tCreates_t _ta_t _tnew_t _tSpeciesReference_t, _tadds_t _tit_t _tto_t _tthis_t _tReaction_t_t'_ts_t _tlist_t _tof_t _tproducts_t _tand_t _treturns_t _tit_t.
@_tmemberof_t _tReaction_t_t
SpeciesReference_t * Reaction_createReactant | ( | Reaction_t * | r | ) |
_tCreates_t _ta_t _tnew_t _tSpeciesReference_t, _tadds_t _tit_t _tto_t _tthis_t _tReaction_t_t'_ts_t _tlist_t _tof_t _treactants_t _tand_t _treturns_t _tit_t.
@_tmemberof_t _tReaction_t_t
Reaction_t * Reaction_createWithNS | ( | SBMLNamespaces_t * | sbmlns | ) |
_tCreates_t _ta_t _tnew_t _tReaction_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 _tReaction_t_t.
@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tReaction_t_t _tstructure_t.
@_tcopydetails_t _tdoc_note_setting_lv_t
@_tmemberof_t _tReaction_t_t
void Reaction_free | ( | Reaction_t * | r | ) |
_tFrees_t _tthe_t _tgiven_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
const char * Reaction_getCompartment | ( | const Reaction_t * | r | ) |
@_treturn_t _tthe_t _tcompartment_t _tof_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
int Reaction_getFast | ( | const Reaction_t * | r | ) |
@_treturn_t _tthe_t _tfast_t _tstatus_t _tof_t _tthis_t _tReaction_t_t.
@_tcopydetails_t _tdoc_fast_attribute_removed_t
@_tmemberof_t _tReaction_t_t
const char * Reaction_getId | ( | const Reaction_t * | r | ) |
@_treturn_t _tthe_t _tid_t _tof_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
KineticLaw_t * Reaction_getKineticLaw | ( | Reaction_t * | r | ) |
@_treturn_t _tthe_t _tKineticLaw_t_t _tof_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
ListOf_t * Reaction_getListOfModifiers | ( | Reaction_t * | r | ) |
@_treturn_t _tthe_t _tlist_t _tof_t _tModifiers_t _tfor_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
ListOf_t * Reaction_getListOfProducts | ( | Reaction_t * | r | ) |
@_treturn_t _tthe_t _tlist_t _tof_t _tProducts_t _tfor_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
ListOf_t * Reaction_getListOfReactants | ( | Reaction_t * | r | ) |
@_treturn_t _tthe_t _tlist_t _tof_t _tReactants_t _tfor_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
SpeciesReference_t * Reaction_getModifier | ( | Reaction_t * | r, |
unsigned int | n | ||
) |
@_treturn_t _tthe_t _tnth_t _tmodifier_t (_tmodifier_t _tSpeciesReference_t_t) _tof_t _tthis_t _tReaction_t_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 _tReaction_t_t
SpeciesReference_t * Reaction_getModifierBySpecies | ( | Reaction_t * | r, |
const char * | species | ||
) |
@_treturn_t _tthe_t _tmodifier_t (_tmodifier_t _tSpeciesReference_t_t) _tin_t _tthis_t _tReaction_t_t _twith_t _tthe_t _tgiven_t _tspecies_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tmodifier_t _texists_t.
@_tmemberof_t _tReaction_t_t
const char * Reaction_getName | ( | const Reaction_t * | r | ) |
@_treturn_t _tthe_t _tname_t _tof_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
const XMLNamespaces_t * Reaction_getNamespaces | ( | Reaction_t * | r | ) |
_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tReaction_t_t _tstructure_t.
@_tparam_t _tr_t _tthe_t _tReaction_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 _tReaction_t_t
unsigned int Reaction_getNumModifiers | ( | const Reaction_t * | r | ) |
@_treturn_t _tthe_t _tnumber_t _tof_t _tmodifiers_t (_tmodifier_t _tSpeciesReference_t_t'_ts_t) _tin_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
unsigned int Reaction_getNumProducts | ( | const Reaction_t * | r | ) |
@_treturn_t _tthe_t _tnumber_t _tof_t _tproducts_t (_tSpeciesReference_t_t'_ts_t) _tin_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
unsigned int Reaction_getNumReactants | ( | const Reaction_t * | r | ) |
@_treturn_t _tthe_t _tnumber_t _tof_t _treactants_t (_tSpeciesReference_t_t'_ts_t) _tin_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
SpeciesReference_t * Reaction_getProduct | ( | Reaction_t * | r, |
unsigned int | n | ||
) |
@_treturn_t _tthe_t _tnth_t _tproduct_t (_tSpeciesReference_t_t) _tof_t _tthis_t _tReaction_t_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 _tReaction_t_t
SpeciesReference_t * Reaction_getProductBySpecies | ( | Reaction_t * | r, |
const char * | species | ||
) |
@_treturn_t _tthe_t _tproduct_t (_tSpeciesReference_t_t) _tin_t _tthis_t _tReaction_t_t _twith_t _tthe_t _tgiven_t _tspecies_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tproduct_t _texists_t.
@_tmemberof_t _tReaction_t_t
SpeciesReference_t * Reaction_getReactant | ( | Reaction_t * | r, |
unsigned int | n | ||
) |
@_treturn_t _tthe_t _tnth_t _treactant_t (_tSpeciesReference_t_t) _tof_t _tthis_t _tReaction_t_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 _tReaction_t_t
SpeciesReference_t * Reaction_getReactantBySpecies | ( | Reaction_t * | r, |
const char * | species | ||
) |
@_treturn_t _tthe_t _treactant_t (_tSpeciesReference_t_t) _tin_t _tthis_t _tReaction_t_t _twith_t _tthe_t _tgiven_t _tspecies_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _treactant_t _texists_t.
@_tmemberof_t _tReaction_t_t
int Reaction_getReversible | ( | const Reaction_t * | r | ) |
@_treturn_t _tthe_t _treversible_t _tstatus_t _tof_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
int Reaction_hasRequiredAttributes | ( | Reaction_t * | r | ) |
_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 _tReaction_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
_tThe_t _trequired_t _tattributes_t _tfor_t _ta_t _tReaction_t_t _tstructure_t _tare_t: @_tli_t "_tid_t" (_tor_t "_tname_t" _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t) @_tli_t "_tfast_t" (_tin_t _tLevel_t&_tnbsp_t;_t3_t _tVersion_t&_tnbsp_t;_t1_t _tonly_t, _twhere_t _tit_t _tis_t _tdefined_t _tas_t _ta_t _trequired_t _tattribute_t) @_tli_t "_treversible_t" (_tin_t _tLevel_t&_tnbsp_t;_t3_t _tonly_t, _twhere_t _tit_t _tis_t _tdefined_t _tas_t _ta_t _trequired_t _tattribute_t)
@_tparam_t _tr_t _tthe_t _tReaction_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 _tstructure_t _thave_t _tbeen_t _tdefined_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tReaction_t_t
void Reaction_initDefaults | ( | Reaction_t * | r | ) |
_tInitializes_t _tthe_t _tfields_t _tof_t _tthis_t _tReaction_t_t _tto_t _ttheir_t _tdefaults_t:
_tThe_t _tSBML_t _tReaction_t _tcomponent_t _thas_t _tslightly_t _tdifferent_t _taspects_t _tand_t _tdefault_t _tattribute_t _tvalues_t _tin_t _tdifferent_t _tSBML_t _tLevels_t _tand_t _tVersions_t. _tThis_t _tmethod_t _tsets_t _tthe_t _tvalues_t _tto_t _tcertain_t _tcommon_t _tdefaults_t, _tbased_t _tmostly_t _ton_t _twhat_t _tthey_t _tare_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t. _tSpecifically_t:
@_tli_t _tSets_t _tthe_t "_treversible_t" _tattribute_t _tto_t @_tc_t _ttrue_t @_tli_t _tSets_t _tthe_t "_tfast_t" _tattribute_t _tto_t @_tc_t _tfalse_t @_tli_t _tMarks_t _tthe_t "_tfast_t" _tattribute_t _tas_t @_tem_t _tnot_t _thaving_t _tbeen_t _tset_t _tfor_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t, _tbut_t @_tem_t _tas_t _thaving_t _tbeen_t _tset_t _tfor_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t _tand_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t.
@_tcopydetails_t _tdoc_warning_reaction_cant_ignore_fast_t
@_tmemberof_t _tReaction_t_t
int Reaction_isSetCompartment | ( | const Reaction_t * | r | ) |
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tKineticLaw_t_t _tof_t _tthis_t _tReaction_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tReaction_t_t
int Reaction_isSetFast | ( | const Reaction_t * | r | ) |
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tfast_t _tstatus_t _tof_t _tthis_t _tReaction_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
_tIn_t _tL1_t, _tfast_t _tis_t _toptional_t _twith_t _ta_t _tdefault_t _tof_t _tfalse_t, _twhich_t _tmeans_t _tit_t _tis_t _teffectively_t _talways_t _tset_t. _tIn_t _tL2_t, _thowever_t, _tfast_t _tis_t _toptional_t _twith_t _tno_t _tdefault_t _tvalue_t, _tso_t _tit_t _tmay_t _tor_t _tmay_t _tnot_t _tbe_t _tset_t _tto_t _ta_t _tspecific_t _tvalue_t.
@_tcopydetails_t _tdoc_fast_attribute_removed_t
@_tmemberof_t _tReaction_t_t
int Reaction_isSetId | ( | const Reaction_t * | r | ) |
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tid_t _tof_t _tthis_t _tReaction_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tReaction_t_t
int Reaction_isSetKineticLaw | ( | const Reaction_t * | r | ) |
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tKineticLaw_t_t _tof_t _tthis_t _tReaction_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tReaction_t_t
int Reaction_isSetName | ( | const Reaction_t * | r | ) |
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tname_t _tof_t _tthis_t _tReaction_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tReaction_t_t
int Reaction_isSetReversible | ( | const Reaction_t * | r | ) |
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _treversible_t _tattribute_t _tof_t _tthis_t _tReaction_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tReaction_t_t
SpeciesReference_t * Reaction_removeModifier | ( | Reaction_t * | r, |
unsigned int | n | ||
) |
_tRemoves_t _tthe_t _tnth_t _tmodifier_t _tSpeciesReference_t_t _tstructure_t _tfrom_t _tthis_t _tReaction_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
_tThe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t _tand_t _tis_t _tresponsible_t _tfor_t _tdeleting_t _tit_t.
@_tparam_t _tr_t _tthe_t _tReaction_t_t _tstructure_t. @_tparam_t _tn_t _tthe_t _tinteger_t _tindex_t _tof_t _tthe_t _tmodifier_t _tSpeciesReference_t_t _tto_t _tremove_t.
@_treturn_t _tthe_t _tmodifier_t _tSpeciesReference_t_t _tstructure_t _tremoved_t. _tAs_t _tmentioned_t _tabove_t, _tthe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t. @_tc_t _tNULL_t _tis_t _treturned_t _tif_t _tthe_t _tgiven_t _tindex_t _tis_t _tout_t _tof_t _trange_t.
@_tmemberof_t _tReaction_t_t
SpeciesReference_t * Reaction_removeModifierBySpecies | ( | Reaction_t * | r, |
const char * | species | ||
) |
_tRemoves_t _tthe_t _tmodifier_t _tSpeciesReference_t_t _tstructure_t _twith_t _tthe_t _tgiven_t "_tspecies_t" _tattribute_t _tfrom_t _tthis_t _tReaction_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
_tThe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t _tand_t _tis_t _tresponsible_t _tfor_t _tdeleting_t _tit_t.
@_tparam_t _tr_t _tthe_t _tReaction_t_t _tstructure_t. @_tparam_t _tspecies_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tmodifier_t _tSpeciesReference_t_t _tto_t _tremove_t.
@_treturn_t _tthe_t _tmodifier_t _tSpeciesReference_t_t _tstructure_t _tremoved_t. _tAs_t _tmentioned_t _tabove_t, _tthe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t. @_tc_t _tNULL_t _tis_t _treturned_t _tif_t _tno_t _tmodifier_t _tSpeciesReference_t_t _tstructure_t _twith_t _tthe_t "_tspecies_t" _tattribute_t _texists_t _tin_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
SpeciesReference_t * Reaction_removeProduct | ( | Reaction_t * | r, |
unsigned int | n | ||
) |
_tRemoves_t _tthe_t _tnth_t _tproduct_t _tSpeciesReference_t_t _tstructure_t _tfrom_t _tthis_t _tReaction_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
_tThe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t _tand_t _tis_t _tresponsible_t _tfor_t _tdeleting_t _tit_t.
@_tparam_t _tr_t _tthe_t _tReaction_t_t _tstructure_t. @_tparam_t _tn_t _tthe_t _tinteger_t _tindex_t _tof_t _tthe_t _tproduct_t _tSpeciesReference_t_t _tto_t _tremove_t.
@_treturn_t _tthe_t _tproduct_t _tSpeciesReference_t_t _tstructure_t _tremoved_t. _tAs_t _tmentioned_t _tabove_t, _tthe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t. @_tc_t _tNULL_t _tis_t _treturned_t _tif_t _tthe_t _tgiven_t _tindex_t _tis_t _tout_t _tof_t _trange_t.
@_tmemberof_t _tReaction_t_t
SpeciesReference_t * Reaction_removeProductBySpecies | ( | Reaction_t * | r, |
const char * | species | ||
) |
_tRemoves_t _tthe_t _tproduct_t _tSpeciesReference_t_t _tstructure_t _twith_t _tthe_t _tgiven_t "_tspecies_t" _tattribute_t _tfrom_t _tthis_t _tReaction_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
_tThe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t _tand_t _tis_t _tresponsible_t _tfor_t _tdeleting_t _tit_t.
@_tparam_t _tr_t _tthe_t _tReaction_t_t _tstructure_t. @_tparam_t _tspecies_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _tproduct_t _tSpeciesReference_t_t _tto_t _tremove_t.
@_treturn_t _tthe_t _tproduct_t _tSpeciesReference_t_t _tstructure_t _tremoved_t. _tAs_t _tmentioned_t _tabove_t, _tthe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t. @_tc_t _tNULL_t _tis_t _treturned_t _tif_t _tno_t _tproduct_t _tSpeciesReference_t_t _tstructure_t _twith_t _tthe_t "_tspecies_t" _tattribute_t _texists_t _tin_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
SpeciesReference_t * Reaction_removeReactant | ( | Reaction_t * | r, |
unsigned int | n | ||
) |
_tRemoves_t _tthe_t _tnth_t _treactant_t _tSpeciesReference_t_t _tstructure_t _tfrom_t _tthis_t _tReaction_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
_tThe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t _tand_t _tis_t _tresponsible_t _tfor_t _tdeleting_t _tit_t.
@_tparam_t _tr_t _tthe_t _tReaction_t_t _tstructure_t. @_tparam_t _tn_t _tthe_t _tinteger_t _tindex_t _tof_t _tthe_t _treactant_t _tSpeciesReference_t_t _tto_t _tremove_t.
@_treturn_t _tthe_t _treactant_t _tSpeciesReference_t_t _tstructure_t _tremoved_t. _tAs_t _tmentioned_t _tabove_t, _tthe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t. @_tc_t _tNULL_t _tis_t _treturned_t _tif_t _tthe_t _tgiven_t _tindex_t _tis_t _tout_t _tof_t _trange_t.
@_tmemberof_t _tReaction_t_t
SpeciesReference_t * Reaction_removeReactantBySpecies | ( | Reaction_t * | r, |
const char * | species | ||
) |
_tRemoves_t _tthe_t _treactant_t _tSpeciesReference_t_t _tstructure_t _twith_t _tthe_t _tgiven_t "_tspecies_t" _tattribute_t _tfrom_t _tthis_t _tReaction_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
_tThe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t _tand_t _tis_t _tresponsible_t _tfor_t _tdeleting_t _tit_t.
@_tparam_t _tr_t _tthe_t _tReaction_t_t _tstructure_t. @_tparam_t _tspecies_t _tthe_t "_tspecies_t" _tattribute_t _tof_t _tthe_t _treactant_t _tSpeciesReference_t_t _tto_t _tremove_t.
@_treturn_t _tthe_t _treactant_t _tSpeciesReference_t_t _tstructure_t _tremoved_t. _tAs_t _tmentioned_t _tabove_t, _tthe_t _tcaller_t _towns_t _tthe_t _treturned_t _tstructure_t. @_tc_t _tNULL_t _tis_t _treturned_t _tif_t _tno_t _treactant_t _tSpeciesReference_t_t _tstructure_t _twith_t _tthe_t "_tspecies_t" _tattribute_t _texists_t _tin_t _tthis_t _tReaction_t_t.
@_tmemberof_t _tReaction_t_t
int Reaction_setCompartment | ( | Reaction_t * | r, |
const char * | compartment | ||
) |
_tSets_t _tthe_t _tcompartment_t _tof_t _tthis_t _tReaction_t_t _tto_t _ta_t _tcopy_t _tof_t _tcompartment_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_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t}
@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _tthe_t _tcompartment_t _tset_t _tto_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tcompartment_t" _tattribute_t.
@_tmemberof_t _tReaction_t_t
int Reaction_setFast | ( | Reaction_t * | r, |
int | value | ||
) |
_tSets_t _tthe_t _tfast_t _tstatus_t _tof_t _tthis_t _tReaction_t_t _tto_t _tvalue_t (_tboolean_t).
@_tcopydetails_t _tdoc_fast_attribute_removed_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 _tReaction_t_t
int Reaction_setId | ( | Reaction_t * | r, |
const char * | sid | ||
) |
_tSets_t _tthe_t _tid_t _tof_t _tthis_t _tReaction_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tsid_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 "_tid_t" _tattribute_t.
@_tmemberof_t _tReaction_t_t
int Reaction_setKineticLaw | ( | Reaction_t * | r, |
const KineticLaw_t * | kl | ||
) |
_tSets_t _tthe_t _tKineticLaw_t_t _tof_t _tthis_t _tReaction_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tKineticLaw_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_LEVEL_MISMATCH_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_VERSION_MISMATCH_t, _tOperationReturnValues_t_t}
@_tmemberof_t _tReaction_t_t
int Reaction_setName | ( | Reaction_t * | r, |
const char * | name | ||
) |
_tSets_t _tthe_t _tname_t _tof_t _tthis_t _tReaction_t_t _tto_t _ta_t _tcopy_t _tof_t _tname_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 _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 _tReaction_t_t
int Reaction_setReversible | ( | Reaction_t * | r, |
int | value | ||
) |
_tSets_t _tthe_t _treversible_t _tstatus_t _tof_t _tthis_t _tReaction_t_t _tto_t _tvalue_t (_tboolean_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 _tReaction_t_t
int Reaction_unsetCompartment | ( | Reaction_t * | r | ) |
_tUnsets_t _tthe_t _tcompartment_t _tof_t _tthis_t _tReaction_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_OPERATION_FAILED_t, _tOperationReturnValues_t_t}
@_tmemberof_t _tReaction_t_t
int Reaction_unsetFast | ( | Reaction_t * | r | ) |
_tUnsets_t _tthe_t _tfast_t _tstatus_t _tof_t _tthis_t _tReation_t_t.
@_tcopydetails_t _tdoc_fast_attribute_removed_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}
_tIn_t _tL1_t, _tfast_t _tis_t _toptional_t _twith_t _ta_t _tdefault_t _tof_t _tfalse_t, _twhich_t _tmeans_t _tit_t _tis_t _teffectively_t _talways_t _tset_t. _tIn_t _tL2_t, _thowever_t, _tfast_t _tis_t _toptional_t _twith_t _tno_t _tdefault_t _tvalue_t, _tso_t _tit_t _tmay_t _tor_t _tmay_t _tnot_t _tbe_t _tset_t _tto_t _ta_t _tspecific_t _tvalue_t.
@_tmemberof_t _tReaction_t_t
int Reaction_unsetKineticLaw | ( | Reaction_t * | r | ) |
_tUnsets_t _tthe_t _tKineticLaw_t_t _tof_t _tthis_t _tReaction_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_OPERATION_FAILED_t, _tOperationReturnValues_t_t}
@_tmemberof_t _tReaction_t_t
int Reaction_unsetName | ( | Reaction_t * | r | ) |
_tUnsets_t _tthe_t _tname_t _tof_t _tthis_t _tReaction_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_OPERATION_FAILED_t, _tOperationReturnValues_t_t}
@_tmemberof_t _tReaction_t_t
int Reaction_unsetReversible | ( | Reaction_t * | r | ) |
_tUnsets_t _tthe_t _treversible_t _tstatus_t _tof_t _tthis_t _tReaction_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_OPERATION_FAILED_t, _tOperationReturnValues_t_t}
@_tmemberof_t _tReaction_t_t