libSBML C API
libSBML 5.20.2 C API
|
Implementation of EventAssignment_t. More...
Functions | |
EventAssignment_t * | EventAssignment_clone (const EventAssignment_t *ea) |
_tCreates_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t. | |
int | EventAssignment_containsUndeclaredUnits (EventAssignment_t *ea) |
_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 _tEventAssignment_t_t _tcontains_t _tparameters_t/_tnumbers_t _twith_t _tundeclared_t _tunits_t. | |
EventAssignment_t * | EventAssignment_create (unsigned int level, unsigned int version) |
@_tendcond_t | |
EventAssignment_t * | EventAssignment_createWithNS (SBMLNamespaces_t *sbmlns) |
_tCreates_t _ta_t _tnew_t _tEventAssignment_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t. | |
void | EventAssignment_free (EventAssignment_t *ea) |
_tFrees_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t. | |
UnitDefinition_t * | EventAssignment_getDerivedUnitDefinition (EventAssignment_t *ea) |
_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 _tEventAssignment_t_t. | |
const ASTNode_t * | EventAssignment_getMath (const EventAssignment_t *ea) |
_tReturns_t _tthe_t _tmathematical_t _tformula_t _tstored_t _tin_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t. | |
const XMLNamespaces_t * | EventAssignment_getNamespaces (EventAssignment_t *ea) |
_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tEventAssignment_t_t _tstructure_t. | |
const char * | EventAssignment_getVariable (const EventAssignment_t *ea) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariable_t" _tattribute_t _tof_t _tthis_t _tEventAssignment_t_t _tstructure_t. | |
int | EventAssignment_isSetMath (const EventAssignment_t *ea) |
_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tattribute_t "_tvariable_t" _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t _tis_t _tset_t. | |
int | EventAssignment_isSetVariable (const EventAssignment_t *ea) |
_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tattribute_t "_tvariable_t" _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t _tis_t _tset_t. | |
int | EventAssignment_setMath (EventAssignment_t *ea, const ASTNode_t *math) |
_tSets_t _tthe_t "_tmath_t" _tsubelement_t _tcontent_t _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t _tto_t _tthe_t _tgiven_t _tASTNode_t_t. | |
int | EventAssignment_setVariable (EventAssignment_t *ea, const char *sid) |
_tSets_t _tthe_t _tattribute_t "_tvariable_t" _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tidentifier_t _tstring_t. | |
int | EventAssignment_unsetVariable (EventAssignment_t *ea) |
_tUnsets_t _tthe_t _tattribute_t "_tvariable_t" _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t. | |
EventAssignment_t * | ListOfEventAssignments_getById (ListOf_t *lo, const char *sid) |
_tReturns_t _tthe_t _tEventAssignment_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t. | |
EventAssignment_t * | ListOfEventAssignments_removeById (ListOf_t *lo, const char *sid) |
_tRemoves_t _ta_t _tEventAssignment_t_t _tstructure_t _tbased_t _ton_t _tits_t _tidentifier_t. | |
Implementation of EventAssignment_t.
EventAssignment_t * EventAssignment_clone | ( | const EventAssignment_t * | ea | ) |
_tCreates_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t.
@_tparam_t _tea_t _tthe_t _tEventAssignment_t_t _tto_t _tbe_t _tcopied_t.
@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t @_tp_t _tea_t.
@_tmemberof_t _tEventAssignment_t_t
int EventAssignment_containsUndeclaredUnits | ( | EventAssignment_t * | ea | ) |
_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 _tEventAssignment_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 _tEventAssignment_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 _tEventAssignment_getDerivedUnitDefinition_t()
@_tmemberof_t _tEventAssignment_t_t
EventAssignment_t * EventAssignment_create | ( | unsigned int | level, |
unsigned int | version | ||
) |
@_tendcond_t
@_tclass_t _tdoc_eventassignment_units_t
@_tcond_t _tdoxygenIgnored_t
EventAssignment_t * EventAssignment_createWithNS | ( | SBMLNamespaces_t * | sbmlns | ) |
_tCreates_t _ta_t _tnew_t _tEventAssignment_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 _tEventAssignment_t_t.
@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tEventAssignment_t_t _tstructure_t.
@_tcopydetails_t _tdoc_note_setting_lv_t
@_tmemberof_t _tEventAssignment_t_t
void EventAssignment_free | ( | EventAssignment_t * | ea | ) |
_tFrees_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t.
@_tparam_t _tea_t _tthe_t _tEventAssignment_t_t _tto_t _tbe_t _tfreed_t.
@_tmemberof_t _tEventAssignment_t_t
UnitDefinition_t * EventAssignment_getDerivedUnitDefinition | ( | EventAssignment_t * | ea | ) |
_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 _tEventAssignment_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 _tEventAssignment_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 _tEventAssignment_containsUndeclaredUnits_t()
@_tmemberof_t _tEventAssignment_t_t
const ASTNode_t * EventAssignment_getMath | ( | const EventAssignment_t * | ea | ) |
_tReturns_t _tthe_t _tmathematical_t _tformula_t _tstored_t _tin_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t.
@_tparam_t _tea_t _tthe_t _tEventAssignment_t_t _tstructure_t _tto_t _tquery_t.
@_treturn_t _tthe_t _tASTNode_t_t _ttree_t _tstored_t _tin_t @_tp_t _tea_t.
@_tmemberof_t _tEventAssignment_t_t
const XMLNamespaces_t * EventAssignment_getNamespaces | ( | EventAssignment_t * | ea | ) |
_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tEventAssignment_t_t _tstructure_t.
@_tparam_t _tea_t _tthe_t _tEventAssignment_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 _tEventAssignment_t_t
const char * EventAssignment_getVariable | ( | const EventAssignment_t * | ea | ) |
_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvariable_t" _tattribute_t _tof_t _tthis_t _tEventAssignment_t_t _tstructure_t.
@_tparam_t _tea_t _tthe_t _tEventAssignment_t_t _tstructure_t _tto_t _tquery_t.
@_treturn_t _tthe_t _tidentifier_t _tstored_t _tin_t _tthe_t "_tvariable_t" _tattribute_t _tof_t @_tp_t _tea_t.
@_tmemberof_t _tEventAssignment_t_t
int EventAssignment_isSetMath | ( | const EventAssignment_t * | ea | ) |
_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tattribute_t "_tvariable_t" _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t _tis_t _tset_t.
@_tparam_t _tea_t _tthe_t _tEventAssignment_t_t _tstructure_t _tto_t _tquery_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tvariable_t" _tattribute_t _tof_t @_tp_t _tea_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tEventAssignment_t_t
int EventAssignment_isSetVariable | ( | const EventAssignment_t * | ea | ) |
_tPredicate_t _tfor_t _ttesting_t _twhether_t _tthe_t _tattribute_t "_tvariable_t" _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t _tis_t _tset_t.
@_tparam_t _tea_t _tthe_t _tEventAssignment_t_t _tstructure_t _tto_t _tquery_t.
@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tvariable_t" _tattribute_t _tof_t @_tp_t _tea_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
@_tmemberof_t _tEventAssignment_t_t
int EventAssignment_setMath | ( | EventAssignment_t * | ea, |
const ASTNode_t * | math | ||
) |
_tSets_t _tthe_t "_tmath_t" _tsubelement_t _tcontent_t _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t _tto_t _tthe_t _tgiven_t _tASTNode_t_t.
_tThe_t _tgiven_t @_tp_t _tmath_t _tASTNode_t_t _tis_t _tcopied_t.
@_tparam_t _tea_t _tthe_t _tEventAssignment_t_t _tto_t _tset_t. @_tparam_t _tmath_t _tthe_t _tASTNode_t_t _tto_t _tcopy_t _tinto_t @_tp_t _tea_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 _tEventAssignment_t_t
int EventAssignment_setVariable | ( | EventAssignment_t * | ea, |
const char * | sid | ||
) |
_tSets_t _tthe_t _tattribute_t "_tvariable_t" _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tidentifier_t _tstring_t.
@_tparam_t _tea_t _tthe_t _tEventAssignment_t_t _tto_t _tset_t. @_tparam_t _tsid_t _tthe_t _tidentifier_t _tof_t _tan_t _telement_t _tdefined_t _tin_t _tthis_t _tmodel_t _tthat_t _tcan_t _tvary_t _tover_t _ttime_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 "_tvariable_t" _tattribute_t.
@_tmemberof_t _tEventAssignment_t_t
int EventAssignment_unsetVariable | ( | EventAssignment_t * | ea | ) |
_tUnsets_t _tthe_t _tattribute_t "_tvariable_t" _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t.
@_tparam_t _tea_t _tthe_t _tEventAssignment_t_t _tto_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}
@_tmemberof_t _tEventAssignment_t_t
EventAssignment_t * ListOfEventAssignments_getById | ( | ListOf_t * | lo, |
const char * | sid | ||
) |
_tReturns_t _tthe_t _tEventAssignment_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.
@_tparam_t _tlo_t _tthe_t _tListOfEventAssignments_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 _tListOfEventAssignments_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 _tListOfEventAssignments_t_t
EventAssignment_t * ListOfEventAssignments_removeById | ( | ListOf_t * | lo, |
const char * | sid | ||
) |
_tRemoves_t _ta_t _tEventAssignment_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 _tEventAssignment_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 _tEventAssignment_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 _tListOfEventAssignments_t_t