libSBML C API  libSBML 5.20.2 C API
Loading...
Searching...
No Matches
RateRule.cpp File Reference

Implementations of RateRule_t. More...

Include dependency graph for RateRule.cpp:

Functions

RateRule_tRateRule_clone (RateRule_t *rr)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t.
 
RateRule_tRateRule_create (unsigned int level, unsigned int version)
 @_tendcond_t
 
RateRule_tRateRule_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tRateRule_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t, @_tp_t _tsbmlns_t.
 
void RateRule_free (RateRule_t *rr)
 _tFrees_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t.
 
const char * RateRule_getFormula (const RateRule_t *r)
 @_tnote_t _tSBML_t _tLevel_t _t1_t _tuses_t _ta_t _ttext_t-_tstring_t _tformat_t _tfor_t _tmathematical_t _tformulas_t.
 
const ASTNode_tRateRule_getMath (const RateRule_t *rr)
 _tReturns_t _tthe_t _tmathematical_t _texpression_t _tof_t _tthis_t _tRateRule_t_t _tstructure_t _tas_t _tan_t _tASTNode_t_t _tstructure_t.
 
const char * RateRule_getVariable (const RateRule_t *rr)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariable_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t.
 
int RateRule_hasRequiredAttributes (const RateRule_t *rr)
 _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 _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int RateRule_hasRequiredElements (const RateRule_t *rr)
 _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 _tsub_t-_telements_t _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int RateRule_isSetFormula (const RateRule_t *r)
 @_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tformula_t (_tor_t _tequivalently_t _tthe_t _tmath_t) _tfor_t _tthis_t _tRateRule_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
 
int RateRule_isSetMath (const RateRule_t *rr)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t'_ts_t "_tmath_t" _tis_t _tset_t.
 
int RateRule_isSetVariable (const RateRule_t *rr)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t'_ts_t "_tvariable_t" _tis_t _tset_t.
 
int RateRule_setFormula (RateRule_t *r, const char *formula)
 _tSets_t _tthe_t _tformula_t _tof_t _tthis_t _tRateRule_t_t _tto_t _ta_t _tcopy_t _tof_t _tstring_t.
 
int RateRule_setMath (RateRule_t *rr, const ASTNode_t *math)
 _tSets_t _tthe_t _tmathematical_t _texpression_t _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t.
 
int RateRule_setVariable (RateRule_t *rr, const char *variable)
 _tSets_t _tthe_t "_tvariable_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t.
 
int RateRule_unsetVariable (RateRule_t *ar)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariable_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t.
 

Detailed Description

Implementations of RateRule_t.

Author
Ben Bornstein

Function Documentation

◆ RateRule_clone()

RateRule_t * RateRule_clone ( RateRule_t rr)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t.

@_tparam_t _trr_t _tthe_t _tRateRule_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

@_treturns_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _ta_t _tfailure_t _toccurred_t.

@_tmemberof_t _tRateRule_t_t

◆ RateRule_create()

RateRule_t * RateRule_create ( unsigned int  level,
unsigned int  version 
)

@_tendcond_t

_tCreates_t _ta_t _tnew_t _tRateRule_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 @_tendcond_t

◆ RateRule_createWithNS()

RateRule_t * RateRule_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tRateRule_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t, @_tp_t _tsbmlns_t.

@_tcopydetails_t _tdoc_what_are_sbmlnamespaces_t

@_tparam_t _tsbmlns_t _tan_t _tSBMLNamespaces_t_t _tstructure_t.

@_treturns_t _tthe_t _tnewly_t-_tcreated_t _tRateRule_t_t _tstructure_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _tan_t _terror_t _toccurred_t _tduring_t _tconstruction_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tRateRule_t_t

◆ RateRule_free()

void RateRule_free ( RateRule_t rr)

_tFrees_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t.

@_tparam_t _trr_t _tthe_t _tRateRule_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tRateRule_t_t

◆ RateRule_getFormula()

const char * RateRule_getFormula ( const RateRule_t r)

@_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 _tone_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.

@_treturn_t _tthe_t _tformula_t _tfor_t _tthis_t _tRateRule_t_t.

@_tmemberof_t _tRateRule_t_t

◆ RateRule_getMath()

const ASTNode_t * RateRule_getMath ( const RateRule_t rr)

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

@_tparam_t _trr_t _tthe_t _tRateRule_t_t _tstructure_t.

@_treturn_t _tthe_t _tmath_t _tfor_t _tthis_t _tRateRule_t_t, _tas_t _tan_t _tASTNode_t_t.

@_tmemberof_t _tRateRule_t_t

◆ RateRule_getVariable()

const char * RateRule_getVariable ( const RateRule_t rr)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariable_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t.

@_tparam_t _trr_t _tthe_t _tRateRule_t_t _tstructure_t.

@_treturn_t _tthe_t _tvariable_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tRateRule_t_t

◆ RateRule_hasRequiredAttributes()

int RateRule_hasRequiredAttributes ( const RateRule_t rr)

_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 _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tparam_t _trr_t _tthe_t _tRateRule_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 _tRateRule_t_t

◆ RateRule_hasRequiredElements()

int RateRule_hasRequiredElements ( const RateRule_t rr)

_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 _tsub_t-_telements_t _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tparam_t _trr_t _tthe_t _tRateRule_t_t _tstructure_t _tto_t _tcheck_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tsub_t-_telements_t _tfor_t _tthis_t _tstructure_t _thave_t _tbeen_t _tdefined_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tRateRule_t_t

◆ RateRule_isSetFormula()

int RateRule_isSetFormula ( const RateRule_t r)

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tformula_t (_tor_t _tequivalently_t _tthe_t _tmath_t) _tfor_t _tthis_t _tRateRule_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tRateRule_t_t

◆ RateRule_isSetMath()

int RateRule_isSetMath ( const RateRule_t rr)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t'_ts_t "_tmath_t" _tis_t _tset_t.

@_tparam_t _trr_t _tthe_t _tRateRule_t_t _tstructure_t.

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

@_tmemberof_t _tRateRule_t_t

◆ RateRule_isSetVariable()

int RateRule_isSetVariable ( const RateRule_t rr)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t'_ts_t "_tvariable_t" _tis_t _tset_t.

@_tparam_t _trr_t _tthe_t _tRateRule_t_t _tstructure_t.

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

@_tmemberof_t _tRateRule_t_t

◆ RateRule_setFormula()

int RateRule_setFormula ( RateRule_t r,
const char *  formula 
)

_tSets_t _tthe_t _tformula_t _tof_t _tthis_t _tRateRule_t_t _tto_t _ta_t _tcopy_t _tof_t _tstring_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 _tone_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.

@_tmemberof_t _tRateRule_t_t

◆ RateRule_setMath()

int RateRule_setMath ( RateRule_t rr,
const ASTNode_t math 
)

_tSets_t _tthe_t _tmathematical_t _texpression_t _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t.

@_tparam_t _trr_t _tthe_t _tRateRule_t_t _tstructure_t.

@_tparam_t _tmath_t _tan_t _tASTNode_t_t _tstructure_t _tto_t _tbe_t _tassigned_t _tas_t _tthe_t "_tmath_t" _tsubelement_t _tof_t _tthis_t _tRateRule_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_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tRateRule_t_t

◆ RateRule_setVariable()

int RateRule_setVariable ( RateRule_t rr,
const char *  variable 
)

_tSets_t _tthe_t "_tvariable_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tvariable_t. _tIf_t _tthe_t _tstring_t _tis_t _ta_t _tnull_t _tpointer_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tRateRule_unsetVariable_t().

@_tparam_t _trr_t _tthe_t _tRateRule_t_t _tstructure_t.

@_tparam_t _tvariable_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_t "_tvariable_t" _tattribute_t _tshould_t _tbe_t _tset_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _tvariable_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariable_t" _tattribute_t.

@_tmemberof_t _tRateRule_t_t

◆ RateRule_unsetVariable()

int RateRule_unsetVariable ( RateRule_t ar)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariable_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tRateRule_t_t _tstructure_t.

@_tparam_t _tar_t _tthe_t _tRateRule_t_t _tstructure_t.

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

@_tmemberof_t _tRateRule_t_t