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

Definition of Trigger_t. More...

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

Functions

Trigger_tTrigger_clone (const Trigger_t *t)
 @_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tTrigger_t_t.
 
Trigger_tTrigger_create (unsigned int level, unsigned int version)
 _tCreates_t _ta_t _tnew_t _tTrigger_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t _tvalues_t.
 
Trigger_tTrigger_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tTrigger_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
 
void Trigger_free (Trigger_t *t)
 _tFrees_t _tthe_t _tgiven_t _tTrigger_t_t.
 
int Trigger_getInitialValue (const Trigger_t *t)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tinitialValue_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t.
 
const ASTNode_tTrigger_getMath (const Trigger_t *t)
 @_treturn_t _tthe_t _tmath_t _tof_t _tthis_t _tTrigger_t_t.
 
const XMLNamespaces_tTrigger_getNamespaces (Trigger_t *t)
 _tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tTrigger_t_t _tstructure_t.
 
int Trigger_getPersistent (const Trigger_t *t)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tpersistent_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t.
 
int Trigger_hasRequiredAttributes (Trigger_t *t)
 _tPredicate_t _treturning_t @_tc_t _ttrue_t _tor_t @_tc_t _tfalse_t _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tTrigger_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int Trigger_hasRequiredElements (Trigger_t *t)
 _tPredicate_t _treturning_t @_tc_t _ttrue_t _tor_t @_tc_t _tfalse_t _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _telements_t _tfor_t _tthis_t _tTrigger_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int Trigger_isSetInitialValue (const Trigger_t *t)
 _tReturn_t @_tc_t _ttrue_t _tif_t _tthe_t "_tinitialValue_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t _tis_t _tset_t.
 
int Trigger_isSetMath (const Trigger_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 _tTrigger_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.
 
int Trigger_isSetPersistent (const Trigger_t *t)
 _tReturn_t @_tc_t _ttrue_t _tif_t _tthe_t "_tpersistent_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t _tis_t _tset_t.
 
int Trigger_setInitialValue (Trigger_t *t, int initialValue)
 _tSets_t _tthe_t "_tinitialValue_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t _tinstance_t.
 
int Trigger_setMath (Trigger_t *t, const ASTNode_t *math)
 _tSets_t _tthe_t _tmath_t _tof_t _tthis_t _tTrigger_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tASTNode_t_t.
 
int Trigger_setPersistent (Trigger_t *t, int persistent)
 _tSets_t _tthe_t "_tpersistent_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t _tinstance_t.
 
int Trigger_unsetInitialValue (Trigger_t *t)
 _tUnsets_t _tthe_t "_tinitialValue_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t _tinstance_t.
 
int Trigger_unsetPersistent (Trigger_t *t)
 _tUnsets_t _tthe_t "_tpersistent_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t _tinstance_t.
 

Detailed Description

Definition of Trigger_t.

Author
Sarah Keating

Function Documentation

◆ Trigger_clone()

Trigger_t * Trigger_clone ( const Trigger_t t)

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tTrigger_t_t.

@_tmemberof_t _tTrigger_t_t

◆ Trigger_create()

Trigger_t * Trigger_create ( unsigned int  level,
unsigned int  version 
)

_tCreates_t _ta_t _tnew_t _tTrigger_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 _tTrigger_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 _tTrigger_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tTrigger_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tTrigger_t_t

_tCreates_t _ta_t _tnew_t _tTrigger_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

◆ Trigger_createWithNS()

Trigger_t * Trigger_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tTrigger_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 _tTrigger_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tTrigger_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tTrigger_t_t

◆ Trigger_free()

void Trigger_free ( Trigger_t t)

_tFrees_t _tthe_t _tgiven_t _tTrigger_t_t.

@_tmemberof_t _tTrigger_t_t

◆ Trigger_getInitialValue()

int Trigger_getInitialValue ( const Trigger_t t)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tinitialValue_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t.

@_tparam_t _tt_t _tthe_t _tTrigger_t_t _tstructure_t.

@_treturn_t _tthe_t "_tinitialValue_t" _tattribute_t _tvalue_t _tin_t _tthis_t _tTrigger_t_t.

@_tmemberof_t _tTrigger_t_t

◆ Trigger_getMath()

const ASTNode_t * Trigger_getMath ( const Trigger_t t)

@_treturn_t _tthe_t _tmath_t _tof_t _tthis_t _tTrigger_t_t.

@_tmemberof_t _tTrigger_t_t

◆ Trigger_getNamespaces()

const XMLNamespaces_t * Trigger_getNamespaces ( Trigger_t t)

_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tTrigger_t_t _tstructure_t.

@_tparam_t _tt_t _tthe_t _tTrigger_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 _tTrigger_t_t

◆ Trigger_getPersistent()

int Trigger_getPersistent ( const Trigger_t t)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tpersistent_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t.

@_tparam_t _tt_t _tthe_t _tTrigger_t_t _tstructure_t.

@_treturn_t _tthe_t "_tpersistent_t" _tattribute_t _tvalue_t _tin_t _tthis_t _tTrigger_t_t.

@_tmemberof_t _tTrigger_t_t

◆ Trigger_hasRequiredAttributes()

int Trigger_hasRequiredAttributes ( Trigger_t t)

_tPredicate_t _treturning_t @_tc_t _ttrue_t _tor_t @_tc_t _tfalse_t _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tTrigger_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

_tThe_t _trequired_t _tattributes_t _tfor_t _ta_t _tTrigger_t_t _tstructure_t _tare_t: @_tli_t _tpersistent_t ( _tL3_t _tonwards_t ) @_tli_t _tinitialValue_t ( _tL3_t _tonwards_t )

@_tmemberof_t _tTrigger_t_t

◆ Trigger_hasRequiredElements()

int Trigger_hasRequiredElements ( Trigger_t t)

_tPredicate_t _treturning_t @_tc_t _ttrue_t _tor_t @_tc_t _tfalse_t _tdepending_t _ton_t _twhether_t _tall_t _tthe_t _trequired_t _telements_t _tfor_t _tthis_t _tTrigger_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tnote_t _tThe_t _trequired_t _telements_t _tfor_t _ta_t _tTrigger_t_t _tstructure_t _tare_t: @_tli_t _tmath_t

@_tmemberof_t _tTrigger_t_t

◆ Trigger_isSetInitialValue()

int Trigger_isSetInitialValue ( const Trigger_t t)

_tReturn_t @_tc_t _ttrue_t _tif_t _tthe_t "_tinitialValue_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t _tis_t _tset_t.

@_tparam_t _tt_t _tthe_t _tTrigger_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tinitialValue_t" _tattribute_t _tvalue_t _tin_t _tthis_t _tTrigger_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tTrigger_t_t

◆ Trigger_isSetMath()

int Trigger_isSetMath ( const Trigger_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 _tTrigger_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tTrigger_t_t

◆ Trigger_isSetPersistent()

int Trigger_isSetPersistent ( const Trigger_t t)

_tReturn_t @_tc_t _ttrue_t _tif_t _tthe_t "_tpersistent_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t _tis_t _tset_t.

@_tparam_t _tt_t _tthe_t _tTrigger_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tpersisent_t" _tattribute_t _tvalue_t _tin_t _tthis_t _tTrigger_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tTrigger_t_t

◆ Trigger_setInitialValue()

int Trigger_setInitialValue ( Trigger_t t,
int  initialValue 
)

_tSets_t _tthe_t "_tinitialValue_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t _tinstance_t.

@_tparam_t _tt_t _tthe_t _tTrigger_t_t _tstructure_t. @_tparam_t _tinitialValue_t _tan_t _tinteger_t _trepresenting_t _tthe_t _tinitialValue_t _tto_t _tbe_t _tset_t, _twith_t @_tc_t _tnonzero_t _tindicating_t @_tc_t _ttrue_t, _tand_t @_tc_t _tzero_t _tindicating_t @_tc_t _tfalse_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 _tTrigger_t_t

◆ Trigger_setMath()

int Trigger_setMath ( Trigger_t t,
const ASTNode_t math 
)

_tSets_t _tthe_t _tmath_t _tof_t _tthis_t _tTrigger_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 _tTrigger_t_t

◆ Trigger_setPersistent()

int Trigger_setPersistent ( Trigger_t t,
int  persistent 
)

_tSets_t _tthe_t "_tpersistent_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t _tinstance_t.

@_tparam_t _tt_t _tthe_t _tTrigger_t_t _tstructure_t. @_tparam_t _tpersistent_t _tan_t _tinteger_t _trepresenting_t _tthe_t _tinitialValue_t _tto_t _tbe_t _tset_t, _twith_t @_tc_t _tnonzero_t _tindicating_t @_tc_t _ttrue_t, _tand_t @_tc_t _tzero_t _tindicating_t @_tc_t _tfalse_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 _tTrigger_t_t

◆ Trigger_unsetInitialValue()

int Trigger_unsetInitialValue ( Trigger_t t)

_tUnsets_t _tthe_t "_tinitialValue_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t _tinstance_t.

@_tparam_t _tt_t _tthe_t _tTrigger_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}

@_tmemberof_t _tTrigger_t_t

◆ Trigger_unsetPersistent()

int Trigger_unsetPersistent ( Trigger_t t)

_tUnsets_t _tthe_t "_tpersistent_t" _tattribute_t _tof_t _tthis_t _tTrigger_t_t _tinstance_t.

@_tparam_t _tt_t _tthe_t _tTrigger_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}

@_tmemberof_t _tTrigger_t_t