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

Definitions of LocalParameter_t and ListOfLocalParameters_t. More...

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

Functions

LocalParameter_tListOfLocalParameters_getById (ListOf_t *lo, const char *sid)
 _tReturns_t _tthe_t _tLocalParameter_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.
 
LocalParameter_tListOfLocalParameters_removeById (ListOf_t *lo, const char *sid)
 _tRemoves_t _ta_t _tLocalParameter_t_t _tstructure_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
LocalParameter_tLocalParameter_clone (const LocalParameter_t *p)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tLocalParameter_t_t _tstructure_t
 
LocalParameter_tLocalParameter_create (unsigned int level, unsigned int version)
 @_tclass_t _tdoc_localparameter_units_t
 
LocalParameter_tLocalParameter_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tLocalParameter_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
 
void LocalParameter_free (LocalParameter_t *p)
 _tFrees_t _tthe_t _tgiven_t _tLocalParameter_t_t _tstructure_t.
 
int LocalParameter_getConstant (const LocalParameter_t *p)
 _tBecause_t _ta_t _tLocalParameter_t_t _thas_t _tno_t '_tconstant_t' _tattribute_t, _talways_t _treturns_t '_ttrue_t', _tas_t _tlocal_t _tparameters_t _tin_t _tSBML_t _tmay_t _tnot_t _tvary_t.
 
UnitDefinition_tLocalParameter_getDerivedUnitDefinition (LocalParameter_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 _tLocalParameter_t_t _tstructure_t.
 
const char * LocalParameter_getId (const LocalParameter_t *p)
 _tTakes_t _ta_t _tLocalParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.
 
const char * LocalParameter_getName (const LocalParameter_t *p)
 _tTakes_t _ta_t _tLocalParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.
 
const XMLNamespaces_tLocalParameter_getNamespaces (LocalParameter_t *p)
 _tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tLocalParameter_t_t _tstructure_t.
 
const char * LocalParameter_getUnits (const LocalParameter_t *p)
 _tTakes_t _ta_t _tLocalParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tunits_t.
 
double LocalParameter_getValue (const LocalParameter_t *p)
 _tTakes_t _ta_t _tLocalParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tvalue_t.
 
int LocalParameter_hasRequiredAttributes (LocalParameter_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 _tLocalParameter_t _tobject_t _thave_t _tbeen_t _tset_t.
 
void LocalParameter_initDefaults (LocalParameter_t *p)
 _tDoes_t _tnothing_t: _tthis_t _tfunction_t _tinitializes_t _tstructures_t _taccording_t _tto_t _ttheir_t _tdefaults_t _tin_t _tSBML_t _tLevel_t _t2_t, _tbut_t _tLocal_t _tParameters_t _tdid_t _tnot_t _texist_t _tin_t _tSBML_t _tLevel_t _t2_t.
 
int LocalParameter_isSetId (const LocalParameter_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 _tLocalParameter_t_t _tstructure_t'_ts_t _tidentifier_t _tis_t _tset_t.
 
int LocalParameter_isSetName (const LocalParameter_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 _tLocalParameter_t_t _tstructure_t'_ts_t _tname_t _tis_t _tset_t.
 
int LocalParameter_isSetUnits (const LocalParameter_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 _tLocalParameter_t_t _tstructure_t'_ts_t _tunits_t _thave_t _tbeen_t _tset_t.
 
int LocalParameter_isSetValue (const LocalParameter_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 _tLocalParameter_t_t _tstructure_t'_ts_t _tvalue_t _tis_t _tset_t.
 
int LocalParameter_setConstant (LocalParameter_t *p, int value)
 _tBecause_t _tLocalParameter_t_t _tstructures_t _tdon_t'_tt_t _thave_t _ta_t '_tconstant_t' _tattribute_t, _tthis_t _tfunction_t _talways_t _treturns_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t}, _tor_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} _tif_t @_tp_t _tp_t _tis_t @_tc_t _tNULL_t.
 
int LocalParameter_setId (LocalParameter_t *p, const char *sid)
 _tAssigns_t _tthe_t _tidentifier_t _tof_t _ta_t _tLocalParameter_t_t _tstructure_t.
 
int LocalParameter_setName (LocalParameter_t *p, const char *name)
 _tAssign_t _tthe_t _tname_t _tof_t _ta_t _tLocalParameter_t_t _tstructure_t.
 
int LocalParameter_setUnits (LocalParameter_t *p, const char *units)
 _tAssign_t _tthe_t _tunits_t _tof_t _ta_t _tLocalParameter_t_t _tstructure_t.
 
int LocalParameter_setValue (LocalParameter_t *p, double value)
 _tAssign_t _tthe_t _tvalue_t _tof_t _ta_t _tLocalParameter_t_t _tstructure_t.
 
int LocalParameter_unsetConstant (LocalParameter_t *p)
 _tBecause_t _tLocalParameter_t_t _tstructures_t _tdon_t'_tt_t _thave_t _ta_t '_tconstant_t' _tattribute_t, _tthis_t _tfunction_t _talways_t _treturns_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t}, _tor_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} _tif_t @_tp_t _tp_t _tis_t @_tc_t _tNULL_t.
 
int LocalParameter_unsetName (LocalParameter_t *p)
 _tUnsets_t _tthe_t _tname_t _tof_t _tthis_t _tLocalParameter_t_t _tstructure_t.
 
int LocalParameter_unsetUnits (LocalParameter_t *p)
 _tUnsets_t _tthe_t _tunits_t _tof_t _tthis_t _tLocalParameter_t_t _tstructure_t.
 
int LocalParameter_unsetValue (LocalParameter_t *p)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthis_t _tLocalParameter_t_t _tstructure_t.
 

Detailed Description

Definitions of LocalParameter_t and ListOfLocalParameters_t.

Author
Sarah Keating

Function Documentation

◆ ListOfLocalParameters_getById()

LocalParameter_t * ListOfLocalParameters_getById ( ListOf_t lo,
const char *  sid 
)

_tReturns_t _tthe_t _tLocalParameter_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.

@_tparam_t _tlo_t _tthe_t _tListOfLocalParameters_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 _tListOfLocalParameters_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 _tListOfLocalParameters_t_t

◆ ListOfLocalParameters_removeById()

LocalParameter_t * ListOfLocalParameters_removeById ( ListOf_t lo,
const char *  sid 
)

_tRemoves_t _ta_t _tLocalParameter_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 _tLocalParameter_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 _tLocalParameter_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 _tListOfLocalParameters_t_t

◆ LocalParameter_clone()

LocalParameter_t * LocalParameter_clone ( const LocalParameter_t p)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tLocalParameter_t_t _tstructure_t

@_tparam_t _tp_t _tthe_t _tLocalParameter_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

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

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_create()

LocalParameter_t * LocalParameter_create ( unsigned int  level,
unsigned int  version 
)

@_tclass_t _tdoc_localparameter_units_t

@_tpar_t _tLocalParameters_t _tin_t _tSBML_t _thave_t _tan_t _tattribute_t ("_tunits_t") _tfor_t _tdeclaring_t _tthe_t _tunits_t _tof_t _tmeasurement_t _tintended_t _tfor_t _tthe_t _tparameter_t'_ts_t _tvalue_t. <_tb_t>_tNo_t _tdefaults_t _tare_t _tdefined_t</_tb_t> _tby_t _tSBML_t _tin_t _tthe_t _tabsence_t _tof_t _ta_t _tdefinition_t _tfor_t "_tunits_t". _tThis_t _tmethod_t _treturns_t _ta_t _tUnitDefinition_t _tobject_t _tbased_t _ton_t _tthe_t _tunits_t _tdeclared_t _tfor_t _tthis_t _tLocalParameter_t _tusing_t _tits_t "_tunits_t" _tattribute_t, _tor_t _tit_t _treturns_t @_tc_t _tNULL_t _tif_t _tno_t _tunits_t _thave_t _tbeen_t _tdeclared_t.

_tNote_t _tthat_t _tunit_t _tdeclarations_t _tfor_t _tLocalParameter_t _tobjects_t _tare_t _tspecified_t _tin_t _tterms_t _tof_t _tthe_t @_tem_t _tidentifier_t _tof_t _ta_t _tunit_t (_te_t._tg_t., _tusing_t _tsetUnits_t()), _tbut_t @_tem_t _tthis_t _tmethod_t _treturns_t _ta_t _tUnitDefinition_t _tobject_t, _tnot_t _ta_t _tunit_t _tidentifier_t. _tIt_t _tdoes_t _tthis_t _tby_t _tconstructing_t _tan_t _tappropriate_t _tUnitDefinition_t. _tFor_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tmodels_t, _tit_t _twill_t _tdo_t _tthis_t _teven_t _twhen_t _tthe_t _tvalue_t _tof_t _tthe_t "_tunits_t" _tattribute_t _tis_t _tone_t _tof_t _tthe_t _tpredefined_t _tSBML_t _tunits_t @_tc_t "_tsubstance_t", @_tc_t "_tvolume_t", @_tc_t "_tarea_t", @_tc_t "_tlength_t" _tor_t @_tc_t "_ttime_t". _tCallers_t _tmay_t _tfind_t _tthis_t _tuseful_t _tin_t _tconjunction_t _twith_t _tthe_t _thelper_t _tmethods_t _tprovided_t _tby_t _tthe_t _tUnitDefinition_t _tclass_t _tfor_t _tcomparing_t _tdifferent_t _tUnitDefinition_t _tobjects_t.

_tCreates_t _ta_t _tnew_t _tLocalParameter_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 _tLocalParameter_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 _tLocalParameter_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tLocalParameter_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tLocalParameter_t_t

@_tclass_t _tdoc_localparameter_units_t

@_tcond_t _tdoxygenIgnored_t

◆ LocalParameter_createWithNS()

LocalParameter_t * LocalParameter_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tLocalParameter_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 _tLocalParameter_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tLocalParameter_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_free()

void LocalParameter_free ( LocalParameter_t p)

_tFrees_t _tthe_t _tgiven_t _tLocalParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_getConstant()

int LocalParameter_getConstant ( const LocalParameter_t p)

_tBecause_t _ta_t _tLocalParameter_t_t _thas_t _tno_t '_tconstant_t' _tattribute_t, _talways_t _treturns_t '_ttrue_t', _tas_t _tlocal_t _tparameters_t _tin_t _tSBML_t _tmay_t _tnot_t _tvary_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_t_t _tto_t _tignore_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t), _tor_t @_tc_t _t0_t (_tfalse_t) _tif_t @_tp_t _tp_t _tis_t @_tc_t _tNULL_t.

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_getDerivedUnitDefinition()

UnitDefinition_t * LocalParameter_getDerivedUnitDefinition ( LocalParameter_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 _tLocalParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_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 _tLocalParameter_t_t _tstrucuture_t.

@_tnote_t _tThis_t _tfunction_t _treturns_t _tthe_t _tunits_t _tof_t _tthe_t _tLocalParameter_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 _tLocalParameter_t_t

◆ LocalParameter_getId()

const char * LocalParameter_getId ( const LocalParameter_t p)

_tTakes_t _ta_t _tLocalParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_t_t _tstructure_t _twhose_t _tidentifier_t _tis_t _tsought_t.

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

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_getName()

const char * LocalParameter_getName ( const LocalParameter_t p)

_tTakes_t _ta_t _tLocalParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_t_t _twhose_t _tname_t _tis_t _tsought_t.

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

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_getNamespaces()

const XMLNamespaces_t * LocalParameter_getNamespaces ( LocalParameter_t p)

_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tLocalParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_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 _tLocalParameter_t_t

◆ LocalParameter_getUnits()

const char * LocalParameter_getUnits ( const LocalParameter_t p)

_tTakes_t _ta_t _tLocalParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tunits_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_t_t _twhose_t _tunits_t _tare_t _tsought_t.

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

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_getValue()

double LocalParameter_getValue ( const LocalParameter_t p)

_tTakes_t _ta_t _tLocalParameter_t_t _tstructure_t _tand_t _treturns_t _tits_t _tvalue_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_t_t _twhose_t _tvalue_t _tis_t _tsought_t.

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

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_hasRequiredAttributes()

int LocalParameter_hasRequiredAttributes ( LocalParameter_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 _tLocalParameter_t _tobject_t _thave_t _tbeen_t _tset_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_t_t _tstructure_t _tto_t _tcheck_t.

_tThe_t _trequired_t _tattributes_t _tfor_t _ta_t _tLocalParameter_t _tobject_t _tare_t: @_tli_t _tid_t (_tname_t _tin_t _tL1_t)

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

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_initDefaults()

void LocalParameter_initDefaults ( LocalParameter_t p)

_tDoes_t _tnothing_t: _tthis_t _tfunction_t _tinitializes_t _tstructures_t _taccording_t _tto_t _ttheir_t _tdefaults_t _tin_t _tSBML_t _tLevel_t _t2_t, _tbut_t _tLocal_t _tParameters_t _tdid_t _tnot_t _texist_t _tin_t _tSBML_t _tLevel_t _t2_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_t_t _tstructure_t _tto_t _tbe_t _tignored_t.

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_isSetId()

int LocalParameter_isSetId ( const LocalParameter_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 _tLocalParameter_t_t _tstructure_t'_ts_t _tidentifier_t _tis_t _tset_t.

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

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_isSetName()

int LocalParameter_isSetName ( const LocalParameter_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 _tLocalParameter_t_t _tstructure_t'_ts_t _tname_t _tis_t _tset_t.

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

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_isSetUnits()

int LocalParameter_isSetUnits ( const LocalParameter_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 _tLocalParameter_t_t _tstructure_t'_ts_t _tunits_t _thave_t _tbeen_t _tset_t.

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

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_isSetValue()

int LocalParameter_isSetValue ( const LocalParameter_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 _tLocalParameter_t_t _tstructure_t'_ts_t _tvalue_t _tis_t _tset_t.

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

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_setConstant()

int LocalParameter_setConstant ( LocalParameter_t p,
int  value 
)

_tBecause_t _tLocalParameter_t_t _tstructures_t _tdon_t'_tt_t _thave_t _ta_t '_tconstant_t' _tattribute_t, _tthis_t _tfunction_t _talways_t _treturns_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t}, _tor_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} _tif_t @_tp_t _tp_t _tis_t @_tc_t _tNULL_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_t_t _tstructure_t _tto_t _tleave_t _tunchanged_t. @_tparam_t _tvalue_t _tthe_t _tinteger_t _tvalue_t _tto_t _tignore_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_setId()

int LocalParameter_setId ( LocalParameter_t p,
const char *  sid 
)

_tAssigns_t _tthe_t _tidentifier_t _tof_t _ta_t _tLocalParameter_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 _tLocalParameter_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 _tLocalParameter_t_t

◆ LocalParameter_setName()

int LocalParameter_setName ( LocalParameter_t p,
const char *  name 
)

_tAssign_t _tthe_t _tname_t _tof_t _ta_t _tLocalParameter_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 _tLocalParameter_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 _tLocalParameter_t_t

◆ LocalParameter_setUnits()

int LocalParameter_setUnits ( LocalParameter_t p,
const char *  units 
)

_tAssign_t _tthe_t _tunits_t _tof_t _ta_t _tLocalParameter_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 _tLocalParameter_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 _tLocalParameter_t_t

◆ LocalParameter_setValue()

int LocalParameter_setValue ( LocalParameter_t p,
double  value 
)

_tAssign_t _tthe_t _tvalue_t _tof_t _ta_t _tLocalParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_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 _tLocalParameter_t_t

◆ LocalParameter_unsetConstant()

int LocalParameter_unsetConstant ( LocalParameter_t p)

_tBecause_t _tLocalParameter_t_t _tstructures_t _tdon_t'_tt_t _thave_t _ta_t '_tconstant_t' _tattribute_t, _tthis_t _tfunction_t _talways_t _treturns_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t}, _tor_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t} _tif_t @_tp_t _tp_t _tis_t @_tc_t _tNULL_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_t_t _tstructure_t _tto_t _tleave_t _tunchanged_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tLocalParameter_t_t

◆ LocalParameter_unsetName()

int LocalParameter_unsetName ( LocalParameter_t p)

_tUnsets_t _tthe_t _tname_t _tof_t _tthis_t _tLocalParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_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 _tLocalParameter_t_t

◆ LocalParameter_unsetUnits()

int LocalParameter_unsetUnits ( LocalParameter_t p)

_tUnsets_t _tthe_t _tunits_t _tof_t _tthis_t _tLocalParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_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 _tLocalParameter_t_t

◆ LocalParameter_unsetValue()

int LocalParameter_unsetValue ( LocalParameter_t p)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthis_t _tLocalParameter_t_t _tstructure_t.

@_tparam_t _tp_t _tthe_t _tLocalParameter_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 _tLocalParameter_t_t