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

Definitions of Event_t and ListOfEvents_t. More...

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

Functions

int Event_addEventAssignment (Event_t *e, const EventAssignment_t *ea)
 _tAppends_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t _tto_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.
 
Event_tEvent_clone (const Event_t *e)
 _tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.
 
Event_tEvent_create (unsigned int level, unsigned int version)
 @_tclass_t _tdoc_warning_event_timeUnits_t
 
Delay_tEvent_createDelay (Event_t *e)
 _tCreates_t _ta_t _tnew_t, _tempty_t _tDelay_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthis_t _tEvent_t_t, _tand_t _treturns_t _tthe_t _tDelay_t_t.
 
EventAssignment_tEvent_createEventAssignment (Event_t *e)
 _tCreates_t _ta_t _tnew_t, _tempty_t _tEventAssignment_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthis_t _tEvent_t_t'_ts_t _tlist_t _tof_t _tevent_t _tassignments_t, _tand_t _treturns_t _tthe_t _tEventAssignment_t_t.
 
Priority_tEvent_createPriority (Event_t *e)
 _tCreates_t _ta_t _tnew_t, _tempty_t _tPriority_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthis_t _tEvent_t_t, _tand_t _treturns_t _tthe_t _tPriority_t_t.
 
Trigger_tEvent_createTrigger (Event_t *e)
 _tCreates_t _ta_t _tnew_t, _tempty_t _tTrigger_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthis_t _tEvent_t_t, _tand_t _treturns_t _tthe_t _tTrigger_t_t.
 
Event_tEvent_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tEvent_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
 
void Event_free (Event_t *e)
 _tFrees_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.
 
Delay_tEvent_getDelay (Event_t *e)
 _tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tits_t _tDelay_t_t _tstructure_t.
 
EventAssignment_tEvent_getEventAssignment (Event_t *e, unsigned int n)
 _tReturn_t _ta_t _tspecific_t _tEventAssignment_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tEvent_t_t.
 
EventAssignment_tEvent_getEventAssignmentByVar (Event_t *e, const char *variable)
 _tReturn_t _tthe_t _tevent_t _tassignment_t _tindicated_t _tby_t _tthe_t _tgiven_t @_tp_t _tvariable_t.
 
const char * Event_getId (const Event_t *e)
 _tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.
 
ListOf_tEvent_getListOfEventAssignments (Event_t *e)
 _tGet_t _tthe_t _tlist_t _tof_t _tEventAssignment_t_t _tstructures_t _tfrom_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.
 
const char * Event_getName (const Event_t *e)
 _tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.
 
const XMLNamespaces_tEvent_getNamespaces (Event_t *e)
 _tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.
 
unsigned int Event_getNumEventAssignments (const Event_t *e)
 _tReturns_t _tthe_t _tnumber_t _tof_t _tEventAssignment_t_t _tstructures_t _tattached_t _tto_t _tthe_t _tgiven_t _tEvent_t_t.
 
Priority_tEvent_getPriority (Event_t *e)
 _tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tits_t _tPriority_t_t _tstructure_t.
 
const char * Event_getTimeUnits (const Event_t *e)
 _tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tthe_t _tvalue_t _tof_t _tits_t "_ttimeUnits_t" _tattribute_t.
 
Trigger_tEvent_getTrigger (Event_t *e)
 _tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tits_t _tTrigger_t_t _tstructure_t.
 
int Event_getUseValuesFromTriggerTime (const Event_t *e)
 _tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tthe_t _tvalue_t _tof_t _tits_t "_tuseValuesFromTriggerTime_t" _tattribute_t.
 
int Event_hasRequiredAttributes (Event_t *e)
 _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 _tfor_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int Event_hasRequiredElements (Event_t *e)
 _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 _telements_t _tfor_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int Event_isSetDelay (const Event_t *e)
 _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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t _tdelay_t _tis_t _tset_t.
 
int Event_isSetId (const Event_t *e)
 _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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t _tidentifier_t _tis_t _tset_t.
 
int Event_isSetName (const Event_t *e)
 _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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t _tname_t _tis_t _tset_t.
 
int Event_isSetPriority (const Event_t *e)
 _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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t _tpriority_t _tis_t _tset_t.
 
int Event_isSetTimeUnits (const Event_t *e)
 _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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t "_ttimeUnits_t" _tattribute_t _tis_t _tset_t.
 
int Event_isSetTrigger (const Event_t *e)
 _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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t _ttrigger_t _tis_t _tset_t.
 
int Event_isSetUseValuesFromTriggerTime (const Event_t *e)
 _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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t _tuseValuesFromTriggerTime_t _tattribute_t _tis_t _tset_t.
 
EventAssignment_tEvent_removeEventAssignment (Event_t *e, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tEventAssignment_t_t _tstructure_t _tfrom_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
EventAssignment_tEvent_removeEventAssignmentByVar (Event_t *e, const char *variable)
 _tRemoves_t _tthe_t _tEventAssignment_t_t _tstructure_t _twith_t _tthe_t _tgiven_t "_tvariable_t" _tattribute_t _tfrom_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
int Event_setDelay (Event_t *e, const Delay_t *delay)
 _tSets_t _tthe_t _tdelay_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tDelay_t_t.
 
int Event_setId (Event_t *e, const char *sid)
 _tAssigns_t _tthe_t _tidentifier_t _tof_t _tan_t _tEvent_t_t _tstructure_t.
 
int Event_setName (Event_t *e, const char *name)
 _tSets_t _tthe_t _tname_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tname_t.
 
int Event_setPriority (Event_t *e, const Priority_t *priority)
 _tSets_t _tthe_t _tpriority_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tPriority_t_t.
 
int Event_setTimeUnits (Event_t *e, const char *sid)
 _tSets_t _tthe_t "_ttimeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tsid_t.
 
int Event_setTrigger (Event_t *e, const Trigger_t *trigger)
 _tSets_t _tthe_t _ttrigger_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tTrigger_t_t.
 
int Event_setUseValuesFromTriggerTime (Event_t *e, int value)
 _tSets_t _tthe_t "_tuseValuesFromTriggerTime_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tto_t _ta_t @_tp_t _tvalue_t.
 
int Event_unsetDelay (Event_t *e)
 _tUnsets_t _tthe_t _tdelay_t _tof_t _tthe_t _tgiven_t _tEvent_t_t.
 
int Event_unsetId (Event_t *e)
 _tUnsets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.
 
int Event_unsetName (Event_t *e)
 _tUnsets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.
 
int Event_unsetPriority (Event_t *e)
 _tUnsets_t _tthe_t _tpriority_t _tof_t _tthe_t _tgiven_t _tEvent_t_t.
 
int Event_unsetTimeUnits (Event_t *e)
 _tUnsets_t _tthe_t "_ttimeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tEvent_t_t.
 
int Event_unsetUseValuesFromTriggerTime (Event_t *e)
 _tUnsets_t _tthe_t "_tuseValuesFromTriggerTime_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.
 
Event_tListOfEvents_getById (ListOf_t *lo, const char *sid)
 _tReturns_t _tthe_t _tEvent_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.
 
Event_tListOfEvents_removeById (ListOf_t *lo, const char *sid)
 _tRemoves_t _ta_t _tEvent_t_t _tstructure_t _tbased_t _ton_t _tits_t _tidentifier_t.
 

Detailed Description

Definitions of Event_t and ListOfEvents_t.

Author
Ben Bornstein

Function Documentation

◆ Event_addEventAssignment()

int Event_addEventAssignment ( Event_t e,
const EventAssignment_t ea 
)

_tAppends_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tEventAssignment_t_t _tstructure_t _tto_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tEventAssignment_t_t _tshould_t _tbe_t _tadded_t.

@_tparam_t _tea_t _tan_t _tEventAssignment_t_t _tstructure_t _tto_t _tadd_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_DUPLICATE_OBJECT_ID_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_FAILED_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tEvent_t_t

◆ Event_clone()

Event_t * Event_clone ( const Event_t e)

_tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tcopy_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tEvent_t_t.

@_tmemberof_t _tEvent_t_t

◆ Event_create()

Event_t * Event_create ( unsigned int  level,
unsigned int  version 
)

@_tclass_t _tdoc_warning_event_timeUnits_t

@_twarning_t <_tspan_t _tclass_t="_twarning_t">_tDefinitions_t _tof_t _tEvent_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersions_t&_tnbsp_t;_t1_t _tand_t&_tnbsp_t;_t2_t _tincluded_t _tthe_t _tadditional_t _tattribute_t _tcalled_t "_ttimeUnits_t", _tbut_t _tit_t _twas_t _tremoved_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t3_t. _tLibSBML_t _tsupports_t _tthis_t _tattribute_t _tfor_t _tcompatibility_t _twith_t _tprevious_t _tversions_t _tof_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t, _tbut_t _tits_t _tuse_t _tis_t _tdiscouraged_t _tsince_t _tmodels_t _tin_t _tLevel_t&_tnbsp_t;_t2_t _tVersions_t&_tnbsp_t;_t3_t _tand_t&_tnbsp_t;_t4_t _tcannot_t _tcontain_t _tit_t. _tIf_t _ta_t _tVersion_t&_tnbsp_t;_t3_t _tor_t&_tnbsp_t;_t4_t _tmodel_t _tsets_t _tthe_t _tattribute_t, _tthe_t _tconsistency_t-_tchecking_t _tmethod_t _tSBMLDocument_t::_tcheckConsistency_t() _twill_t _treport_t _tan_t _terror_t.</_tspan_t>

@_tclass_t _tdoc_warning_useValuesFromTriggerTime_t

@_twarning_t <_tspan_t _tclass_t="_twarning_t">_tThe_t _tattribute_t "_tuseValuesFromTriggerTime_t" _twas_t _tintroduced_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t4_t. _tIt_t _tis_t _tnot_t _tvalid_t _tin_t _tmodels_t _tdefined_t _tusing_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tversions_t _tprior_t _tto_t _tVersion_t&_tnbsp_t;_t4_t. _tIf_t _ta_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t1_t&_tndash_t;_t3_t _tmodel_t _tsets_t _tthe_t _tattribute_t, _tthe_t _tconsistency_t-_tchecking_t _tmethod_t _tSBMLDocument_t::_tcheckConsistency_t() _twill_t _treport_t _tan_t _terror_t.</_tspan_t>

@_tclass_t _tdoc_event_using_useValuesFromTriggerTime_t

@_tpar_t _tThe_t _toptional_t _tDelay_t _ton_t _tEvent_t _tand_t _tthe_t _tfact_t _tthat_t _tmultiple_t _tevents_t _tmay_t _tbe_t _tsimultaneously_t _texecuted_t _tmeans_t _tthere_t _tare_t _ttwo_t _ttimes_t _tto_t _tconsider_t _twhen_t _tcomputing_t _tthe_t _tresults_t _tof_t _tan_t _tevent_t: _tthe_t _ttime_t _tat_t _twhich_t _tthe_t _tevent_t _tis_t <_tem_t>_ttriggered_t</_tem_t>, _tand_t _tthe_t _ttime_t _tat_t _twhich_t _tassignments_t _tare_t <_tem_t>_texecuted_t</_tem_t>. _tIt_t _tis_t _talso_t _tpossible_t _tto_t _tdistinguish_t _tbetween_t _tthe_t _ttime_t _tat_t _twhich_t _tthe_t _tEventAssignment_t'_ts_t _texpression_t _tis_t _tcalculated_t, _tand_t _tthe_t _ttime_t _tat_t _twhich_t _tthe_t _tassignment_t _tis_t _tmade_t: _tthe_t _texpression_t _tcould_t _tbe_t _tevaluated_t _tat_t _tthe_t _tsame_t _ttime_t _tthe_t _tassignments_t _tare_t _tperformed_t, _ti_t._te_t., _twhen_t _tthe_t _tevent_t _tis_t <_tem_t>_texecuted_t</_tem_t>, _tbut_t _tit_t _tcould_t _talso_t _tbe_t _tdefined_t _tto_t _tbe_t _tevaluated_t _tat_t _tthe_t _ttime_t _tthe_t _tevent_t _tis_t <_tem_t>_ttriggered_t</_tem_t>.

_tIn_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tversions_t _tprior_t _tto_t _tVersion_t&_tnbsp_t;_t4_t, _tthe_t _tsemantics_t _tof_t _tEvent_t _ttime_t _tdelays_t _twere_t _tdefined_t _tsuch_t _tthat_t _tthe_t _texpressions_t _tin_t _tthe_t _tevent_t'_ts_t _tassignments_t _twere_t _talways_t _tevaluated_t _tat_t _tthe_t _ttime_t _tthe_t _tevent_t _twas_t <_tem_t>_ttriggered_t</_tem_t>. _tThis_t _tdefinition_t _tmade_t _tit_t _tdifficult_t _tto_t _tdefine_t _tan_t _tevent_t _twhose_t _tassignment_t _tformulas_t _twere_t _tmeant_t _tto_t _tbe_t _tevaluated_t _tat_t _tthe_t _ttime_t _tthe_t _tevent_t _twas_t <_tem_t>_texecuted_t</_tem_t> (_ti_t._te_t., _tafter_t _tthe_t _ttime_t _tperiod_t _tdefined_t _tby_t _tthe_t _tvalue_t _tof_t _tthe_t _tDelay_t _telement_t, _tor_t _tafter_t _tany_t _tother_t _tsimultaneous_t _tevent_t _tmay_t _thave_t _tbeen_t <_tem_t>_texecuted_t</_tem_t> _tand_t _tchanged_t _tthe_t _tmodel_t _tstate_t). _tIn_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t4_t, _tthe_t _tattribute_t "_tuseValuesFromTriggerTime_t" _ton_t _tEvent_t _tallows_t _ta_t _tmodel_t _tto_t _tindicate_t _tthe_t _ttime_t _tat_t _twhich_t _tthe_t _tevent_t'_ts_t _tassignments_t _tare_t _tintended_t _tto_t _tbe_t _tevaluated_t. _tIn_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t, _tthe_t _tattribute_t _thas_t _ta_t _tdefault_t _tvalue_t _tof_t @_tc_t _ttrue_t, _twhich_t _tcorresponds_t _tto_t _tthe_t _tinterpretation_t _tof_t _tevent_t _tassignments_t _tprior_t _tto_t _tVersion_t&_tnbsp_t;_t4_t: _tthe_t _tvalues_t _tof_t _tthe_t _tassignment_t _tformulas_t _tare_t _tcomputed_t _tat_t _tthe_t _tmoment_t _tthe_t _tevent_t _tis_t _ttriggered_t, _tnot_t _tafter_t _tthe_t _tdelay_t. _tIf_t "_tuseValuesFromTriggerTime_t"=@_tc_t _tfalse_t, _tit_t _tmeans_t _tthat_t _tthe_t _tformulas_t _tin_t _tthe_t _tevent_t'_ts_t _tassignments_t _tare_t _tto_t _tbe_t _tcomputed_t _tafter_t _tthe_t _tdelay_t, _tat_t _tthe_t _ttime_t _tthe_t _tevent_t _tis_t _texecuted_t. _tIn_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t, _tthe_t _tattribute_t _tis_t _tmandatory_t, _tnot_t _toptional_t, _tand_t _tall_t _tevents_t _tmust_t _tspecify_t _ta_t _tvalue_t _tfor_t _tit_t.

_tCreates_t _ta_t _tnew_t _tEvent_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 _tEvent_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 _tEvent_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tEvent_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tEvent_t_t

@_tclass_t _tdoc_warning_event_timeUnits_t

@_tcond_t _tdoxygenIgnored_t

◆ Event_createDelay()

Delay_t * Event_createDelay ( Event_t e)

_tCreates_t _ta_t _tnew_t, _tempty_t _tDelay_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthis_t _tEvent_t_t, _tand_t _treturns_t _tthe_t _tDelay_t_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tdelay_t _tshould_t _tbe_t _tadded_t.

@_tmemberof_t _tEvent_t_t

◆ Event_createEventAssignment()

EventAssignment_t * Event_createEventAssignment ( Event_t e)

_tCreates_t _ta_t _tnew_t, _tempty_t _tEventAssignment_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthis_t _tEvent_t_t'_ts_t _tlist_t _tof_t _tevent_t _tassignments_t, _tand_t _treturns_t _tthe_t _tEventAssignment_t_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tevent_t _tassignment_t _tshould_t _tbe_t _tadded_t.

@_tmemberof_t _tEvent_t_t

◆ Event_createPriority()

Priority_t * Event_createPriority ( Event_t e)

_tCreates_t _ta_t _tnew_t, _tempty_t _tPriority_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthis_t _tEvent_t_t, _tand_t _treturns_t _tthe_t _tPriority_t_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _twhich_t _tthe_t _tpriority_t _tshould_t _tbe_t _tadded_t.

@_tmemberof_t _tEvent_t_t

◆ Event_createTrigger()

Trigger_t * Event_createTrigger ( Event_t e)

_tCreates_t _ta_t _tnew_t, _tempty_t _tTrigger_t_t _tstructure_t, _tadds_t _tit_t _tto_t _tthis_t _tEvent_t_t, _tand_t _treturns_t _tthe_t _tTrigger_t_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _twhich_t _tthe_t _ttrigger_t _tshould_t _tbe_t _tadded_t.

@_tmemberof_t _tEvent_t_t

◆ Event_createWithNS()

Event_t * Event_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tEvent_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 _tthe_t _tgiven_t _tEvent_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tEvent_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tEvent_t_t

◆ Event_free()

void Event_free ( Event_t e)

_tFrees_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tfree_t.

@_tmemberof_t _tEvent_t_t

◆ Event_getDelay()

Delay_t * Event_getDelay ( Event_t e)

_tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tits_t _tDelay_t_t _tstructure_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _twhose_t _tdelay_t _tdefinition_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tDelay_t_t _tof_t _tthe_t _tgiven_t _tEvent_t_t.

@_tmemberof_t _tEvent_t_t

◆ Event_getEventAssignment()

EventAssignment_t * Event_getEventAssignment ( Event_t e,
unsigned int  n 
)

_tReturn_t _ta_t _tspecific_t _tEventAssignment_t_t _tstructure_t _tof_t _tthe_t _tgiven_t _tEvent_t_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tn_t _tan_t _tinteger_t, _tthe_t _tindex_t _tof_t _tthe_t _tEventAssignment_t_t _tstructure_t _tto_t _treturn_t.

@_treturn_t _tthe_t _tnth_t _tEventAssignment_t_t _tof_t _tthe_t _tgiven_t _tEvent_t_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tEventAssignment_t_t _texists_t.

@_tmemberof_t _tEvent_t_t

◆ Event_getEventAssignmentByVar()

EventAssignment_t * Event_getEventAssignmentByVar ( Event_t e,
const char *  variable 
)

_tReturn_t _tthe_t _tevent_t _tassignment_t _tindicated_t _tby_t _tthe_t _tgiven_t @_tp_t _tvariable_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tvariable_t _ta_t _tstring_t, _tthe_t _tidentifier_t _tof_t _tthe_t _tvariable_t _twhose_t _tEventAssignment_t_t _tis_t _tbeing_t _tsought_t.

@_treturn_t _tthe_t _tEventAssignment_t_t _tfor_t _tthe_t _tgiven_t _tvariable_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tEventAssignment_t_t _texists_t.

@_tmemberof_t _tEvent_t_t

◆ Event_getId()

const char * Event_getId ( const Event_t e)

_tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _twhose_t _tidentifier_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tidentifier_t _tof_t _tthe_t _tgiven_t _tEvent_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tEvent_t_t

◆ Event_getListOfEventAssignments()

ListOf_t * Event_getListOfEventAssignments ( Event_t e)

_tGet_t _tthe_t _tlist_t _tof_t _tEventAssignment_t_t _tstructures_t _tfrom_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t _tlist_t _tof_t _tEventAssignments_t _tfor_t _tthe_t _tgiven_t _tEvent_t_t.

@_tmemberof_t _tEvent_t_t

◆ Event_getName()

const char * Event_getName ( const Event_t e)

_tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _twhose_t _tname_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tname_t _tof_t _tthe_t _tgiven_t _tEvent_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tEvent_t_t

◆ Event_getNamespaces()

const XMLNamespaces_t * Event_getNamespaces ( Event_t e)

_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.

@_tparam_t _te_t _tthe_t _tEvent_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 _tEvent_t_t

◆ Event_getNumEventAssignments()

unsigned int Event_getNumEventAssignments ( const Event_t e)

_tReturns_t _tthe_t _tnumber_t _tof_t _tEventAssignment_t_t _tstructures_t _tattached_t _tto_t _tthe_t _tgiven_t _tEvent_t_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tuse_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _tEventAssignment_t_t _tstructures_t _tin_t _tthe_t _tgiven_t _tEvent_t_t.

@_tmemberof_t _tEvent_t_t

◆ Event_getPriority()

Priority_t * Event_getPriority ( Event_t e)

_tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tits_t _tPriority_t_t _tstructure_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _twhose_t _tdelay_t _tdefinition_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tPriority_t_t _tof_t _tthe_t _tgiven_t _tEvent_t_t.

@_tmemberof_t _tEvent_t_t

◆ Event_getTimeUnits()

const char * Event_getTimeUnits ( const Event_t e)

_tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tthe_t _tvalue_t _tof_t _tits_t "_ttimeUnits_t" _tattribute_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _twhose_t "_ttimeUnits_t" _tvalue_t _tis_t _tsought_t.

@_treturn_t _tthe_t _ttimeUnits_t _tof_t _tthe_t _tgiven_t _tEvent_t_t

@_twarning_t _tDefinitions_t _tof_t _tEvent_t_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersions_t _t1_t _tand_t _t2_t _tincluded_t _tthe_t _tadditional_t _tattribute_t _tcalled_t "_ttimeUnits_t", _tbut_t _tit_t _twas_t _tremoved_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t3_t. _tLibSBML_t _tsupports_t _tthis_t _tattribute_t _tfor_t _tcompatibility_t _twith_t _tprevious_t _tversions_t _tof_t _tSBML_t _tLevel_t _t2_t, _tbut_t _tits_t _tuse_t _tis_t _tdiscouraged_t _tsince_t _tmodels_t _tin_t _tLevel_t _t2_t _tVersions_t _t3_t _tand_t _t4_t _tcannot_t _tcontain_t _tit_t.

@_tmemberof_t _tEvent_t_t

◆ Event_getTrigger()

Trigger_t * Event_getTrigger ( Event_t e)

_tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tits_t _tTrigger_t_t _tstructure_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _twhose_t _ttrigger_t _tdefinition_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tTrigger_t_t _tof_t _tthe_t _tgiven_t _tEvent_t_t.

@_tmemberof_t _tEvent_t_t

◆ Event_getUseValuesFromTriggerTime()

int Event_getUseValuesFromTriggerTime ( const Event_t e)

_tTakes_t _tan_t _tEvent_t_t _tstructure_t _tand_t _treturns_t _tthe_t _tvalue_t _tof_t _tits_t "_tuseValuesFromTriggerTime_t" _tattribute_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _twhose_t "_tuseValuesFromTriggerTime_t" _tvalue_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tuseValuesFromTriggerTime_t _tof_t _tthe_t _tgiven_t _tEvent_t_t

@_tmemberof_t _tEvent_t_t

◆ Event_hasRequiredAttributes()

int Event_hasRequiredAttributes ( Event_t e)

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

_tThe_t _trequired_t _tattributes_t _tfor_t _tan_t _tEvent_t_t _tstructure_t _tare_t: @_tli_t _tuseValuesfromTriggerTime_t ( _tL3_t _tonwards_t )

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _trequired_t _tattributes_t _thave_t _tbeen_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tEvent_t_t

◆ Event_hasRequiredElements()

int Event_hasRequiredElements ( Event_t e)

_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 _telements_t _tfor_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tnote_t _tThe_t _trequired_t _telements_t _tfor_t _tan_t _tEvent_t_t _tstructure_t _tare_t: @_tli_t "_ttrigger_t" (_trequired_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tand_t _tLevel_t&_tnbsp_t;_t3_t _tVersion_t&_tnbsp_t;_t1_t; _toptional_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t _tVersion_t&_tnbsp_t;_t2_t+ @_tli_t "_tlistOfEventAssignments_t" (_trequired_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t; _toptional_t _tin_t _tLevel_t&_tnbsp_t;_t3_t)

@_tmemberof_t _tEvent_t_t

◆ Event_isSetDelay()

int Event_isSetDelay ( const Event_t e)

_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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t _tdelay_t _tis_t _tset_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _ta_t _tDelay_t_t _tstructure_t _tis_t _tassigned_t _tto_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tEvent_t_t

◆ Event_isSetId()

int Event_isSetId ( const Event_t e)

_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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t _tidentifier_t _tis_t _tset_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tEvent_t_t

◆ Event_isSetName()

int Event_isSetName ( const Event_t e)

_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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t _tname_t _tis_t _tset_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tEvent_t_t

◆ Event_isSetPriority()

int Event_isSetPriority ( const Event_t e)

_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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t _tpriority_t _tis_t _tset_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _ta_t _tPriority_t_t _tstructure_t _tis_t _tassigned_t _tto_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tEvent_t_t

◆ Event_isSetTimeUnits()

int Event_isSetTimeUnits ( const Event_t e)

_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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t "_ttimeUnits_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _ta_t _tvalue_t _tfor_t _tthe_t "_ttimeUnits_t" _tattribute_t _tis_t _tassigned_t _tin_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_twarning_t _tDefinitions_t _tof_t _tEvent_t_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersions_t _t1_t _tand_t _t2_t _tincluded_t _tthe_t _tadditional_t _tattribute_t _tcalled_t "_ttimeUnits_t", _tbut_t _tit_t _twas_t _tremoved_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t3_t. _tLibSBML_t _tsupports_t _tthis_t _tattribute_t _tfor_t _tcompatibility_t _twith_t _tprevious_t _tversions_t _tof_t _tSBML_t _tLevel_t _t2_t, _tbut_t _tits_t _tuse_t _tis_t _tdiscouraged_t _tsince_t _tmodels_t _tin_t _tLevel_t _t2_t _tVersions_t _t3_t _tand_t _t4_t _tcannot_t _tcontain_t _tit_t.

@_tmemberof_t _tEvent_t_t

◆ Event_isSetTrigger()

int Event_isSetTrigger ( const Event_t e)

_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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t _ttrigger_t _tis_t _tset_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _ta_t _tTrigger_t_t _tstructure_t _tis_t _tassigned_t _tto_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tEvent_t_t

◆ Event_isSetUseValuesFromTriggerTime()

int Event_isSetUseValuesFromTriggerTime ( const Event_t e)

_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 _tgiven_t _tEvent_t_t _tstructure_t'_ts_t _tuseValuesFromTriggerTime_t _tattribute_t _tis_t _tset_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tEvent_t_t

◆ Event_removeEventAssignment()

EventAssignment_t * Event_removeEventAssignment ( Event_t e,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tEventAssignment_t_t _tstructure_t _tfrom_t _tthe_t _tgiven_t _tEvent_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.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t. @_tparam_t _tn_t _tthe_t _tinteger_t _tindex_t _tof_t _tthe_t _tEventAssignment_t_t _tsought_t.

@_treturn_t _tthe_t _tEventAssignment_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 _tEvent_t_t

◆ Event_removeEventAssignmentByVar()

EventAssignment_t * Event_removeEventAssignmentByVar ( Event_t e,
const char *  variable 
)

_tRemoves_t _tthe_t _tEventAssignment_t_t _tstructure_t _twith_t _tthe_t _tgiven_t "_tvariable_t" _tattribute_t _tfrom_t _tthe_t _tgiven_t _tEvent_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.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t. @_tparam_t _tvariable_t _tthe_t _tstring_t _tof_t _tthe_t "_tvariable_t" _tattribute_t _tof_t _tthe_t _tEventAssignment_t_t _tsought_t.

@_treturn_t _tthe_t _tEventAssignment_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 _tEventAssignment_t_t _tstructure_t _twith_t _tthe_t "_tvariable_t" _tattribute_t _texists_t _tin_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.

@_tmemberof_t _tEvent_t_t

◆ Event_setDelay()

int Event_setDelay ( Event_t e,
const Delay_t delay 
)

_tSets_t _tthe_t _tdelay_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tDelay_t_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tdelay_t _tthe_t _tDelay_t_t _tstructure_t _tto_t _tuse_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}

@_tmemberof_t _tEvent_t_t

◆ Event_setId()

int Event_setId ( Event_t e,
const char *  sid 
)

_tAssigns_t _tthe_t _tidentifier_t _tof_t _tan_t _tEvent_t_t _tstructure_t.

_tThis_t _tmakes_t _ta_t _tcopy_t _tof_t _tthe_t _tstring_t _tpassed_t _tin_t _tthe_t _tparameter_t @_tp_t _tsid_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tsid_t _tthe_t _tstring_t _tto_t _tuse_t _tas_t _tthe_t _tidentifier_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 "_tid_t" _tattribute_t.

@_tmemberof_t _tEvent_t_t

◆ Event_setName()

int Event_setName ( Event_t e,
const char *  name 
)

_tSets_t _tthe_t _tname_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tname_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tname_t _tthe_t _tname_t _tto_t _tassign_t _tto_t _tthe_t _tgiven_t _tEvent_t_t'_ts_t "_tname_t" _tattribute_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 _tthe_t _tname_t _tset_t _tto_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tname_t" _tattribute_t.

@_tmemberof_t _tEvent_t_t

◆ Event_setPriority()

int Event_setPriority ( Event_t e,
const Priority_t priority 
)

_tSets_t _tthe_t _tpriority_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tPriority_t_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tpriority_t _tthe_t _tPriority_t_t _tstructure_t _tto_t _tuse_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_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tEvent_t_t

◆ Event_setTimeUnits()

int Event_setTimeUnits ( Event_t e,
const char *  sid 
)

_tSets_t _tthe_t "_ttimeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tsid_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tsid_t _tthe_t _tidentifier_t _tof_t _tthe_t _tunits_t _tto_t _tuse_t _tas_t _tthe_t _tvalue_t _tof_t _tthe_t "_ttimeUnits_t" _tattribute_t.

@_twarning_t _tDefinitions_t _tof_t _tEvent_t_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersions_t _t1_t _tand_t _t2_t _tincluded_t _tthe_t _tadditional_t _tattribute_t _tcalled_t "_ttimeUnits_t", _tbut_t _tit_t _twas_t _tremoved_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t3_t. _tLibSBML_t _tsupports_t _tthis_t _tattribute_t _tfor_t _tcompatibility_t _twith_t _tprevious_t _tversions_t _tof_t _tSBML_t _tLevel_t _t2_t, _tbut_t _tits_t _tuse_t _tis_t _tdiscouraged_t _tsince_t _tmodels_t _tin_t _tLevel_t _t2_t _tVersions_t _t3_t _tand_t _t4_t _tcannot_t _tcontain_t _tit_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.

@_tmemberof_t _tEvent_t_t

◆ Event_setTrigger()

int Event_setTrigger ( Event_t e,
const Trigger_t trigger 
)

_tSets_t _tthe_t _ttrigger_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tTrigger_t_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _ttrigger_t _tthe_t _tTrigger_t_t _tstructure_t _tto_t _tuse_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}

@_tmemberof_t _tEvent_t_t

◆ Event_setUseValuesFromTriggerTime()

int Event_setUseValuesFromTriggerTime ( Event_t e,
int  value 
)

_tSets_t _tthe_t "_tuseValuesFromTriggerTime_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tto_t _ta_t @_tp_t _tvalue_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tvalue_t _tthe_t _tvalue_t _tof_t _tthe_t "_tuseValuesFromTriggerTime_t" _tattribute_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}

@_tmemberof_t _tEvent_t_t

◆ Event_unsetDelay()

int Event_unsetDelay ( Event_t e)

_tUnsets_t _tthe_t _tdelay_t _tof_t _tthe_t _tgiven_t _tEvent_t_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tunset_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}

@_tmemberof_t _tEvent_t_t

◆ Event_unsetId()

int Event_unsetId ( Event_t e)

_tUnsets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tunset_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}

@_tmemberof_t _tEvent_t_t

◆ Event_unsetName()

int Event_unsetName ( Event_t e)

_tUnsets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tunset_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}

@_tmemberof_t _tEvent_t_t

◆ Event_unsetPriority()

int Event_unsetPriority ( Event_t e)

_tUnsets_t _tthe_t _tpriority_t _tof_t _tthe_t _tgiven_t _tEvent_t_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tunset_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}

@_tmemberof_t _tEvent_t_t

◆ Event_unsetTimeUnits()

int Event_unsetTimeUnits ( Event_t e)

_tUnsets_t _tthe_t "_ttimeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tEvent_t_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tunset_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 _tDefinitions_t _tof_t _tEvent_t_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersions_t _t1_t _tand_t _t2_t _tincluded_t _tthe_t _tadditional_t _tattribute_t _tcalled_t "_ttimeUnits_t", _tbut_t _tit_t _twas_t _tremoved_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t _t3_t. _tLibSBML_t _tsupports_t _tthis_t _tattribute_t _tfor_t _tcompatibility_t _twith_t _tprevious_t _tversions_t _tof_t _tSBML_t _tLevel_t _t2_t, _tbut_t _tits_t _tuse_t _tis_t _tdiscouraged_t _tsince_t _tmodels_t _tin_t _tLevel_t _t2_t _tVersions_t _t3_t _tand_t _t4_t _tcannot_t _tcontain_t _tit_t.

@_tmemberof_t _tEvent_t_t

◆ Event_unsetUseValuesFromTriggerTime()

int Event_unsetUseValuesFromTriggerTime ( Event_t e)

_tUnsets_t _tthe_t "_tuseValuesFromTriggerTime_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tEvent_t_t _tstructure_t.

@_tparam_t _te_t _tthe_t _tEvent_t_t _tstructure_t _tto_t _tunset_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}

@_tmemberof_t _tEvent_t_t

◆ ListOfEvents_getById()

Event_t * ListOfEvents_getById ( ListOf_t lo,
const char *  sid 
)

_tReturns_t _tthe_t _tEvent_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.

@_tparam_t _tlo_t _tthe_t _tListOfEvents_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 _tListOfEvents_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 _tListOfEvents_t_t

◆ ListOfEvents_removeById()

Event_t * ListOfEvents_removeById ( ListOf_t lo,
const char *  sid 
)

_tRemoves_t _ta_t _tEvent_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 _tEvent_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 _tEvent_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 _tListOfEvents_t_t