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

Definitions of Parameter_t and ListOfParameters_t. More...

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

Functions

Parameter_tListOfParameters_getById (ListOf_t *lo, const char *sid)
 _tReturns_t _tthe_t _tParameter_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.
 
Parameter_tListOfParameters_removeById (ListOf_t *lo, const char *sid)
 _tRemoves_t _ta_t _tParameter_t_t _tstructure_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
Parameter_tParameter_clone (const Parameter_t *p)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tParameter_t_t _tstructure_t
 
Parameter_tParameter_create (unsigned int level, unsigned int version)
 @_tclass_t _tdoc_note_parameter_about_constant_t
 
Parameter_tParameter_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tParameter_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
 
void Parameter_free (Parameter_t *p)
 _tFrees_t _tthe_t _tgiven_t _tParameter_t_t _tstructure_t.
 
int Parameter_getConstant (const Parameter_t *p)
 _tTakes_t _ta_t _tParameter_t_t _tstructure_t _tand_t _treturns_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t), _tdepending_t _ton_t _tthe_t _tvalue_t _tof_t _tthe_t _tparameter_t'_ts_t "_tconstant_t" _tattribute_t.
 
UnitDefinition_tParameter_getDerivedUnitDefinition (Parameter_t *p)
 _tConstructs_t _tand_t _treturns_t _ta_t _tUnitDefinition_t_t _tstructure_t _tthat_t _texpresses_t _tthe_t _tunits_t _tof_t _tthis_t _tParameter_t_t _tstructure_t.
 
const char * Parameter_getId (const Parameter_t *p)
 _tTakes_t _ta_t _tParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.
 
const char * Parameter_getName (const Parameter_t *p)
 _tTakes_t _ta_t _tParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.
 
const XMLNamespaces_tParameter_getNamespaces (Parameter_t *p)
 _tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tParameter_t_t _tstructure_t.
 
const char * Parameter_getUnits (const Parameter_t *p)
 _tTakes_t _ta_t _tParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tunits_t.
 
double Parameter_getValue (const Parameter_t *p)
 _tTakes_t _ta_t _tParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tvalue_t.
 
int Parameter_hasRequiredAttributes (Parameter_t *p)
 _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 _tthis_t _tParameter_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
void Parameter_initDefaults (Parameter_t *p)
 _tInitializes_t _tthe_t _tattributes_t _tof_t _tthis_t _tParameter_t_t _tstructure_t _tto_t _ttheir_t _tdefaults_t.
 
int Parameter_isSetConstant (const Parameter_t *p)
 _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 _tParameter_t_t _tstructure_t'_ts_t _tconstant_t _tattribute_t _thave_t _tbeen_t _tset_t.
 
int Parameter_isSetId (const Parameter_t *p)
 _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 _tParameter_t_t _tstructure_t'_ts_t _tidentifier_t _tis_t _tset_t.
 
int Parameter_isSetName (const Parameter_t *p)
 _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 _tParameter_t_t _tstructure_t'_ts_t _tname_t _tis_t _tset_t.
 
int Parameter_isSetUnits (const Parameter_t *p)
 _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 _tParameter_t_t _tstructure_t'_ts_t _tunits_t _thave_t _tbeen_t _tset_t.
 
int Parameter_isSetValue (const Parameter_t *p)
 _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 _tParameter_t_t _tstructure_t'_ts_t _tvalue_t _tis_t _tset_t.
 
int Parameter_setConstant (Parameter_t *p, int value)
 _tAssign_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _ta_t _tParameter_t_t _tstructure_t.
 
int Parameter_setId (Parameter_t *p, const char *sid)
 _tAssigns_t _tthe_t _tidentifier_t _tof_t _ta_t _tParameter_t_t _tstructure_t.
 
int Parameter_setName (Parameter_t *p, const char *name)
 _tAssign_t _tthe_t _tname_t _tof_t _ta_t _tParameter_t_t _tstructure_t.
 
int Parameter_setUnits (Parameter_t *p, const char *units)
 _tAssign_t _tthe_t _tunits_t _tof_t _ta_t _tParameter_t_t _tstructure_t.
 
int Parameter_setValue (Parameter_t *p, double value)
 _tAssign_t _tthe_t _tvalue_t _tof_t _ta_t _tParameter_t_t _tstructure_t.
 
int Parameter_unsetConstant (Parameter_t *c)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tParameter_t_t _tstructure_t.
 
int Parameter_unsetName (Parameter_t *p)
 _tUnsets_t _tthe_t _tname_t _tof_t _tthis_t _tParameter_t_t _tstructure_t.
 
int Parameter_unsetUnits (Parameter_t *p)
 _tUnsets_t _tthe_t _tunits_t _tof_t _tthis_t _tParameter_t_t _tstructure_t.
 
int Parameter_unsetValue (Parameter_t *p)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthis_t _tParameter_t_t _tstructure_t.
 

Detailed Description

Definitions of Parameter_t and ListOfParameters_t.

Author
Ben Bornstein

Function Documentation

◆ ListOfParameters_getById()

Parameter_t * ListOfParameters_getById ( ListOf_t lo,
const char *  sid 
)

_tReturns_t _tthe_t _tParameter_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.

@_tparam_t _tlo_t _tthe_t _tListOfParameters_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 _tListOfParameters_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 _tListOfParameters_t_t

◆ ListOfParameters_removeById()

Parameter_t * ListOfParameters_removeById ( ListOf_t lo,
const char *  sid 
)

_tRemoves_t _ta_t _tParameter_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 _tParameter_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 _tParameter_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 _tListOfParameters_t_t

◆ Parameter_clone()

Parameter_t * Parameter_clone ( const Parameter_t p)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tParameter_t_t _tstructure_t

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

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

@_tmemberof_t _tParameter_t_t

◆ Parameter_create()

Parameter_t * Parameter_create ( unsigned int  level,
unsigned int  version 
)

@_tclass_t _tdoc_note_parameter_about_constant_t

@_tnote_t _tReaders_t _twho_t _tview_t _tthe_t _tdocumentation_t _tfor_t _tLocalParameter_t _tmay_t _tbe_t _tconfused_t _tabout_t _tthe_t _tpresence_t _tof_t _tthis_t _tmethod_t. _tLibSBML_t _tderives_t _tLocalParameter_t _tfrom_t _tParameter_t; _thowever_t, _tthis_t _tdoes_t _tnot_t _tprecisely_t _tmatch_t _tthe_t _tobject_t _thierarchy_t _tdefined_t _tby_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t, _twhere_t _tLocalParameter_t _tis_t _tderived_t _tdirectly_t _tfrom_t _tSBase_t _tand_t _tnot_t _tParameter_t. _tWe_t _tbelieve_t _tthis_t _tarrangement_t _tmakes_t _tit_t _teasier_t _tfor_t _tlibSBML_t _tusers_t _tto_t _tprogram_t _tapplications_t _tthat_t _twork_t _twith_t _tboth_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tand_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t, _tbut_t _tprogrammers_t _tshould_t _talso_t _tkeep_t _tin_t _tmind_t _tthis_t _tdifference_t _texists_t. _tA_t _tside_t-_teffect_t _tof_t _tlibSBML_t'_ts_t _tscheme_t _tis_t _tthat_t _tcertain_t _tmethods_t _ton_t _tLocalParameter_t _tthat_t _tare_t _tinherited_t _tfrom_t _tParameter_t _tdo_t _tnot_t _tactually_t _thave_t _trelevance_t _tto_t _tLocalParameter_t _tobjects_t. _tAn_t _texample_t _tof_t _tthis_t _tis_t _tthe_t _tmethods_t _tpertaining_t _tto_t _tParameter_t'_ts_t _tattribute_t "_tconstant_t" (_ti_t._te_t., _tisSetConstant_t(), _tsetConstant_t(), _tand_t _tgetConstant_t()).

_tCreates_t _ta_t _tnew_t _tParameter_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 _tParameter_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 _tParameter_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tParameter_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tParameter_t_t

@_tclass_t _tdoc_note_parameter_about_constant_t

@_tcond_t _tdoxygenIgnored_t

◆ Parameter_createWithNS()

Parameter_t * Parameter_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tParameter_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 _tParameter_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tParameter_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tParameter_t_t

◆ Parameter_free()

void Parameter_free ( Parameter_t p)

_tFrees_t _tthe_t _tgiven_t _tParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tParameter_t_t

◆ Parameter_getConstant()

int Parameter_getConstant ( const Parameter_t p)

_tTakes_t _ta_t _tParameter_t_t _tstructure_t _tand_t _treturns_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t), _tdepending_t _ton_t _tthe_t _tvalue_t _tof_t _tthe_t _tparameter_t'_ts_t "_tconstant_t" _tattribute_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _twhose_t _tconstant_t _tvalue_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t, _twith_t @_tc_t _tnonzero_t _tmeaning_t _ttrue_t _tand_t @_tc_t _tzero_t _tmeaning_t _tfalse_t.

@_tmemberof_t _tParameter_t_t

◆ Parameter_getDerivedUnitDefinition()

UnitDefinition_t * Parameter_getDerivedUnitDefinition ( Parameter_t p)

_tConstructs_t _tand_t _treturns_t _ta_t _tUnitDefinition_t_t _tstructure_t _tthat_t _texpresses_t _tthe_t _tunits_t _tof_t _tthis_t _tParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _twhose_t _tunits_t _tare_t _tto_t _tbe_t _treturned_t.

@_treturn_t _ta_t _tUnitDefinition_t_t _tstructure_t _tthat_t _texpresses_t _tthe_t _tunits_t _tof_t _tthis_t _tParameter_t_t _tstrucuture_t.

@_tnote_t _tThis_t _tfunction_t _treturns_t _tthe_t _tunits_t _tof_t _tthe_t _tParameter_t_t _texpressed_t _tas_t _ta_t _tUnitDefinition_t_t. _tThe_t _tunits_t _tmay_t _tbe_t _tthose_t _texplicitly_t _tdeclared_t. _tIn_t _tthe_t _tcase_t _twhere_t _tno_t _tunits_t _thave_t _tbeen_t _tdeclared_t, @_tc_t _tNULL_t _tis_t _treturned_t.

@_tmemberof_t _tParameter_t_t

◆ Parameter_getId()

const char * Parameter_getId ( const Parameter_t p)

_tTakes_t _ta_t _tParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _twhose_t _tidentifier_t _tis_t _tsought_t.

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

@_tmemberof_t _tParameter_t_t

◆ Parameter_getName()

const char * Parameter_getName ( const Parameter_t p)

_tTakes_t _ta_t _tParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _twhose_t _tname_t _tis_t _tsought_t.

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

@_tmemberof_t _tParameter_t_t

◆ Parameter_getNamespaces()

const XMLNamespaces_t * Parameter_getNamespaces ( Parameter_t p)

_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tParameter_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 _tParameter_t_t

◆ Parameter_getUnits()

const char * Parameter_getUnits ( const Parameter_t p)

_tTakes_t _ta_t _tParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tunits_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _twhose_t _tunits_t _tare_t _tsought_t.

@_treturn_t _tthe_t _tunits_t _tassigned_t _tto_t _tthis_t _tParameter_t_t _tstructure_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tParameter_t_t

◆ Parameter_getValue()

double Parameter_getValue ( const Parameter_t p)

_tTakes_t _ta_t _tParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tvalue_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _twhose_t _tvalue_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tassigned_t _tto_t _tthis_t _tParameter_t_t _tstructure_t, _tas_t _ta_t @_tc_t _tdouble_t.

@_tmemberof_t _tParameter_t_t

◆ Parameter_hasRequiredAttributes()

int Parameter_hasRequiredAttributes ( Parameter_t p)

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

_tThe_t _trequired_t _tattributes_t _tfor_t _ta_t _tParameter_t_t _tstructure_t _tare_t: @_tli_t _tid_t (_tname_t _tin_t _tL1_t) @_tli_t _tconstant_t (_tin_t _tL3_t _tonly_t)

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _tto_t _tcheck_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tstructure_t _thave_t _tbeen_t _tdefined_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tParameter_t_t

◆ Parameter_initDefaults()

void Parameter_initDefaults ( Parameter_t p)

_tInitializes_t _tthe_t _tattributes_t _tof_t _tthis_t _tParameter_t_t _tstructure_t _tto_t _ttheir_t _tdefaults_t.

_tThe_t _texact_t _tresults_t _tdepends_t _ton_t _tthe_t SBML_t _tLevel_t _tand_t _tVersion_t _tin_t _tuse_t. _tThe_t _tcases_t _tare_t _tcurrently_t _tthe_t _tfollowing_t:

@_tli_t (SBML_t _tLevel_t _t2_t _tonly_t) _tconstant_t = @_tc_t _ttrue_t

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _tto_t _tinitialize_t.

@_tmemberof_t _tParameter_t_t

◆ Parameter_isSetConstant()

int Parameter_isSetConstant ( const Parameter_t p)

_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 _tParameter_t_t _tstructure_t'_ts_t _tconstant_t _tattribute_t _thave_t _tbeen_t _tset_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tParameter_t_t

◆ Parameter_isSetId()

int Parameter_isSetId ( const Parameter_t p)

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

@_tparam_t _tp_t _tthe_t _tParameter_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 _tParameter_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tParameter_t_t

◆ Parameter_isSetName()

int Parameter_isSetName ( const Parameter_t p)

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

@_tparam_t _tp_t _tthe_t _tParameter_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 _tParameter_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tParameter_t_t

◆ Parameter_isSetUnits()

int Parameter_isSetUnits ( const Parameter_t p)

_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 _tParameter_t_t _tstructure_t'_ts_t _tunits_t _thave_t _tbeen_t _tset_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _tto_t _tquery_t.

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

@_tmemberof_t _tParameter_t_t

◆ Parameter_isSetValue()

int Parameter_isSetValue ( const Parameter_t p)

_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 _tParameter_t_t _tstructure_t'_ts_t _tvalue_t _tis_t _tset_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _tto_t _tquery_t.

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

@_tnote_t _tIn_t _tSBML_t _tLevel_t _t1_t _tVersion_t _t1_t, _ta_t _tParameter_t_t _tvalue_t _tis_t _trequired_t _tand_t _ttherefore_t <_tem_t>_tshould_t _talways_t _tbe_t _tset_t</_tem_t>. _tIn_t _tLevel_t _t1_t _tVersion_t _t2_t _tand_t _tlater_t, _tthe_t _tvalue_t _tis_t _toptional_t, _tand_t _tas_t _tsuch_t, _tmay_t _tor_t _tmay_t _tnot_t _tbe_t _tset_t.

@_tmemberof_t _tParameter_t_t

◆ Parameter_setConstant()

int Parameter_setConstant ( Parameter_t p,
int  value 
)

_tAssign_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _ta_t _tParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tvalue_t _tthe_t _tvalue_t _tto_t _tassign_t _tas_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tparameter_t, _teither_t @_tc_t _tzero_t _tfor_t _tfalse_t _tor_t @_tc_t _tnonzero_t _tfor_t _ttrue_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 _tParameter_t_t

◆ Parameter_setId()

int Parameter_setId ( Parameter_t p,
const char *  sid 
)

_tAssigns_t _tthe_t _tidentifier_t _tof_t _ta_t _tParameter_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 _tp_t _tthe_t _tParameter_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 _tParameter_t_t

◆ Parameter_setName()

int Parameter_setName ( Parameter_t p,
const char *  name 
)

_tAssign_t _tthe_t _tname_t _tof_t _ta_t _tParameter_t_t _tstructure_t.

_tThis_t _tmakes_t _ta_t _tcopy_t _tof_t _tthe_t _tstring_t _tpassed_t _tin_t _tas_t _tthe_t _targument_t @_tp_t _tname_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tname_t _tthe_t _tstring_t _tto_t _tuse_t _tas_t _tthe_t _tname_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 _tParameter_t_t

◆ Parameter_setUnits()

int Parameter_setUnits ( Parameter_t p,
const char *  units 
)

_tAssign_t _tthe_t _tunits_t _tof_t _ta_t _tParameter_t_t _tstructure_t.

_tThis_t _tmakes_t _ta_t _tcopy_t _tof_t _tthe_t _tstring_t _tpassed_t _tin_t _tas_t _tthe_t _targument_t @_tp_t _tunits_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tunits_t _tthe_t _tstring_t _tto_t _tuse_t _tas_t _tthe_t _tidentifier_t _tof_t _tthe_t _tunits_t _tto_t _tassign_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 _tunits_t _tset_t _tto_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tunits_t" _tattribute_t.

@_tmemberof_t _tParameter_t_t

◆ Parameter_setValue()

int Parameter_setValue ( Parameter_t p,
double  value 
)

_tAssign_t _tthe_t _tvalue_t _tof_t _ta_t _tParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _tto_t _tset_t. @_tparam_t _tvalue_t _tthe_t @_tc_t _tdouble_t _tvalue_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_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tParameter_t_t

◆ Parameter_unsetConstant()

int Parameter_unsetConstant ( Parameter_t c)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tParameter_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tParameter_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_OPERATION_FAILED_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tParameter_t_t

◆ Parameter_unsetName()

int Parameter_unsetName ( Parameter_t p)

_tUnsets_t _tthe_t _tname_t _tof_t _tthis_t _tParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _twhose_t _tname_t _tis_t _tto_t _tbe_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 _tParameter_t_t

◆ Parameter_unsetUnits()

int Parameter_unsetUnits ( Parameter_t p)

_tUnsets_t _tthe_t _tunits_t _tof_t _tthis_t _tParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _twhose_t _tunits_t _tare_t _tto_t _tbe_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 _tParameter_t_t

◆ Parameter_unsetValue()

int Parameter_unsetValue ( Parameter_t p)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthis_t _tParameter_t_t _tstructure_t.

_tIn_t _tSBML_t _tLevel_t _t1_t _tVersion_t _t1_t, _ta_t _tparameter_t _tis_t _trequired_t _tto_t _thave_t _ta_t _tvalue_t _tand_t _ttherefore_t _tthis_t _tattribute_t <_tem_t>_tshould_t _talways_t _tbe_t _tset_t</_tem_t>. _tIn_t _tLevel_t _t1_t _tVersion_t _t2_t _tand_t _tbeyond_t, _ta_t _tvalue_t _tis_t _toptional_t, _tand_t _tas_t _tsuch_t, _tmay_t _tor_t _tmay_t _tnot_t _tbe_t _tset_t.

@_tparam_t _tp_t _tthe_t _tParameter_t_t _tstructure_t _twhose_t _tvalue_t _tis_t _tto_t _tbe_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_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tParameter_t_t