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

Definition of StoichiometryMath_t. More...

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

Functions

StoichiometryMath_tStoichiometryMath_clone (const StoichiometryMath_t *t)
 @_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tStoichiometryMath_t_t.
 
int StoichiometryMath_containsUndeclaredUnits (StoichiometryMath_t *math)
 _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 _texpression_t _tof_t _tthis_t _tStoichiometryMath_t_t _tcontains_t _tparameters_t/_tnumbers_t _twith_t _tundeclared_t _tunits_t.
 
StoichiometryMath_tStoichiometryMath_create (unsigned int level, unsigned int version)
 @_tclass_t _tdoc_note_stoichiometrymath_availability_t
 
StoichiometryMath_tStoichiometryMath_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tStoichiometryMath_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
 
void StoichiometryMath_free (StoichiometryMath_t *t)
 _tFrees_t _tthe_t _tgiven_t _tStoichiometryMath_t_t.
 
UnitDefinition_tStoichiometryMath_getDerivedUnitDefinition (StoichiometryMath_t *math)
 _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 _tin_t _tthis_t _tStoichiometryMath_t_t.
 
const ASTNode_tStoichiometryMath_getMath (const StoichiometryMath_t *t)
 @_treturn_t _tthe_t _tmath_t _tof_t _tthis_t _tStoichiometryMath_t_t _tas_t _tan_t _tASTNode_t_t.
 
const XMLNamespaces_tStoichiometryMath_getNamespaces (StoichiometryMath_t *sm)
 _tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tStoichiometryMath_t_t _tstructure_t.
 
int StoichiometryMath_isSetMath (const StoichiometryMath_t *t)
 @_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tmath_t (_tor_t _tequivalently_t _tthe_t _tformula_t) _tof_t _tthis_t _tStoichiometryMath_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
 
int StoichiometryMath_setMath (StoichiometryMath_t *t, const ASTNode_t *math)
 _tSets_t _tthe_t _tmath_t _tof_t _tthis_t _tStoichiometryMath_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tASTNode_t_t.
 

Detailed Description

Definition of StoichiometryMath_t.

Author
Sarah Keating

Function Documentation

◆ StoichiometryMath_clone()

StoichiometryMath_t * StoichiometryMath_clone ( const StoichiometryMath_t t)

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tStoichiometryMath_t_t.

@_tmemberof_t _tStoichiometryMath_t_t

◆ StoichiometryMath_containsUndeclaredUnits()

int StoichiometryMath_containsUndeclaredUnits ( StoichiometryMath_t math)

_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 _texpression_t _tof_t _tthis_t _tStoichiometryMath_t_t _tcontains_t _tparameters_t/_tnumbers_t _twith_t _tundeclared_t _tunits_t.

@_tparam_t _tmath_t _tthe_t _tStoichiometryMath_t_t _tstructure_t _tto_t _tcheck_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tmath_t _texpression_t _tof_t _tthis_t _tStoichiometryMath_t_t _tincludes_t _tparameters_t/_tnumbers_t _twith_t _tundeclared_t _tunits_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _ta_t _treturn_t _tvalue_t _tof_t @_tc_t _t1_t (_ttrue_t) _tindicates_t _tthat_t _tthe_t _tUnitDefinition_t_t _treturned_t _tby_t _tStoichiometryMath_getDerivedUnitDefinition_t() _tmay_t _tnot_t _taccurately_t _trepresent_t _tthe_t _tunits_t _tof_t _tthe_t _texpression_t.

@_tsee_t _tStoichiometryMath_getDerivedUnitDefinition_t()

@_tmemberof_t _tStoichiometryMath_t_t

◆ StoichiometryMath_create()

StoichiometryMath_t * StoichiometryMath_create ( unsigned int  level,
unsigned int  version 
)

@_tclass_t _tdoc_note_stoichiometrymath_availability_t

@_tnote_t _tThe_t _tStoichiometryMath_t _tconstruct_t _texists_t _tonly_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t. _tIt_t _tis_t _tan_t _toptional_t _tconstruct_t _tavailable_t _tfor_t _tdefining_t _tthe_t _tstoichiometries_t _tof_t _treactants_t _tand_t _tproducts_t _tin_t _tReaction_t _tobjects_t. _tNote_t _tthat_t _ta_t _tdifferent_t _tmechanism_t _tis_t _tused_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t, _twhere_t _tStoichiometryMath_t _tis_t _tnot_t _tavailable_t. _tPlease_t _tconsult_t _tthe_t _ttop_t _tof_t _tthis_t _tlibSBML_t _tStoichiometryMath_t _tdocumentation_t _tfor_t _tmore_t _tinformation_t _tabout_t _tthe_t _tdifferences_t _tbetween_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tand_t&_tnbsp_t;_t3_t _twith_t _trespect_t _tto_t _tstoichiometries_t.

_tCreates_t _ta_t _tnew_t _tStoichiometryMath_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 _tStoichiometryMath_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 _tStoichiometryMath_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tStoichiometryMath_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tStoichiometryMath_t_t

@_tclass_t _tdoc_note_stoichiometrymath_availability_t

@_tcond_t _tdoxygenIgnored_t

◆ StoichiometryMath_createWithNS()

StoichiometryMath_t * StoichiometryMath_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tStoichiometryMath_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 _tStoichiometryMath_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tStoichiometryMath_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tStoichiometryMath_t_t

◆ StoichiometryMath_free()

void StoichiometryMath_free ( StoichiometryMath_t t)

_tFrees_t _tthe_t _tgiven_t _tStoichiometryMath_t_t.

@_tmemberof_t _tStoichiometryMath_t_t

◆ StoichiometryMath_getDerivedUnitDefinition()

UnitDefinition_t * StoichiometryMath_getDerivedUnitDefinition ( StoichiometryMath_t math)

_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 _tin_t _tthis_t _tStoichiometryMath_t_t.

@_tparam_t _tmath_t _tthe_t _tStoichiometryMath_t_t _tstructure_t _tto_t _tcheck_t.

@_treturn_t _tA_t _tUnitDefinition_t_t _tthat_t _texpresses_t _tthe_t _tunits_t _tof_t _tthe_t _tmath_t

_tThe_t _tunits_t _tare_t _tcalculated_t _tbased_t _ton_t _tthe_t _tmathematical_t _texpression_t _tin_t _tthe_t _tStoichiometryMath_t_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 _tStoichiometryMath_getDerivedUnitDefinition_t() _tmethod_t _treturns_t _tthe_t _tcalculated_t _tunits_t.

@_twarning_t _tNote_t _tthat_t _tit_t _tis_t _tpossible_t _tthe_t "_tmath_t" _texpression_t _tin_t _tthe_t _tStoichiometryMath_t_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 _tStoichiometryMath_getDerivedUnitDefinition_t() _tonly_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 _tStoichiometryMath_containsUndeclaredUnits_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.

@_tsee_t _tcontainsUndeclaredUnits_t()

@_tmemberof_t _tStoichiometryMath_t_t

◆ StoichiometryMath_getMath()

const ASTNode_t * StoichiometryMath_getMath ( const StoichiometryMath_t t)

@_treturn_t _tthe_t _tmath_t _tof_t _tthis_t _tStoichiometryMath_t_t _tas_t _tan_t _tASTNode_t_t.

@_tmemberof_t _tStoichiometryMath_t_t

◆ StoichiometryMath_getNamespaces()

const XMLNamespaces_t * StoichiometryMath_getNamespaces ( StoichiometryMath_t sm)

_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tStoichiometryMath_t_t _tstructure_t.

@_tparam_t _tsm_t _tthe_t _tStoichiometryMath_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 _tStoichiometryMath_t_t

◆ StoichiometryMath_isSetMath()

int StoichiometryMath_isSetMath ( const StoichiometryMath_t t)

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

@_tmemberof_t _tStoichiometryMath_t_t

◆ StoichiometryMath_setMath()

int StoichiometryMath_setMath ( StoichiometryMath_t t,
const ASTNode_t math 
)

_tSets_t _tthe_t _tmath_t _tof_t _tthis_t _tStoichiometryMath_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tASTNode_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 _tStoichiometryMath_t_t