libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
Input.cpp File Reference

Implementation of the Input_t class. More...

Include dependency graph for Input.cpp:

Functions

Input_tInput_clone (Input_t *i)
 _tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.
 
Input_tInput_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
 @_tcond_t _tdoxygenIgnored_t
 
void Input_free (Input_t *i)
 _tFrees_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.
 
char * Input_getId (Input_t *i)
 _tTakes_t _tan_t _tInput_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.
 
char * Input_getName (Input_t *i)
 _tTakes_t _ta_t _tInput_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.
 
char * Input_getQualitativeSpecies (Input_t *i)
 _tTakes_t _ta_t _tInput_t_t _tstructure_t _tand_t _treturns_t _tits_t _tqualitativeSpecies_t.
 
InputSign_t Input_getSign (Input_t *i)
 _tTakes_t _ta_t _tInput_t_t _tstructure_t _tand_t _treturns_t _tits_t _tsign_t _tas_t _ta_t #_tInputSign_t_t (_tan_t _tenumerated_t _tvalue_t _tof_t _tlegal_t _tpossible_t _tvalues_t _tfor_t _tthe_t _tattribute_t).
 
int Input_getThresholdLevel (Input_t *i)
 _tTakes_t _ta_t _tInput_t_t _tstructure_t _tand_t _treturns_t _tits_t _tthresholdLevel_t.
 
InputTransitionEffect_t Input_getTransitionEffect (Input_t *i)
 _tTakes_t _ta_t _tInput_t_t _tstructure_t _tand_t _treturns_t _tits_t _ttransitionEffect_t _tas_t _ta_t #_tInputTransitionEffect_t_t (_tan_t _tenumerated_t _tvalue_t _tof_t _tlegal_t _tpossible_t _tvalues_t _tfor_t _tthe_t _tattribute_t).
 
int Input_hasRequiredAttributes (Input_t *i)
 _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 _tInput_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
int Input_isSetId (Input_t *i)
 _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 _tInput_t_t _tstructure_t'_ts_t _tidentifier_t _tis_t _tset_t.
 
int Input_isSetName (Input_t *i)
 _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 _tInput_t_t _tstructure_t'_ts_t _tname_t _tis_t _tset_t.
 
int Input_isSetQualitativeSpecies (Input_t *i)
 _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 _tInput_t_t _tstructure_t'_ts_t _tqualitativeSpecies_t _tis_t _tset_t.
 
int Input_isSetSign (Input_t *i)
 _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 _tInput_t_t _tstructure_t'_ts_t _tsign_t _tis_t _tset_t.
 
int Input_isSetThresholdLevel (Input_t *i)
 _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 _tInput_t_t _tstructure_t'_ts_t _tthresholdLevel_t _tis_t _tset_t.
 
int Input_isSetTransitionEffect (Input_t *i)
 _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 _tInput_t_t _tstructure_t'_ts_t _ttransitionEffect_t _tis_t _tset_t.
 
int Input_setId (Input_t *i, const char *id)
 _tAssigns_t _tthe_t _tidentifier_t _tof_t _tan_t _tInput_t_t _tstructure_t.
 
int Input_setName (Input_t *i, const char *name)
 _tSets_t _tthe_t _tname_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tname_t.
 
int Input_setQualitativeSpecies (Input_t *i, const char *qualitativeSpecies)
 _tSets_t _tthe_t _tqualitativeSpecies_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tqualitativeSpecies_t.
 
int Input_setSign (Input_t *i, InputSign_t sign)
 _tSets_t _tthe_t _tsign_t _tof_t _tthis_t _tInput_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t #_tInputSign_t_t.
 
int Input_setThresholdLevel (Input_t *i, int thresholdLevel)
 _tSets_t _tthe_t "_tthresholdLevel_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.
 
int Input_setTransitionEffect (Input_t *i, InputTransitionEffect_t transitionEffect)
 _tSets_t _tthe_t _ttransitionEffect_t _tof_t _tthis_t _tInput_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t #_tInputTransitionEffect_t_t.
 
int Input_unsetId (Input_t *i)
 _tUnsets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.
 
int Input_unsetName (Input_t *i)
 _tUnsets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.
 
int Input_unsetQualitativeSpecies (Input_t *i)
 _tUnsets_t _tthe_t "_tqualitativeSpecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.
 
int Input_unsetSign (Input_t *i)
 _tUnsets_t _tthe_t "_tsign_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.
 
int Input_unsetThresholdLevel (Input_t *i)
 _tUnsets_t _tthe_t "_tthresholdLevel_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.
 
int Input_unsetTransitionEffect (Input_t *i)
 _tUnsets_t _tthe_t "_ttransitionEffect_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.
 
InputSign_t InputSign_fromString (const char *s)
 _tReturns_t _tthe_t #_tInputSign_t_t _tenumeration_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tstring_t, _tor_t @_tsbmlconstant_t{_tINPUT_SIGN_VALUE_NOTSET_t, _tInputSign_t_t} _tif_t _tthere_t _tis_t _tno_t _tsuch_t _tmatch_t.
 
int InputSign_isValidInputSign (InputSign_t effect)
 _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 #_tInputSign_t_t _tis_t _tvalid_t.
 
int InputSign_isValidInputSignString (const char *s)
 _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 _tstring_t _tis_t _ta_t _tvalid_t #_tInputSign_t_t.
 
const char * InputSign_toString (InputSign_t effect)
 _tReturns_t _tthe_t _tstring_t _tversion_t _tof_t _tthe_t _tprovided_t #_tInputSign_t_t _tenumeration_t.
 
InputTransitionEffect_t InputTransitionEffect_fromString (const char *s)
 _tReturns_t _tthe_t #_tInputTransitionEffect_t_t _tenumeration_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tstring_t, _tor_t @_tsbmlconstant_t{_tINPUT_TRANSITION_EFFECT_UNKNOWN_t, _tInputTransitionEffect_t_t} _tif_t _tthere_t _tis_t _tno_t _tsuch_t _tmatch_t.
 
int InputTransitionEffect_isValidInputTransitionEffect (InputTransitionEffect_t effect)
 _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 #_tInputTransitionEffect_t_t _tis_t _tvalid_t.
 
int InputTransitionEffect_isValidInputTransitionEffectString (const char *s)
 _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 _tstring_t _tis_t _ta_t _tvalid_t #_tInputTransitionEffect_t_t.
 
const char * InputTransitionEffect_toString (InputTransitionEffect_t effect)
 _tReturns_t _tthe_t _tstring_t _tversion_t _tof_t _tthe_t _tprovided_t #_tInputTransitionEffect_t_t _tenumeration_t.
 
Input_tListOfInputs_getById (ListOf_t *lo, const char *sid)
 _tReturn_t _tthe_t _tInput_t_t _tindicated_t _tby_t _tthe_t _tgiven_t @_tp_t _tsid_t.
 
Input_tListOfInputs_removeById (ListOf_t *lo, const char *sid)
 _tRemoves_t _tthe_t _tInput_t_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tfrom_t _tthe_t _tgiven_t _tListOfInputs_t_t _tstructure_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 

Variables

static const char * INPUT_SIGN_STRINGS []
 
static const char * INPUT_TRANSITION_EFFECT_STRINGS []
 

Detailed Description

Implementation of the Input_t class.

Author
Generated by autocreate code

Function Documentation

◆ Input_clone()

Input_t * Input_clone ( Input_t i)

_tReturns_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _tstructure_t _tto_t _tcopy_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tInput_t_t.

@_tmemberof_t _tInput_t_t

◆ Input_create()

Input_t * Input_create ( unsigned int  level,
unsigned int  version,
unsigned int  pkgVersion 
)

@_tcond_t _tdoxygenIgnored_t

_tCreates_t _ta_t _tnew_t _tInput_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t, _tand_t _tthe_t @_tp_t _tpkgVersion_t _tpackage_t _tversion_t.

◆ Input_free()

void Input_free ( Input_t i)

_tFrees_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _tstructure_t _tto_t _tfree_t.

@_tmemberof_t _tInput_t_t

◆ Input_getId()

char * Input_getId ( Input_t i)

_tTakes_t _tan_t _tInput_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _tstructure_t _twhose_t _tidentifier_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tidentifier_t _tof_t _tthis_t _tInput_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tInput_t_t

◆ Input_getName()

char * Input_getName ( Input_t i)

_tTakes_t _ta_t _tInput_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _twhose_t _tname_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tname_t _tof_t _tthis_t _tInput_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tInput_t_t

◆ Input_getQualitativeSpecies()

char * Input_getQualitativeSpecies ( Input_t i)

_tTakes_t _ta_t _tInput_t_t _tstructure_t _tand_t _treturns_t _tits_t _tqualitativeSpecies_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _twhose_t _tqualitativeSpecies_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tqualitativeSpecies_t _tof_t _tthe_t _tgiven_t _tInput_t_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tInput_t_t

◆ Input_getSign()

InputSign_t Input_getSign ( Input_t i)

_tTakes_t _ta_t _tInput_t_t _tstructure_t _tand_t _treturns_t _tits_t _tsign_t _tas_t _ta_t #_tInputSign_t_t (_tan_t _tenumerated_t _tvalue_t _tof_t _tlegal_t _tpossible_t _tvalues_t _tfor_t _tthe_t _tattribute_t).

@_tparam_t _ti_t _tthe_t _tInput_t_t _twhose_t _tsign_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tsign_t _tof_t _tthe_t _tgiven_t _tInput_t_t, _tas_t _ta_t #_tInputSign_t_t

@_tmemberof_t _tInput_t_t

◆ Input_getThresholdLevel()

int Input_getThresholdLevel ( Input_t i)

_tTakes_t _ta_t _tInput_t_t _tstructure_t _tand_t _treturns_t _tits_t _tthresholdLevel_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _twhose_t _tthresholdLevel_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tthresholdLevel_t _tattribute_t _tof_t _tthe_t _tgiven_t _tInput_t_t, _tas_t _tan_t @_tc_t _tint_t.

@_tmemberof_t _tInput_t_t

◆ Input_getTransitionEffect()

InputTransitionEffect_t Input_getTransitionEffect ( Input_t i)

_tTakes_t _ta_t _tInput_t_t _tstructure_t _tand_t _treturns_t _tits_t _ttransitionEffect_t _tas_t _ta_t #_tInputTransitionEffect_t_t (_tan_t _tenumerated_t _tvalue_t _tof_t _tlegal_t _tpossible_t _tvalues_t _tfor_t _tthe_t _tattribute_t).

@_tparam_t _ti_t _tthe_t _tInput_t_t _twhose_t _ttransitionEffect_t _tis_t _tsought_t.

@_treturn_t _tthe_t _ttransitionEffect_t _tof_t _tthe_t _tgiven_t _tInput_t_t, _tas_t _ta_t #_tInputTransitionEffect_t_t

@_tmemberof_t _tInput_t_t

◆ Input_hasRequiredAttributes()

int Input_hasRequiredAttributes ( Input_t i)

_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 _tInput_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

@_tnote_t _tThe_t _trequired_t _tattributes_t _tfor_t _ta_t _tInput_t_t _tstructure_t _tare_t: @_tli_t _tqualitativeSpecies_t @_tli_t _ttransitionEffect_t

@_tmemberof_t _tInput_t_t

◆ Input_isSetId()

int Input_isSetId ( Input_t i)

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

@_tparam_t _ti_t _tthe_t _tInput_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 _tInput_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tInput_t_t

◆ Input_isSetName()

int Input_isSetName ( Input_t i)

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

@_tparam_t _ti_t _tthe_t _tInput_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 _tInput_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tInput_t_t

◆ Input_isSetQualitativeSpecies()

int Input_isSetQualitativeSpecies ( Input_t i)

_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 _tInput_t_t _tstructure_t'_ts_t _tqualitativeSpecies_t _tis_t _tset_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tInput_t_t

◆ Input_isSetSign()

int Input_isSetSign ( Input_t i)

_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 _tInput_t_t _tstructure_t'_ts_t _tsign_t _tis_t _tset_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tInput_t_t

◆ Input_isSetThresholdLevel()

int Input_isSetThresholdLevel ( Input_t i)

_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 _tInput_t_t _tstructure_t'_ts_t _tthresholdLevel_t _tis_t _tset_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tInput_t_t

◆ Input_isSetTransitionEffect()

int Input_isSetTransitionEffect ( Input_t i)

_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 _tInput_t_t _tstructure_t'_ts_t _ttransitionEffect_t _tis_t _tset_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tInput_t_t

◆ Input_setId()

int Input_setId ( Input_t i,
const char *  sid 
)

_tAssigns_t _tthe_t _tidentifier_t _tof_t _tan_t _tInput_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 _ti_t _tthe_t _tInput_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 _tInput_t_t

◆ Input_setName()

int Input_setName ( Input_t i,
const char *  name 
)

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

@_tparam_t _ti_t _tthe_t _tInput_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 _tInput_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 _tInput_t_t

◆ Input_setQualitativeSpecies()

int Input_setQualitativeSpecies ( Input_t i,
const char *  qualitativeSpecies 
)

_tSets_t _tthe_t _tqualitativeSpecies_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tto_t _ta_t _tcopy_t _tof_t @_tp_t _tqualitativeSpecies_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tqualitativeSpecies_t _tthe_t _tqualitativeSpecies_t _tto_t _tassign_t _tto_t _tthe_t _tgiven_t _tInput_t_t'_ts_t "_tqualitativeSpecies_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 "_tqualitativeSpecies_t" _tattribute_t.

@_tmemberof_t _tInput_t_t

◆ Input_setSign()

int Input_setSign ( Input_t i,
InputSign_t  sign 
)

_tSets_t _tthe_t _tsign_t _tof_t _tthis_t _tInput_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t #_tInputSign_t_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tsign_t _tthe_t #_tInputSign_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 _tInput_t_t

◆ Input_setThresholdLevel()

int Input_setThresholdLevel ( Input_t i,
int  thresholdLevel 
)

_tSets_t _tthe_t "_tthresholdLevel_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _tstructure_t.

@_tparam_t _tthresholdLevel_t _tthe_t _tvalue_t _tof_t _tthresholdLevel_t _tto_t _tassign_t _tto_t _tthe_t "_tthresholdLevel_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 _tInput_t_t

◆ Input_setTransitionEffect()

int Input_setTransitionEffect ( Input_t i,
InputTransitionEffect_t  transitionEffect 
)

_tSets_t _tthe_t _ttransitionEffect_t _tof_t _tthis_t _tInput_t_t _tto_t _ta_t _tcopy_t _tof_t _tthe_t _tgiven_t #_tInputTransitionEffect_t_t.

@_tparam_t _ti_t _tthe_t _tInput_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _ttransitionEffect_t _tthe_t #_tInputTransitionEffect_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 _tInput_t_t

◆ Input_unsetId()

int Input_unsetId ( Input_t i)

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

@_tparam_t _ti_t _tthe_t _tInput_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 _tInput_t_t

◆ Input_unsetName()

int Input_unsetName ( Input_t i)

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

@_tparam_t _ti_t _tthe_t _tInput_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 _tInput_t_t

◆ Input_unsetQualitativeSpecies()

int Input_unsetQualitativeSpecies ( Input_t i)

_tUnsets_t _tthe_t "_tqualitativeSpecies_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.

@_tparam_t _ti_t _tthe_t _tInput_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 _tInput_t_t

◆ Input_unsetSign()

int Input_unsetSign ( Input_t i)

_tUnsets_t _tthe_t "_tsign_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.

@_tparam_t _ti_t _tthe_t _tInput_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 _tInput_t_t

◆ Input_unsetThresholdLevel()

int Input_unsetThresholdLevel ( Input_t i)

_tUnsets_t _tthe_t "_tthresholdLevel_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.

@_tparam_t _ti_t _tthe_t _tInput_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 _tInput_t_t

◆ Input_unsetTransitionEffect()

int Input_unsetTransitionEffect ( Input_t i)

_tUnsets_t _tthe_t "_ttransitionEffect_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tInput_t_t _tstructure_t.

@_tparam_t _ti_t _tthe_t _tInput_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 _tInput_t_t

◆ InputSign_fromString()

InputSign_t InputSign_fromString ( const char *  s)

_tReturns_t _tthe_t #_tInputSign_t_t _tenumeration_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tstring_t, _tor_t @_tsbmlconstant_t{_tINPUT_SIGN_VALUE_NOTSET_t, _tInputSign_t_t} _tif_t _tthere_t _tis_t _tno_t _tsuch_t _tmatch_t.

_tThe_t _tmatching_t _tis_t _tcase_t-_tsensitive_t: "_tnegative_t" _twill_t _treturn_t @_tsbmlconstant_t{_tINPUT_SIGN_NEGATIVE_t, _tInputSign_t_t}, _tbut_t "_tNegative_t" _twill_t _treturn_t @_tsbmlconstant_t{_tINPUT_SIGN_VALUE_NOTSET_t, _tInputSign_t_t}.

@_tparam_t _ts_t _tthe_t _tstring_t _tto_t _tconvert_t _tto_t _tan_t #_tInputSign_t_t.

@_treturn_t _tThe_t _tcorresponding_t #_tInputSign_t_t, _tor_t @_tsbmlconstant_t{_tINPUT_SIGN_VALUE_NOTSET_t, _tInputSign_t_t} _tif_t _tno_t _tmatch_t _tfound_t.

@_tmemberof_t _tInput_t_t

◆ InputSign_isValidInputSign()

int InputSign_isValidInputSign ( InputSign_t  effect)

_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 #_tInputSign_t_t _tis_t _tvalid_t.

@_tparam_t _teffect_t _tthe_t #_tInputSign_t_t _tenumeration_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t #_tInputSign_t_t _tis_t @_tsbmlconstant_t{_tINPUT_SIGN_POSITIVE_t, _tInputSign_t_t}, @_tsbmlconstant_t{_tINPUT_SIGN_NEGATIVE_t, _tInputSign_t_t}, @_tsbmlconstant_t{_tINPUT_SIGN_DUAL_t, _tInputSign_t_t}, _tor_t @_tsbmlconstant_t{_tINPUT_SIGN_UNKNOWN_t, _tInputSign_t_t}; @_tc_t _t0_t (_tfalse_t) _totherwise_t (_tincluding_t @_tsbmlconstant_t{_tINPUT_SIGN_VALUE_NOTSET_t, _tInputSign_t_t}).

@_tmemberof_t _tInput_t_t

◆ InputSign_isValidInputSignString()

int InputSign_isValidInputSignString ( const char *  s)

_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 _tstring_t _tis_t _ta_t _tvalid_t #_tInputSign_t_t.

_tThe_t _tmatching_t _tis_t _tcase_t-_tsensitive_t: "_tnegative_t" _twill_t _treturn_t @_tc_t _t1_t (_ttrue_t), _tbut_t "_tNegative_t" _twill_t _treturn_t @_tc_t _t0_t (_tfalse_t).

@_tparam_t _ts_t _tthe_t _tstring_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tstring_t _tis_t "_tpositive_t", "_tnegative_t", "_tdual_t", _tor_t "_tunknown_t"; @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tInput_t_t

◆ InputSign_toString()

const char * InputSign_toString ( InputSign_t  effect)

_tReturns_t _tthe_t _tstring_t _tversion_t _tof_t _tthe_t _tprovided_t #_tInputSign_t_t _tenumeration_t.

@_tparam_t _teffect_t _tthe_t #_tInputSign_t_t _tenumeration_t _tto_t _tconvert_t.

@_treturn_t _tA_t _tstring_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _teffect_t: "_tpositive_t", "_tnegative_t", "_tdual_t", "_tunknown_t", _tor_t @_tc_t _tNULL_t _tif_t _tthe_t _tvalue_t _tis_t @_tsbmlconstant_t{_tINPUT_SIGN_VALUE_NOTSET_t, _tInputSign_t_t} _tor_t _tsome_t _tother_t _tinvalid_t _tenumeration_t _tvalue_t.

@_tmemberof_t _tInput_t_t

◆ InputTransitionEffect_fromString()

InputTransitionEffect_t InputTransitionEffect_fromString ( const char *  s)

_tReturns_t _tthe_t #_tInputTransitionEffect_t_t _tenumeration_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _tstring_t, _tor_t @_tsbmlconstant_t{_tINPUT_TRANSITION_EFFECT_UNKNOWN_t, _tInputTransitionEffect_t_t} _tif_t _tthere_t _tis_t _tno_t _tsuch_t _tmatch_t.

_tThe_t _tmatching_t _tis_t _tcase_t-_tsensitive_t: "_tnone_t" _twill_t _treturn_t @_tsbmlconstant_t{_tINPUT_TRANSITION_EFFECT_NONE_t, _tInputTransitionEffect_t_t}, _tbut_t "_tNONE_t" _twill_t _treturn_t @_tsbmlconstant_t{_tINPUT_TRANSITION_EFFECT_UNKNOWN_t, _tInputTransitionEffect_t_t}.

@_tparam_t _ts_t _tthe_t _tstring_t _tto_t _tconvert_t _tto_t _tan_t #_tInputTransitionEffect_t_t.

@_treturn_t _tThe_t _tcorresponding_t #_tInputTransitionEffect_t_t, _tor_t @_tsbmlconstant_t{_tINPUT_TRANSITION_EFFECT_UNKNOWN_t, _tInputTransitionEffect_t_t} _tif_t _tno_t _tmatch_t _tfound_t.

@_tmemberof_t _tInput_t_t

◆ InputTransitionEffect_isValidInputTransitionEffect()

int InputTransitionEffect_isValidInputTransitionEffect ( InputTransitionEffect_t  effect)

_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 #_tInputTransitionEffect_t_t _tis_t _tvalid_t.

@_tparam_t _teffect_t _tthe_t #_tInputTransitionEffect_t_t _tenumeration_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t #_tInputTransitionEffect_t_t _tis_t @_tsbmlconstant_t{_tINPUT_TRANSITION_EFFECT_NONE_t, _tInputTransitionEffect_t_t} _tor_t @_tsbmlconstant_t{_tINPUT_TRANSITION_EFFECT_CONSUMPTION_t, _tInputTransitionEffect_t_t}, @_tc_t _t0_t (_tfalse_t) _totherwise_t (_tincluding_t @_tsbmlconstant_t{_tINPUT_TRANSITION_EFFECT_UNKNOWN_t, _tInputTransitionEffect_t_t}).

@_tmemberof_t _tInput_t_t

◆ InputTransitionEffect_isValidInputTransitionEffectString()

int InputTransitionEffect_isValidInputTransitionEffectString ( const char *  s)

_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 _tstring_t _tis_t _ta_t _tvalid_t #_tInputTransitionEffect_t_t.

_tThe_t _tmatching_t _tis_t _tcase_t-_tsensitive_t: "_tnone_t" _twill_t _treturn_t @_tc_t _t1_t (_ttrue_t), _tbut_t "_tNONE_t" _twill_t _treturn_t @_tc_t _t0_t (_tfalse_t).

@_tparam_t _ts_t _tthe_t _tstring_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tstring_t _tis_t "_tnone_t" _tor_t "_tconsumption_t"; @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tInput_t_t

◆ InputTransitionEffect_toString()

const char * InputTransitionEffect_toString ( InputTransitionEffect_t  effect)

_tReturns_t _tthe_t _tstring_t _tversion_t _tof_t _tthe_t _tprovided_t #_tInputTransitionEffect_t_t _tenumeration_t.

@_tparam_t _teffect_t _tthe_t #_tInputTransitionEffect_t_t _tenumeration_t _tto_t _tconvert_t.

@_treturn_t _tA_t _tstring_t _tcorresponding_t _tto_t _tthe_t _tgiven_t _teffect_t: "_tnone_t", "_tconsumption_t", _tor_t @_tc_t _tNULL_t _tif_t _tthe_t _tvalue_t _tis_t @_tsbmlconstant_t{_tINPUT_TRANSITION_EFFECT_UNKNOWN_t, _tInputTransitionEffect_t_t} _tor_t _tanother_t _tinvalid_t _tenumeration_t _tvalue_t.

@_tmemberof_t _tInput_t_t

◆ ListOfInputs_getById()

Input_t * ListOfInputs_getById ( ListOf_t lo,
const char *  sid 
)

_tReturn_t _tthe_t _tInput_t_t _tindicated_t _tby_t _tthe_t _tgiven_t @_tp_t _tsid_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _tuse_t.

@_tparam_t _tsid_t _ta_t _tstring_t, _tthe_t _tidentifier_t _tof_t _tthe_t _tInput_t_t _tbeing_t _tsought_t.

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

@_tmemberof_t _tListOfInputs_t_t

◆ ListOfInputs_removeById()

Input_t * ListOfInputs_removeById ( ListOf_t lo,
const char *  sid 
)

_tRemoves_t _tthe_t _tInput_t_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tfrom_t _tthe_t _tgiven_t _tListOfInputs_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 _tlo_t _tthe_t _tListOf_t_t _tstructure_t. @_tparam_t _tsid_t _tthe_t _tstring_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tInput_t_t _tsought_t.

@_treturn_t _tthe_t _tInput_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 _tInput_t_t _tstructure_t _twith_t _tthe_t "_tid_t" _tattribute_t _texists_t _tin_t _tthe_t _tgiven_t _tListOfInputs_t_t _tstructure_t.

@_tmemberof_t _tListOfInputs_t_t

Variable Documentation

◆ INPUT_SIGN_STRINGS

const char* INPUT_SIGN_STRINGS[]
static
Initial value:
=
{
"positive"
, "negative"
, "dual"
, "unknown"
, "NOT SET"
}

◆ INPUT_TRANSITION_EFFECT_STRINGS

const char* INPUT_TRANSITION_EFFECT_STRINGS[]
static
Initial value:
=
{
"none"
, "consumption"
, "unknown"
}