libSBML C API  libSBML 5.20.2 C API
Loading...
Searching...
No Matches
KineticLaw.h File Reference

Definition of KineticLaw_t. More...

Include dependency graph for KineticLaw.h:
This graph shows which files directly or indirectly include this file:

Functions

int KineticLaw_addLocalParameter (KineticLaw_t *kl, const LocalParameter_t *p)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tLocalParameter_t_t _tstructure_t _tto_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
int KineticLaw_addParameter (KineticLaw_t *kl, const Parameter_t *p)
 _tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tParameter_t_t _tstructure_t _tto_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
KineticLaw_tKineticLaw_clone (const KineticLaw_t *kl)
 _tReturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
int KineticLaw_containsUndeclaredUnits (KineticLaw_t *kl)
 _tPredicate_t _treturning_t @_tc_t _ttrue_t _tor_t @_tc_t _tfalse_t _tdepending_t _ton_t _twhether_t _tthe_t _tmath_t _texpression_t _tof_t _tthis_t _tKineticLaw_t_t _tcontains_t _tparameters_t/_tnumbers_t _twith_t _tundeclared_t _tunits_t.
 
KineticLaw_tKineticLaw_create (unsigned int level, unsigned int version)
 @_tclass_t _tdoc_kineticlaw_units_t
 
LocalParameter_tKineticLaw_createLocalParameter (KineticLaw_t *kl)
 _tCreates_t _ta_t _tnew_t _tLocalParameter_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructures_t'_ts_t _tlist_t _tof_t _tlocal_t _tparameters_t, _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tLocalParameter_t_t _tcreated_t.
 
Parameter_tKineticLaw_createParameter (KineticLaw_t *kl)
 _tCreates_t _ta_t _tnew_t _tParameter_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructures_t'_ts_t _tlist_t _tof_t _tparameters_t, _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tParameter_t_t _tcreated_t.
 
KineticLaw_tKineticLaw_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tKineticLaw_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
 
void KineticLaw_free (KineticLaw_t *kl)
 _tFrees_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
UnitDefinition_tKineticLaw_getDerivedUnitDefinition (KineticLaw_t *kl)
 _tCalculates_t _tand_t _treturns_t _ta_t _tUnitDefinition_t_t _tthat_t _texpresses_t _tthe_t _tunits_t _treturned_t _tby_t _tthe_t _tmath_t _texpression_t _tof_t _tthis_t _tKineticLaw_t_t.
 
const char * KineticLaw_getFormula (const KineticLaw_t *kl)
 _tReturns_t _tthe_t _tmathematical_t _texpression_t _tof_t _tthis_t _tKineticLaw_t_t _tstructure_t _tas_t _ta_t _tformula_t _tin_t _ttext_t-_tstring_t _tform_t.
 
ListOf_tKineticLaw_getListOfLocalParameters (KineticLaw_t *kl)
 _tGet_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tdefined_t _tfor_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
ListOf_tKineticLaw_getListOfParameters (KineticLaw_t *kl)
 _tGet_t _tthe_t _tlist_t _tof_t _tparameters_t _tdefined_t _tfor_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
LocalParameter_tKineticLaw_getLocalParameter (KineticLaw_t *kl, unsigned int n)
 _tGet_t _tthe_t _tnth_t _tparameter_t _tin_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
LocalParameter_tKineticLaw_getLocalParameterById (KineticLaw_t *kl, const char *sid)
 _tGet_t _ta_t _tparameter_t _twith_t _tidentifier_t "_tid_t" _tout_t _tof_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tdefined_t _tfor_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
const ASTNode_tKineticLaw_getMath (const KineticLaw_t *kl)
 _tReturns_t _tthe_t _tmathematical_t _texpression_t _tof_t _tthis_t _tKineticLaw_t_t _tstructure_t _tas_t _tan_t _tASTNode_t_t _tstructure_t.
 
const XMLNamespaces_tKineticLaw_getNamespaces (KineticLaw_t *kl)
 _tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tKineticLaw_t_t _tstructure_t.
 
unsigned int KineticLaw_getNumLocalParameters (const KineticLaw_t *kl)
 _tGet_t _tthe_t _tnumber_t _tof_t _tlocal_t _tparameters_t _tdefined_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
unsigned int KineticLaw_getNumParameters (const KineticLaw_t *kl)
 _tGet_t _tthe_t _tnumber_t _tof_t _tparameters_t _tdefined_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
Parameter_tKineticLaw_getParameter (KineticLaw_t *kl, unsigned int n)
 _tGet_t _tthe_t _tnth_t _tparameter_t _tin_t _tthe_t _tlist_t _tof_t _tparameters_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
Parameter_tKineticLaw_getParameterById (KineticLaw_t *kl, const char *sid)
 _tGet_t _ta_t _tparameter_t _twith_t _tidentifier_t "_tid_t" _tout_t _tof_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tdefined_t _tfor_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
const char * KineticLaw_getSubstanceUnits (const KineticLaw_t *kl)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
const char * KineticLaw_getTimeUnits (const KineticLaw_t *kl)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_ttimeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
int KineticLaw_isSetFormula (const KineticLaw_t *kl)
 _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 "_tformula_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t _tis_t _tset_t.
 
int KineticLaw_isSetMath (const KineticLaw_t *kl)
 _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 "_tmath_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t _tis_t _tset_t.
 
int KineticLaw_isSetSubstanceUnits (const KineticLaw_t *kl)
 _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 "_ttimeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t _tis_t _tset_t.
 
int KineticLaw_isSetTimeUnits (const KineticLaw_t *kl)
 _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 "_ttimeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t _tis_t _tset_t.
 
LocalParameter_tKineticLaw_removeLocalParameter (KineticLaw_t *kl, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tLocalParameter_t_t _tstructure_t _tfrom_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tin_t _tthis_t _tKineticLaw_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
LocalParameter_tKineticLaw_removeLocalParameterById (KineticLaw_t *kl, const char *sid)
 _tRemoves_t _tthe_t _tLocalParameter_t_t _tstructure_t _twith_t _tthe_t _tgiven_t "_tid_t" _tattribute_t _tfrom_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tin_t _tthis_t _tKineticLaw_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
Parameter_tKineticLaw_removeParameter (KineticLaw_t *kl, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tParameter_t_t _tstructure_t _tfrom_t _tthe_t _tlist_t _tof_t _tparameters_t _tin_t _tthis_t _tKineticLaw_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
Parameter_tKineticLaw_removeParameterById (KineticLaw_t *kl, const char *sid)
 _tRemoves_t _tthe_t _tParameter_t_t _tstructure_t _twith_t _tthe_t _tgiven_t "_tid_t" _tattribute_t _tfrom_t _tthe_t _tlist_t _tof_t _tparameters_t _tin_t _tthis_t _tKineticLaw_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
int KineticLaw_setFormula (KineticLaw_t *kl, const char *formula)
 _tSets_t _tthe_t _tformula_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
int KineticLaw_setMath (KineticLaw_t *kl, const ASTNode_t *math)
 _tSets_t _tthe_t _tformula_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
int KineticLaw_setSubstanceUnits (KineticLaw_t *kl, const char *sid)
 _tSets_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
int KineticLaw_setTimeUnits (KineticLaw_t *kl, const char *sid)
 _tSets_t _tthe_t "_ttimeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
int KineticLaw_unsetSubstanceUnits (KineticLaw_t *kl)
 _tUnsets_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 
int KineticLaw_unsetTimeUnits (KineticLaw_t *kl)
 _tUnsets_t _tthe_t "_ttimeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.
 

Detailed Description

Definition of KineticLaw_t.

Author
Ben Bornstein

Function Documentation

◆ KineticLaw_addLocalParameter()

int KineticLaw_addLocalParameter ( KineticLaw_t kl,
const LocalParameter_t p 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tLocalParameter_t_t _tstructure_t _tto_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tcopydetails_t _tdoc_use_localparam_in_l3_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tp_t _ta_t _tpointer_t _tto_t _ta_t _tLocalParameter_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_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_DUPLICATE_OBJECT_ID_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_addParameter()

int KineticLaw_addParameter ( KineticLaw_t kl,
const Parameter_t p 
)

_tAdds_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tParameter_t_t _tstructure_t _tto_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tp_t _ta_t _tpointer_t _tto_t _ta_t _tParameter_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_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_DUPLICATE_OBJECT_ID_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_clone()

KineticLaw_t * KineticLaw_clone ( const KineticLaw_t kl)

_tReturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tKineticLaw_t_t _tstructure_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_containsUndeclaredUnits()

int KineticLaw_containsUndeclaredUnits ( KineticLaw_t kl)

_tPredicate_t _treturning_t @_tc_t _ttrue_t _tor_t @_tc_t _tfalse_t _tdepending_t _ton_t _twhether_t _tthe_t _tmath_t _texpression_t _tof_t _tthis_t _tKineticLaw_t_t _tcontains_t _tparameters_t/_tnumbers_t _twith_t _tundeclared_t _tunits_t.

@_treturn_t @_tc_t _ttrue_t _tif_t _tthe_t _tmath_t _texpression_t _tof_t _tthis_t _tKineticLaw_t_t _tincludes_t _tparameters_t/_tnumbers_t _twith_t _tundeclared_t _tunits_t, @_tc_t _tfalse_t _totherwise_t.

@_tnote_t _ta_t _treturn_t _tvalue_t _tof_t @_tc_t _ttrue_t _tindicates_t _tthat_t _tthe_t _tUnitDefinition_t_t _treturned_t _tby_t _tthe_t _tgetDerivedUnitDefinition_t _tfunction_t _tmay_t _tnot_t _taccurately_t _trepresent_t _tthe_t _tunits_t _tof_t _tthe_t _texpression_t.

@_tsee_t _tKineticLaw_getDerivedUnitDefinition_t()

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_create()

KineticLaw_t * KineticLaw_create ( unsigned int  level,
unsigned int  version 
)

@_tclass_t _tdoc_kineticlaw_units_t

@_tpar_t _tThe_t _tunits_t _tare_t _tcalculated_t _tbased_t _ton_t _tthe_t _tmathematical_t _texpression_t _tin_t _tthe_t _tKineticLaw_t _tand_t _tthe_t _tmodel_t _tquantities_t _treferenced_t _tby_t <_tcode_t>&_tlt_t;_tci_t&_tgt_t;</_tcode_t> _telements_t _tused_t _twithin_t _tthat_t _texpression_t. _tThe_t @_tif_t _tjava_t _tKineticLaw_t::_tgetDerivedUnitDefinition_t()@_telse_t _tgetDerivedUnitDefinition_t()@_tendif_t _tmethod_t _treturns_t _tthe_t _tcalculated_t _tunits_t.

@_tclass_t _tdoc_warning_kineticlaw_math_literals_t

@_twarning_t <_tspan_t _tclass_t="_twarning_t">_tNote_t _tthat_t _tit_t _tis_t _tpossible_t _tthe_t "_tmath_t" _texpression_t _tin_t _tthe_t _tKineticLaw_t _tcontains_t _tpure_t _tnumbers_t _tor_t _tparameters_t _twith_t _tundeclared_t _tunits_t. _tIn_t _tthose_t _tcases_t, _tit_t _tis_t _tnot_t _tpossible_t _tto_t _tcalculate_t _tthe_t _tunits_t _tof_t _tthe_t _toverall_t _texpression_t _twithout_t _tmaking_t _tassumptions_t. _tLibSBML_t _tdoes_t _tnot_t _tmake_t _tassumptions_t _tabout_t _tthe_t _tunits_t, _tand_t _tKineticLaw_t::_tgetDerivedUnitDefinition_t() _treturns_t _tthe_t _tunits_t _tas_t _tfar_t _tas_t _tit_t _tis_t _table_t _tto_t _tdetermine_t _tthem_t. _tFor_t _texample_t, _tin_t _tan_t _texpression_t <_tem_t>_tX_t + _tY_t</_tem_t>, _tif_t <_tem_t>_tX_t</_tem_t> _thas_t _tunambiguously_t-_tdefined_t _tunits_t _tand_t <_tem_t>_tY_t</_tem_t> _tdoes_t _tnot_t, _tit_t _twill_t _treturn_t _tthe_t _tunits_t _tof_t <_tem_t>_tX_t</_tem_t>. <_tstrong_t>_tIt_t _tis_t _timportant_t _tthat_t _tcallers_t _talso_t _tinvoke_t _tthe_t _tmethod_t</_tstrong_t> _tKineticLaw_t::_tcontainsUndeclaredUnits_t()<_tstrong_t>_tto_t _tdetermine_t _twhether_t _tthis_t _tsituation_t _tholds_t</_tstrong_t>. _tCallers_t _tmay_t _twish_t _tto_t _ttake_t _tsuitable_t _tactions_t _tin_t _tthose_t _tscenarios_t.</_tspan_t>

@_tclass_t _tdoc_note_timeunits_substanceunits_t

@_tnote_t _tThe_t _tattributes_t "_ttimeUnits_t" _tand_t "_tsubstanceUnits_t" _tare_t _tpresent_t _tonly_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t1_t. _tIn_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t2_t, _tthe_t "_ttimeUnits_t" _tand_t "_tsubstanceUnits_t" _tattributes_t _twere_t _tremoved_t. _tFor_t _tcompatibility_t _twith_t _tnew_t _tversions_t _tof_t _tSBML_t, _tusers_t _tare_t _tcautioned_t _tto_t _tavoid_t _tthese_t _tattributes_t.

_tCreates_t _ta_t _tnew_t _tKineticLaw_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t _tvalues_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 _tKineticLaw_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 _tKineticLaw_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tKineticLaw_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tKineticLaw_t_t

@_tclass_t _tdoc_kineticlaw_units_t

@_tcond_t _tdoxygenIgnored_t

◆ KineticLaw_createLocalParameter()

LocalParameter_t * KineticLaw_createLocalParameter ( KineticLaw_t kl)

_tCreates_t _ta_t _tnew_t _tLocalParameter_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructures_t'_ts_t _tlist_t _tof_t _tlocal_t _tparameters_t, _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tLocalParameter_t_t _tcreated_t.

@_tcopydetails_t _tdoc_use_localparam_in_l3_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_treturn_t _ta_t _tpointer_t _tto_t _ta_t _tLocalParameter_t_t _tstructure_t, _tor_t @_tc_t _tNULL_t _tif_t @_tp_t _tkl_t _tis_t @_tc_t _tNULL_t, _tor_t _tif_t _tits_t _tnamepace_t _tindicates_t _tit_t _tis_t _tan_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t _tor_t _t2_t _tobject_t.

@_tsee_t _tKineticLaw_createParameter_t()

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_createParameter()

Parameter_t * KineticLaw_createParameter ( KineticLaw_t kl)

_tCreates_t _ta_t _tnew_t _tParameter_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructures_t'_ts_t _tlist_t _tof_t _tparameters_t, _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tthe_t _tParameter_t_t _tcreated_t.

@_tcopydetails_t _tdoc_use_param_in_l2_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_treturn_t _ta_t _tpointer_t _tto_t _ta_t _tParameter_t_t _tstructure_t, _tor_t @_tc_t _tNULL_t _tif_t @_tp_t _tkl_t _tis_t @_tc_t _tNULL_t, _tor_t _tif_t _tits_t _tnamepace_t _tindicates_t _tit_t _tis_t _tan_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t _tobject_t.

@_tsee_t _tKineticLaw_createLocalParameter_t()

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_createWithNS()

KineticLaw_t * KineticLaw_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tKineticLaw_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 _tKineticLaw_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tKineticLaw_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_free()

void KineticLaw_free ( KineticLaw_t kl)

_tFrees_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_getDerivedUnitDefinition()

UnitDefinition_t * KineticLaw_getDerivedUnitDefinition ( KineticLaw_t kl)

_tCalculates_t _tand_t _treturns_t _ta_t _tUnitDefinition_t_t _tthat_t _texpresses_t _tthe_t _tunits_t _treturned_t _tby_t _tthe_t _tmath_t _texpression_t _tof_t _tthis_t _tKineticLaw_t_t.

@_treturn_t _ta_t _tUnitDefinition_t_t _tthat_t _texpresses_t _tthe_t _tunits_t _tof_t _tthe_t _tmath_t _texpression_t _tof_t _tthis_t _tKineticLaw_t_t.

_tNote_t _tthat_t _tthe_t _tfunctionality_t _tthat_t _tfacilitates_t _tunit_t _tanalysis_t _tdepends_t _ton_t _tthe_t _tmodel_t _tas_t _ta_t _twhole_t. _tThus_t, _tin_t _tcases_t _twhere_t _tthe_t _tobject_t _thas_t _tnot_t _tbeen_t _tadded_t _tto_t _ta_t _tmodel_t _tor_t _tthe_t _tmodel_t _titself_t _tis_t _tincomplete_t, _tunit_t _tanalysis_t _tis_t _tnot_t _tpossible_t _tand_t _tthis_t _tmethod_t _twill_t _treturn_t @_tc_t _tNULL_t.

@_tnote_t _tThe_t _tunits_t _tare_t _tcalculated_t _tby_t _tapplying_t _tthe_t _tmathematics_t _tfrom_t _tthe_t _texpression_t _tto_t _tthe_t _tunits_t _tof_t _tthe_t &_tlt_t;_tci_t&_tgt_t; _telements_t _tused_t _twithin_t _tthe_t _texpression_t. _tWhere_t _tthere_t _tare_t _tparameters_t/_tnumbers_t _twith_t _tundeclared_t _tunits_t _tthe_t _tUnitDefinition_t_t _treturned_t _tby_t _tthis_t _tfunction_t _tmay_t _tnot_t _taccurately_t _trepresent_t _tthe_t _tunits_t _tof_t _tthe_t _texpression_t.

@_tsee_t _tKineticLaw_containsUndeclaredUnits_t()

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_getFormula()

const char * KineticLaw_getFormula ( const KineticLaw_t kl)

_tReturns_t _tthe_t _tmathematical_t _texpression_t _tof_t _tthis_t _tKineticLaw_t_t _tstructure_t _tas_t _ta_t _tformula_t _tin_t _ttext_t-_tstring_t _tform_t.

_tThis_t _tis_t _tfundamentally_t _tequivalent_t _tto_t _tKineticLaw_getMath_t(). _tIt_t _tis_t _tprovided_t _tprincipally_t _tfor_t _tcompatibility_t _twith_t _tSBML_t _tLevel_t _t1_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_treturn_t _tthe_t _tformula_t _tof_t _tthis_t _tKineticLaw_t_t _tstructure_t.

@_tsee_t _tKineticLaw_getMath_t().

@_tnote_t _tSBML_t _tLevel_t _t1_t _tuses_t _ta_t _ttext_t-_tstring_t _tformat_t _tfor_t _tmathematical_t _tformulas_t. _tOther_t _tlevels_t _tof_t _tSBML_t _tuse_t _tMathML_t, _tan_t _tXML_t _tformat_t _tfor_t _trepresenting_t _tmathematical_t _texpressions_t. _tLibSBML_t _tprovides_t _tan_t _tAbstract_t _tSyntax_t _tTree_t _tAPI_t _tfor_t _tworking_t _twith_t _tmathematical_t _texpressions_t; _tthis_t _tAPI_t _tis_t _tmore_t _tpowerful_t _tthan_t _tworking_t _twith_t _tformulas_t _tdirectly_t _tin_t _ttext_t _tform_t, _tand_t _tASTs_t _tcan_t _tbe_t _ttranslated_t _tinto_t _teither_t _tMathML_t _tor_t _tthe_t _ttext_t-_tstring_t _tsyntax_t. _tThe_t _tlibSBML_t _tmethods_t _tthat_t _taccept_t _ttext_t-_tstring_t _tformulas_t _tdirectly_t (_tsuch_t _tas_t _tthis_t _tconstructor_t) _tare_t _tprovided_t _tfor_t _tSBML_t _tLevel_t _t1_t _tcompatibility_t, _tbut_t _tdevelopers_t _tare_t _tencouraged_t _tto_t _tuse_t _tthe_t _tAST_t _tmechanisms_t. _tSee_t _tKineticLaw_createWithMath_t _tfor_t _ta_t _tversion_t _tthat_t _ttakes_t _tan_t _tASTNode_t_t _tstructure_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_getListOfLocalParameters()

ListOf_t * KineticLaw_getListOfLocalParameters ( KineticLaw_t kl)

_tGet_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tdefined_t _tfor_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tcopydetails_t _tdoc_use_localparam_in_l3_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_treturn_t _ta_t _tlist_t _tof_t _tLocalParameters_t

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_getListOfParameters()

ListOf_t * KineticLaw_getListOfParameters ( KineticLaw_t kl)

_tGet_t _tthe_t _tlist_t _tof_t _tparameters_t _tdefined_t _tfor_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tcopydetails_t _tdoc_use_param_in_l2_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_treturn_t _ta_t _tlist_t _tof_t _tParameters_t

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_getLocalParameter()

LocalParameter_t * KineticLaw_getLocalParameter ( KineticLaw_t kl,
unsigned int  n 
)

_tGet_t _tthe_t _tnth_t _tparameter_t _tin_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

_tCallers_t _tshould_t _tfirst_t _tfind_t _tout_t _thow_t _tmany_t _tparameters_t _tare_t _tin_t _tthe_t _tlist_t _tby_t _tcalling_t _tKineticLaw_getNumLocalParameters_t(). @_tcopydetails_t _tdoc_use_localparam_in_l3_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tn_t _tthe_t _tindex_t _tof_t _tthe_t _tLocalParameter_t_t _tstructure_t _tsought_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tLocalParameter_t_t _tstructure_t

@_tsee_t _tKineticLaw_getNumLocalParameters_t().

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_getLocalParameterById()

LocalParameter_t * KineticLaw_getLocalParameterById ( KineticLaw_t kl,
const char *  sid 
)

_tGet_t _ta_t _tparameter_t _twith_t _tidentifier_t "_tid_t" _tout_t _tof_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tdefined_t _tfor_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tcopydetails_t _tdoc_use_localparam_in_l3_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifier_t _tof_t _tthe_t _tLocalParameter_t_t _tstructure_t _tsought_t.

@_treturn_t _tthe_t _tLocalParameter_t_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tLocalParameter_t_t _texists_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_getMath()

const ASTNode_t * KineticLaw_getMath ( const KineticLaw_t kl)

_tReturns_t _tthe_t _tmathematical_t _texpression_t _tof_t _tthis_t _tKineticLaw_t_t _tstructure_t _tas_t _tan_t _tASTNode_t_t _tstructure_t.

_tThis_t _tis_t _tfundamentally_t _tequivalent_t _tto_t _tKineticLaw_getFormula_t(). _tThe_t _tlatter_t _tis_t _tprovided_t _tprincipally_t _tfor_t _tcompatibility_t _twith_t _tSBML_t _tLevel_t _t1_t, _twhich_t _trepresented_t _tmathematical_t _tformulas_t _tin_t _ttext_t-_tstring_t _tform_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_treturn_t _tthe_t _tformula_t _tin_t _tthe_t _tform_t _tof_t _tan_t _tASTNode_t_t _tstructure_t

@_tsee_t _tKineticLaw_getFormula_t().

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_getNamespaces()

const XMLNamespaces_t * KineticLaw_getNamespaces ( KineticLaw_t kl)

_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_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 _tKineticLaw_t_t

◆ KineticLaw_getNumLocalParameters()

unsigned int KineticLaw_getNumLocalParameters ( const KineticLaw_t kl)

_tGet_t _tthe_t _tnumber_t _tof_t _tlocal_t _tparameters_t _tdefined_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tcopydetails_t _tdoc_use_localparam_in_l3_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tLocalParameter_t_t _tstructures_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_getNumParameters()

unsigned int KineticLaw_getNumParameters ( const KineticLaw_t kl)

_tGet_t _tthe_t _tnumber_t _tof_t _tparameters_t _tdefined_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tcopydetails_t _tdoc_use_param_in_l2_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tParameter_t_t _tstructures_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_getParameter()

Parameter_t * KineticLaw_getParameter ( KineticLaw_t kl,
unsigned int  n 
)

_tGet_t _tthe_t _tnth_t _tparameter_t _tin_t _tthe_t _tlist_t _tof_t _tparameters_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

_tCallers_t _tshould_t _tfirst_t _tfind_t _tout_t _thow_t _tmany_t _tparameters_t _tare_t _tin_t _tthe_t _tlist_t _tby_t _tcalling_t _tKineticLaw_getNumParameters_t(). @_tcopydetails_t _tdoc_use_param_in_l2_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tn_t _tthe_t _tindex_t _tof_t _tthe_t _tParameter_t_t _tstructure_t _tsought_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tParameter_t_t _tstructure_t

@_tsee_t _tKineticLaw_getNumParameters_t().

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_getParameterById()

Parameter_t * KineticLaw_getParameterById ( KineticLaw_t kl,
const char *  sid 
)

_tGet_t _ta_t _tparameter_t _twith_t _tidentifier_t "_tid_t" _tout_t _tof_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tdefined_t _tfor_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tcopydetails_t _tdoc_use_param_in_l2_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifier_t _tof_t _tthe_t _tParameter_t_t _tstructure_t _tsought_t.

@_treturn_t _tthe_t _tParameter_t_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tid_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tParameter_t_t _texists_t _tin_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_getSubstanceUnits()

const char * KineticLaw_getSubstanceUnits ( const KineticLaw_t kl)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_treturn_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tvalue_t

@_twarning_t _tIn_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t2_t, _tthe_t "_ttimeUnits_t" _tand_t "_tsubstanceUnits_t" _tattributes_t _twere_t _tremoved_t. _tFor_t _tcompatibility_t _twith_t _tnew_t _tversions_t _tof_t _tSBML_t, _tusers_t _tare_t _tcautioned_t _tto_t _tavoid_t _tthese_t _tattributes_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_getTimeUnits()

const char * KineticLaw_getTimeUnits ( const KineticLaw_t kl)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_ttimeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_treturn_t _tthe_t "_ttimeUnits_t" _tattribute_t _tvalue_t

@_twarning_t _tIn_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t2_t, _tthe_t "_ttimeUnits_t" _tand_t "_tsubstanceUnits_t" _tattributes_t _twere_t _tremoved_t. _tFor_t _tcompatibility_t _twith_t _tnew_t _tversions_t _tof_t _tSBML_t, _tusers_t _tare_t _tcautioned_t _tto_t _tavoid_t _tthese_t _tattributes_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_isSetFormula()

int KineticLaw_isSetFormula ( const KineticLaw_t kl)

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

_tThis_t _tis_t _tfundamentally_t _tequivalent_t _tto_t _tKineticLaw_isSetMath_t(). _tIt_t _tis_t _tprovided_t _tprincipally_t _tfor_t _tcompatibility_t _twith_t _tSBML_t _tLevel_t _t1_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tformula_t (_tor_t _tequivalently_t _tthe_t "_tmath_t" _tsubelement_t) _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tSBML_t _tLevel_t _t1_t _tuses_t _ta_t _ttext_t-_tstring_t _tformat_t _tfor_t _tmathematical_t _tformulas_t. _tOther_t _tlevels_t _tof_t _tSBML_t _tuse_t _tMathML_t, _tan_t _tXML_t _tformat_t _tfor_t _trepresenting_t _tmathematical_t _texpressions_t. _tLibSBML_t _tprovides_t _tan_t _tAbstract_t _tSyntax_t _tTree_t _tAPI_t _tfor_t _tworking_t _twith_t _tmathematical_t _texpressions_t; _tthis_t _tAPI_t _tis_t _tmore_t _tpowerful_t _tthan_t _tworking_t _twith_t _tformulas_t _tdirectly_t _tin_t _ttext_t _tform_t, _tand_t _tASTs_t _tcan_t _tbe_t _ttranslated_t _tinto_t _teither_t _tMathML_t _tor_t _tthe_t _ttext_t-_tstring_t _tsyntax_t. _tThe_t _tlibSBML_t _tmethods_t _tthat_t _taccept_t _ttext_t-_tstring_t _tformulas_t _tdirectly_t (_tsuch_t _tas_t _tthis_t _tconstructor_t) _tare_t _tprovided_t _tfor_t _tSBML_t _tLevel_t _t1_t _tcompatibility_t, _tbut_t _tdevelopers_t _tare_t _tencouraged_t _tto_t _tuse_t _tthe_t _tAST_t _tmechanisms_t. _tSee_t _tKineticLaw_createWithMath_t _tfor_t _ta_t _tversion_t _tthat_t _ttakes_t _tan_t _tASTNode_t_t _tstructure_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_isSetMath()

int KineticLaw_isSetMath ( const KineticLaw_t kl)

_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 "_tmath_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t _tis_t _tset_t.

_tThis_t _tis_t _tfundamentally_t _tequivalent_t _tto_t _tKineticLaw_isSetFormula_t(). _tThe_t _tlatter_t _tprovided_t _tprincipally_t _tfor_t _tcompatibility_t _twith_t _tSBML_t _tLevel_t _t1_t, _twhich_t _trepresented_t _tmathematical_t _tformulas_t _tin_t _ttext_t-_tstring_t _tform_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tmath_t" _tsubelement_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_isSetSubstanceUnits()

int KineticLaw_isSetSubstanceUnits ( const KineticLaw_t kl)

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

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

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

@_twarning_t _tIn_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t2_t, _tthe_t "_ttimeUnits_t" _tand_t "_tsubstanceUnits_t" _tattributes_t _twere_t _tremoved_t. _tFor_t _tcompatibility_t _twith_t _tnew_t _tversions_t _tof_t _tSBML_t, _tusers_t _tare_t _tcautioned_t _tto_t _tavoid_t _tthese_t _tattributes_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_isSetTimeUnits()

int KineticLaw_isSetTimeUnits ( const KineticLaw_t kl)

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

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

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

@_twarning_t _tIn_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t2_t, _tthe_t "_ttimeUnits_t" _tand_t "_tsubstanceUnits_t" _tattributes_t _twere_t _tremoved_t. _tFor_t _tcompatibility_t _twith_t _tnew_t _tversions_t _tof_t _tSBML_t, _tusers_t _tare_t _tcautioned_t _tto_t _tavoid_t _tthese_t _tattributes_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_removeLocalParameter()

LocalParameter_t * KineticLaw_removeLocalParameter ( KineticLaw_t kl,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tLocalParameter_t_t _tstructure_t _tfrom_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tin_t _tthis_t _tKineticLaw_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. @_tcopydetails_t _tdoc_use_localparam_in_l3_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t. @_tparam_t _tn_t _tthe_t _tinteger_t _tindex_t _tof_t _tthe_t _tLocalParameter_t_t _tsought_t.

@_treturn_t _tthe_t _tLocalParameter_t_t _tstructure_t _tremoved_t. _tAs_t _tmentioned_t _tabove_t, _tthe_t _tcaller_t _towns_t _tthe_t _treturned_t _titem_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 _tKineticLaw_t_t

◆ KineticLaw_removeLocalParameterById()

LocalParameter_t * KineticLaw_removeLocalParameterById ( KineticLaw_t kl,
const char *  sid 
)

_tRemoves_t _tthe_t _tLocalParameter_t_t _tstructure_t _twith_t _tthe_t _tgiven_t "_tid_t" _tattribute_t _tfrom_t _tthe_t _tlist_t _tof_t _tlocal_t _tparameters_t _tin_t _tthis_t _tKineticLaw_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. @_tcopydetails_t _tdoc_use_localparam_in_l3_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t. @_tparam_t _tsid_t _tthe_t _tstring_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tLocalParameter_t_t _tsought_t.

@_treturn_t _tthe_t _tLocalParameter_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 _tKineticLaw_t_t _tstructure_t _twith_t _tthe_t _tidentifier_t _texists_t _tin_t _tthis_t _tKineticLaw_t_t _tstructure_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_removeParameter()

Parameter_t * KineticLaw_removeParameter ( KineticLaw_t kl,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tParameter_t_t _tstructure_t _tfrom_t _tthe_t _tlist_t _tof_t _tparameters_t _tin_t _tthis_t _tKineticLaw_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. @_tcopydetails_t _tdoc_use_param_in_l2_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t. @_tparam_t _tn_t _tthe_t _tinteger_t _tindex_t _tof_t _tthe_t _tParameter_t_t _tsought_t.

@_treturn_t _tthe_t _tParameter_t_t _tstructure_t _tremoved_t. _tAs_t _tmentioned_t _tabove_t, _tthe_t _tcaller_t _towns_t _tthe_t _treturned_t _titem_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 _tKineticLaw_t_t

◆ KineticLaw_removeParameterById()

Parameter_t * KineticLaw_removeParameterById ( KineticLaw_t kl,
const char *  sid 
)

_tRemoves_t _tthe_t _tParameter_t_t _tstructure_t _twith_t _tthe_t _tgiven_t "_tid_t" _tattribute_t _tfrom_t _tthe_t _tlist_t _tof_t _tparameters_t _tin_t _tthis_t _tKineticLaw_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. @_tcopydetails_t _tdoc_use_param_in_l2_t

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t. @_tparam_t _tsid_t _tthe_t _tstring_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tParameter_t_t _tsought_t.

@_treturn_t _tthe_t _tParameter_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 _tKineticLaw_t_t _tstructure_t _twith_t _tthe_t _tidentifier_t _texists_t _tin_t _tthis_t _tKineticLaw_t_t _tstructure_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_setFormula()

int KineticLaw_setFormula ( KineticLaw_t kl,
const char *  formula 
)

_tSets_t _tthe_t _tformula_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

_tThis_t _tis_t _tfundamentally_t _tequivalent_t _tto_t _tKineticLaw_setMath_t(). _tIt_t _tis_t _tprovided_t _tprincipally_t _tfor_t _tcompatibility_t _twith_t _tSBML_t _tLevel_t _t1_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tformula_t _tthe_t _tmathematical_t _texpression_t, _tin_t _ttext_t-_tstring_t _tform_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}

@_tnote_t _tSBML_t _tLevel_t _t1_t _tuses_t _ta_t _ttext_t-_tstring_t _tformat_t _tfor_t _tmathematical_t _tformulas_t. _tOther_t _tlevels_t _tof_t _tSBML_t _tuse_t _tMathML_t, _tan_t _tXML_t _tformat_t _tfor_t _trepresenting_t _tmathematical_t _texpressions_t. _tLibSBML_t _tprovides_t _tan_t _tAbstract_t _tSyntax_t _tTree_t _tAPI_t _tfor_t _tworking_t _twith_t _tmathematical_t _texpressions_t; _tthis_t _tAPI_t _tis_t _tmore_t _tpowerful_t _tthan_t _tworking_t _twith_t _tformulas_t _tdirectly_t _tin_t _ttext_t _tform_t, _tand_t _tASTs_t _tcan_t _tbe_t _ttranslated_t _tinto_t _teither_t _tMathML_t _tor_t _tthe_t _ttext_t-_tstring_t _tsyntax_t. _tThe_t _tlibSBML_t _tmethods_t _tthat_t _taccept_t _ttext_t-_tstring_t _tformulas_t _tdirectly_t (_tsuch_t _tas_t _tthis_t _tconstructor_t) _tare_t _tprovided_t _tfor_t _tSBML_t _tLevel_t _t1_t _tcompatibility_t, _tbut_t _tdevelopers_t _tare_t _tencouraged_t _tto_t _tuse_t _tthe_t _tAST_t _tmechanisms_t. _tSee_t _tKineticLaw_createWithMath_t _tfor_t _ta_t _tversion_t _tthat_t _ttakes_t _tan_t _tASTNode_t_t _tstructure_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_setMath()

int KineticLaw_setMath ( KineticLaw_t kl,
const ASTNode_t math 
)

_tSets_t _tthe_t _tformula_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

_tThis_t _tis_t _tfundamentally_t _tequivalent_t _tto_t _tKineticLaw_setFormula_t(). _tThe_t _tlatter_t _tprovided_t _tprincipally_t _tfor_t _tcompatibility_t _twith_t _tSBML_t _tLevel_t _t1_t, _twhich_t _trepresented_t _tmathematical_t _tformulas_t _tin_t _ttext_t-_tstring_t _tform_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tmath_t _tan_t _tASTNode_t_t _tstructure_t _trepresenting_t _tthe_t _tmathematical_t _tformula_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 _tKineticLaw_t_t

◆ KineticLaw_setSubstanceUnits()

int KineticLaw_setSubstanceUnits ( KineticLaw_t kl,
const char *  sid 
)

_tSets_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

_tThe_t _tidentifier_t _tstring_t @_tp_t _tsid_t _tis_t _tcopied_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifier_t _tof_t _tthe_t _tunits_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 "_tsubstanceUnits_t" _tattribute_t.

@_twarning_t _tIn_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t2_t, _tthe_t "_ttimeUnits_t" _tand_t "_tsubstanceUnits_t" _tattributes_t _twere_t _tremoved_t. _tFor_t _tcompatibility_t _twith_t _tnew_t _tversions_t _tof_t _tSBML_t, _tusers_t _tare_t _tcautioned_t _tto_t _tavoid_t _tthese_t _tattributes_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_setTimeUnits()

int KineticLaw_setTimeUnits ( KineticLaw_t kl,
const char *  sid 
)

_tSets_t _tthe_t "_ttimeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

_tThe_t _tidentifier_t _tstring_t @_tp_t _tsid_t _tis_t _tcopied_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifier_t _tof_t _tthe_t _tunits_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 "_ttimeUnits_t" _tattribute_t.

@_twarning_t _tIn_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t2_t, _tthe_t "_ttimeUnits_t" _tand_t "_tsubstanceUnits_t" _tattributes_t _twere_t _tremoved_t. _tFor_t _tcompatibility_t _twith_t _tnew_t _tversions_t _tof_t _tSBML_t, _tusers_t _tare_t _tcautioned_t _tto_t _tavoid_t _tthese_t _tattributes_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_unsetSubstanceUnits()

int KineticLaw_unsetSubstanceUnits ( KineticLaw_t kl)

_tUnsets_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_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}

@_twarning_t _tIn_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t2_t, _tthe_t "_ttimeUnits_t" _tand_t "_tsubstanceUnits_t" _tattributes_t _twere_t _tremoved_t. _tFor_t _tcompatibility_t _twith_t _tnew_t _tversions_t _tof_t _tSBML_t, _tusers_t _tare_t _tcautioned_t _tto_t _tavoid_t _tthese_t _tattributes_t.

@_tmemberof_t _tKineticLaw_t_t

◆ KineticLaw_unsetTimeUnits()

int KineticLaw_unsetTimeUnits ( KineticLaw_t kl)

_tUnsets_t _tthe_t "_ttimeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tKineticLaw_t_t _tstructure_t.

@_tparam_t _tkl_t _tthe_t _tKineticLaw_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}

@_twarning_t _tIn_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t2_t, _tthe_t "_ttimeUnits_t" _tand_t "_tsubstanceUnits_t" _tattributes_t _twere_t _tremoved_t. _tFor_t _tcompatibility_t _twith_t _tnew_t _tversions_t _tof_t _tSBML_t, _tusers_t _tare_t _tcautioned_t _tto_t _tavoid_t _tthese_t _tattributes_t.

@_tmemberof_t _tKineticLaw_t_t