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

Definitions of InitialAssignment_t and ListOfInitialAssignments_t. More...

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

Functions

InitialAssignment_tInitialAssignment_clone (const InitialAssignment_t *ia)
 _tCopy_t _tconstructor_t; _tcreates_t _ta_t _tcopy_t _tof_t _tthis_t _tInitialAssignment_t_t.
 
int InitialAssignment_containsUndeclaredUnits (InitialAssignment_t *ia)
 _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 _tInitialAssignment_t_t _tcontains_t _tparameters_t/_tnumbers_t _twith_t _tundeclared_t _tunits_t.
 
InitialAssignment_tInitialAssignment_create (unsigned int level, unsigned int version)
 @_tclass_t _tdoc_initialassignment_units_t
 
InitialAssignment_tInitialAssignment_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tInitialAssignment_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
 
void InitialAssignment_free (InitialAssignment_t *ia)
 _tFrees_t _tthe_t _tgiven_t _tInitialAssignment_t_t _tstructure_t.
 
UnitDefinition_tInitialAssignment_getDerivedUnitDefinition (InitialAssignment_t *ia)
 _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 _tInitialAssignment_t_t.
 
const ASTNode_tInitialAssignment_getMath (const InitialAssignment_t *ia)
 _tGet_t _tthe_t _tmathematical_t _tformula_t _tof_t _tthis_t _tInitialAssignment_t_t.
 
const XMLNamespaces_tInitialAssignment_getNamespaces (InitialAssignment_t *ia)
 _tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tInitialAssignment_t_t _tstructure_t.
 
const char * InitialAssignment_getSymbol (const InitialAssignment_t *ia)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsymbol_t" _tattribute_t _tof_t _tthis_t _tInitialAssignment_t_t.
 
int InitialAssignment_isSetMath (const InitialAssignment_t *ia)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthis_t _tInitialAssignment_t_t'_ts_t "_tmath_t" _tsubelement_t _tcontains_t _ta_t _tvalue_t.
 
int InitialAssignment_isSetSymbol (const InitialAssignment_t *ia)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthis_t _tInitialAssignment_t_t'_ts_t "_tsymbol_t" _tattribute_t _tis_t _tset_t.
 
int InitialAssignment_setMath (InitialAssignment_t *ia, const ASTNode_t *math)
 _tSets_t _tthe_t "_tmath_t" _tsubelement_t _tof_t _tthis_t _tInitialAssignment_t_t
 
int InitialAssignment_setSymbol (InitialAssignment_t *ia, const char *sid)
 _tSets_t _tthe_t "_tsymbol_t" _tattribute_t _tvalue_t _tof_t _tthis_t _tInitialAssignment_t_t
 
int InitialAssignment_unsetSymbol (InitialAssignment_t *ia)
 _tUnsets_t _tthe_t "_tsymbol_t" _tattribute_t _tvalue_t _tof_t _tthis_t _tInitialAssignment_t_t
 
InitialAssignment_tListOfInitialAssignments_getById (ListOf_t *lo, const char *sid)
 _tDespite_t _tits_t _tname_t, _treturns_t _tthe_t _tInitialAssignment_t_t _tstructure_t _twith_t _tthe_t "_tsymbol_t" _tattribute_t _tmatching_t _tthe_t _tgiven_t _tidentifier_t.
 
InitialAssignment_tListOfInitialAssignments_removeById (ListOf_t *lo, const char *sid)
 _tDespite_t _tits_t _tname_t, _tremoves_t _ta_t _tInitialAssignment_t_t _tstructure_t _twith_t _tthe_t "_tsymbol_t" _tattribute_t _tmatching_t _tthe_t _tgiven_t _tidentifier_t.
 

Detailed Description

Definitions of InitialAssignment_t and ListOfInitialAssignments_t.

Author
Ben Bornstein

Function Documentation

◆ InitialAssignment_clone()

InitialAssignment_t * InitialAssignment_clone ( const InitialAssignment_t ia)

_tCopy_t _tconstructor_t; _tcreates_t _ta_t _tcopy_t _tof_t _tthis_t _tInitialAssignment_t_t.

@_tparam_t _tia_t _tthe_t _tInitialAssignment_t_t _tstructure_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tInitialAssignment_t_t _tstructure_t.

@_tmemberof_t _tInitialAssignment_t_t

◆ InitialAssignment_containsUndeclaredUnits()

int InitialAssignment_containsUndeclaredUnits ( InitialAssignment_t ia)

_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 _tInitialAssignment_t_t _tcontains_t _tparameters_t/_tnumbers_t _twith_t _tundeclared_t _tunits_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tmath_t _texpression_t _tof_t _tthis_t _tInitialAssignment_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 _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 _tInitialAssignment_getDerivedUnitDefinition_t()

@_tmemberof_t _tInitialAssignment_t_t

◆ InitialAssignment_create()

InitialAssignment_t * InitialAssignment_create ( unsigned int  level,
unsigned int  version 
)

@_tclass_t _tdoc_initialassignment_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 _tInitialAssignment_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 _tmethod_t _tInitialAssignment_t::_tgetDerivedUnitDefinition_t() _treturns_t _tthe_t _tcalculated_t _tunits_t, _tto_t _tthe_t _textent_t _tthat_t _tlibSBML_t _tcan_t _tcompute_t _tthem_t.

@_tclass_t _tdoc_warning_initialassignment_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 _tInitialAssignment_t _tcontains_t _tliteral_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 _tInitialAssignment_t::_tgetDerivedUnitDefinition_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>. _tWhen_t _tusing_t _tthis_t _tmethod_t, <_tstrong_t>_tit_t _tis_t _tcritical_t _tthat_t _tcallers_t _talso_t _tinvoke_t _tthe_t _tmethod_t</_tstrong_t> _tInitialAssignment_t::_tcontainsUndeclaredUnits_t() <_tstrong_t>_tto_t _tdetermine_t _twhether_t _tthis_t _tsituation_t _tholds_t</_tstrong_t>. _tCallers_t _tshould_t _ttake_t _tsuitable_t _taction_t _tin_t _tthose_t _tsituations_t.</_tspan_t>

_tCreates_t _ta_t _tnew_t _tInitialAssignment_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 _tInitialAssignment_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 _tInitialAssignment_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tInitialAssignment_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tInitialAssignment_t_t

@_tclass_t _tdoc_initialassignment_units_t

@_tcond_t _tdoxygenIgnored_t

◆ InitialAssignment_createWithNS()

InitialAssignment_t * InitialAssignment_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tInitialAssignment_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 _tInitialAssignment_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tInitialAssignment_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tInitialAssignment_t_t

◆ InitialAssignment_free()

void InitialAssignment_free ( InitialAssignment_t ia)

_tFrees_t _tthe_t _tgiven_t _tInitialAssignment_t_t _tstructure_t.

@_tparam_t _tia_t _tthe_t _tInitialAssignment_t_t _tstructure_t _tto_t _tfree_t.

@_tmemberof_t _tInitialAssignment_t_t

◆ InitialAssignment_getDerivedUnitDefinition()

UnitDefinition_t * InitialAssignment_getDerivedUnitDefinition ( InitialAssignment_t ia)

_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 _tInitialAssignment_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 _tInitialAssignment_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 _tstructure_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 _tInitialAssignment_containsUndeclaredUnits_t()

@_tmemberof_t _tInitialAssignment_t_t

◆ InitialAssignment_getMath()

const ASTNode_t * InitialAssignment_getMath ( const InitialAssignment_t ia)

_tGet_t _tthe_t _tmathematical_t _tformula_t _tof_t _tthis_t _tInitialAssignment_t_t.

@_tparam_t _tia_t _tthe_t _tInitialAssignment_t_t _tstructure_t.

@_treturn_t _tan_t _tASTNode_t_t, _tthe_t _tvalue_t _tof_t _tthe_t "_tmath_t" _tsubelement_t _tof_t _tthis_t _tInitialAssignment_t_t

@_tmemberof_t _tInitialAssignment_t_t

◆ InitialAssignment_getNamespaces()

const XMLNamespaces_t * InitialAssignment_getNamespaces ( InitialAssignment_t ia)

_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tInitialAssignment_t_t _tstructure_t.

@_tparam_t _tia_t _tthe_t _tInitialAssignment_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 _tInitialAssignment_t_t

◆ InitialAssignment_getSymbol()

const char * InitialAssignment_getSymbol ( const InitialAssignment_t ia)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsymbol_t" _tattribute_t _tof_t _tthis_t _tInitialAssignment_t_t.

@_tparam_t _tia_t _tthe_t _tInitialAssignment_t_t _tstructure_t.

@_treturn_t _tthe_t _tidentifier_t _tstring_t _tstored_t _tas_t _tthe_t "_tsymbol_t" _tattribute_t _tvalue_t _tin_t _tthis_t _tInitialAssignment_t_t.

@_tmemberof_t _tInitialAssignment_t_t

◆ InitialAssignment_isSetMath()

int InitialAssignment_isSetMath ( const InitialAssignment_t ia)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthis_t _tInitialAssignment_t_t'_ts_t "_tmath_t" _tsubelement_t _tcontains_t _ta_t _tvalue_t.

@_tparam_t _tia_t _tthe_t _tInitialAssignment_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tmath_t" _tfor_t _tthis_t _tInitialAssignment_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tInitialAssignment_t_t

◆ InitialAssignment_isSetSymbol()

int InitialAssignment_isSetSymbol ( const InitialAssignment_t ia)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _twhether_t _tthis_t _tInitialAssignment_t_t'_ts_t "_tsymbol_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tia_t _tthe_t _tInitialAssignment_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tsymbol_t" _tattribute_t _tof_t _tthis_t _tInitialAssignment_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tInitialAssignment_t_t

◆ InitialAssignment_setMath()

int InitialAssignment_setMath ( InitialAssignment_t ia,
const ASTNode_t math 
)

_tSets_t _tthe_t "_tmath_t" _tsubelement_t _tof_t _tthis_t _tInitialAssignment_t_t

_tThe_t _tASTNode_t _ttree_t _tpassed_t _tin_t @_tp_t _tmath_t _tis_t _tcopied_t.

@_tparam_t _tia_t _tthe_t _tInitialAssignment_t_t _tstructure_t.

@_tparam_t _tmath_t _tan_t _tASTNode_t_t _ttree_t _tcontaining_t _tthe_t _tmathematical_t _texpression_t _tto_t _tbe_t _tused_t _tas_t _tthe_t _tformula_t _tfor_t _tthis_t _tInitialAssignment_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 _tInitialAssignment_t_t

◆ InitialAssignment_setSymbol()

int InitialAssignment_setSymbol ( InitialAssignment_t ia,
const char *  sid 
)

_tSets_t _tthe_t "_tsymbol_t" _tattribute_t _tvalue_t _tof_t _tthis_t _tInitialAssignment_t_t

@_tparam_t _tia_t _tthe_t _tInitialAssignment_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifier_t _tof_t _tan_t _telement_t _tdefined_t _tin_t _tthis_t _tmodel_t _twhose_t _tvalue_t _tcan_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}

@_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 "_tsymbol_t" _tattribute_t.

@_tmemberof_t _tInitialAssignment_t_t

◆ InitialAssignment_unsetSymbol()

int InitialAssignment_unsetSymbol ( InitialAssignment_t ia)

_tUnsets_t _tthe_t "_tsymbol_t" _tattribute_t _tvalue_t _tof_t _tthis_t _tInitialAssignment_t_t

@_tparam_t _tia_t _tthe_t _tInitialAssignment_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_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tInitialAssignment_t_t

◆ ListOfInitialAssignments_getById()

InitialAssignment_t * ListOfInitialAssignments_getById ( ListOf_t lo,
const char *  sid 
)

_tDespite_t _tits_t _tname_t, _treturns_t _tthe_t _tInitialAssignment_t_t _tstructure_t _twith_t _tthe_t "_tsymbol_t" _tattribute_t _tmatching_t _tthe_t _tgiven_t _tidentifier_t.

@_tparam_t _tlo_t _tthe_t _tListOfInitialAssignments_t_t _tstructure_t _tto_t _tsearch_t. @_tparam_t _tsid_t _tthe_t "_tsymbol_t" _tattribute_t _tvalue_t _tbeing_t _tsought_t.

@_treturn_t _titem_t _tin_t _tthe_t @_tp_t _tlo_t _tListOfInitialAssignments_t _twhose_t "_tsymbol_t" _tattribute_t _tmatches_t _tthe_t _tgiven_t @_tp_t _tsid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _titem_t _texists_t.

@_tsee_t _tListOf_t_t

@_tmemberof_t _tListOfInitialAssignments_t_t

◆ ListOfInitialAssignments_removeById()

InitialAssignment_t * ListOfInitialAssignments_removeById ( ListOf_t lo,
const char *  sid 
)

_tDespite_t _tits_t _tname_t, _tremoves_t _ta_t _tInitialAssignment_t_t _tstructure_t _twith_t _tthe_t "_tsymbol_t" _tattribute_t _tmatching_t _tthe_t _tgiven_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 _tInitialAssignment_t_t _tstructures_t _tto_t _tsearch_t. @_tparam_t _tsid_t _tthe_t "_tsymbol_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tstructure_t _tto_t _tremove_t.

@_treturn_t _tThe_t _tInitialAssignment_t_t _tstructure_t _tremoved_t _twhose_t "_tsymbol_t" _tattribute_t _tmatches_t _tthe_t _tgiven_t @_tp_t _tsid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _titem_t _texists_t.

@_tsee_t _tListOf_t_t

@_tmemberof_t _tListOfInitialAssignments_t_t