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

: Implementation of the SpeciesFeatureValue_t class More...

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

Functions

SpeciesFeatureValue_tListOfSpeciesFeatureValues_getById (ListOf_t *lo, const char *sid)
 _tReturn_t _tthe_t _tstructure_t _tindicated_t _tby_t _tthe_t _tgiven_t @_tp_t _tsid_t.
 
SpeciesFeatureValue_tListOfSpeciesFeatureValues_removeById (ListOf_t *lo, const char *sid)
 _tRemoves_t _tthe_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tfrom_t _tthe_t _tgiven_t _tlist_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
SpeciesFeatureValue_tSpeciesFeatureValue_clone (SpeciesFeatureValue_t *sfv)
 _tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthis_t _tSpeciesFeatureValue_t_t _tobject_t.
 
SpeciesFeatureValue_tSpeciesFeatureValue_create (unsigned int level, unsigned int version, unsigned int pkgVersion)
 _tCreates_t _ta_t _tnew_t _tSpeciesFeatureValue_t_t _tusing_t _tthe_t _tgiven_t _tSBML_t _tLevel_t, _tVersion_t _tand_t &_tldquo_t;_tmulti_t&_trdquo_t; _tpackage_t _tversion_t.
 
void SpeciesFeatureValue_free (SpeciesFeatureValue_t *sfv)
 _tFrees_t _tthis_t _tSpeciesFeatureValue_t_t _tobject_t.
 
char * SpeciesFeatureValue_getValue (SpeciesFeatureValue_t *sfv)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvalue_t" _tattribute_t _tof_t _tthis_t _tSpeciesFeatureValue_t_t.
 
int SpeciesFeatureValue_hasRequiredAttributes (SpeciesFeatureValue_t *sfv)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tSpeciesFeatureValue_t_t _tobject_t _thave_t _tbeen_t _tset_t.
 
int SpeciesFeatureValue_isSetValue (SpeciesFeatureValue_t *sfv)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tSpeciesFeatureValue_t_t'_ts_t "_tvalue_t" _tattribute_t _tis_t _tset_t.
 
int SpeciesFeatureValue_setValue (SpeciesFeatureValue_t *sfv, const char *value)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvalue_t" _tattribute_t _tof_t _tthis_t _tSpeciesFeatureValue_t_t.
 
int SpeciesFeatureValue_unsetValue (SpeciesFeatureValue_t *sfv)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvalue_t" _tattribute_t _tof_t _tthis_t _tSpeciesFeatureValue_t_t.
 

Detailed Description

: Implementation of the SpeciesFeatureValue_t class

Author
: SBMLTeam

Function Documentation

◆ ListOfSpeciesFeatureValues_getById()

SpeciesFeatureValue_t * ListOfSpeciesFeatureValues_getById ( ListOf_t lo,
const char *  sid 
)

_tReturn_t _tthe_t _tstructure_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 _tmatching_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _telement_t _tsought_t.

@_treturn_t _tthe_t _tstructure_t _tfor_t _tthe_t _tgiven_t _tvariable_t, _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tobject_t _texists_t _tin_t _tthe_t _tlist_t.

@_tmemberof_t _tListOfSpeciesFeatureValues_t_t

◆ ListOfSpeciesFeatureValues_removeById()

SpeciesFeatureValue_t * ListOfSpeciesFeatureValues_removeById ( ListOf_t lo,
const char *  sid 
)

_tRemoves_t _tthe_t _tstructure_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tfrom_t _tthe_t _tgiven_t _tlist_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 _ta_t _tstring_t _tmatching_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _telement_t _tsought_t.

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

@_tmemberof_t _tListOfSpeciesFeatureValues_t_t

◆ SpeciesFeatureValue_clone()

SpeciesFeatureValue_t * SpeciesFeatureValue_clone ( SpeciesFeatureValue_t sfv)

_tCreates_t _tand_t _treturns_t _ta_t _tdeep_t _tcopy_t _tof_t _tthis_t _tSpeciesFeatureValue_t_t _tobject_t.

@_tparam_t _tsfv_t _tthe_t _tSpeciesFeatureValue_t_t _tstructure_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tSpeciesFeatureValue_t_t _tobject_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tSpeciesFeatureValue_t_t

◆ SpeciesFeatureValue_create()

SpeciesFeatureValue_t * SpeciesFeatureValue_create ( unsigned int  level,
unsigned int  version,
unsigned int  pkgVersion 
)

_tCreates_t _ta_t _tnew_t _tSpeciesFeatureValue_t_t _tusing_t _tthe_t _tgiven_t _tSBML_t _tLevel_t, _tVersion_t _tand_t &_tldquo_t;_tmulti_t&_trdquo_t; _tpackage_t _tversion_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 _tSpeciesFeatureValue_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 _tSpeciesFeatureValue_t_t.

@_tparam_t _tpkgVersion_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t _tMulti_t _tVersion_t _tto_t _tassign_t _tto_t _tthis_t _tSpeciesFeatureValue_t_t.

@_tcopydetails_t _tdoc_note_setting_lv_pkg_t

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tSpeciesFeatureValue_t_t

◆ SpeciesFeatureValue_free()

void SpeciesFeatureValue_free ( SpeciesFeatureValue_t sfv)

_tFrees_t _tthis_t _tSpeciesFeatureValue_t_t _tobject_t.

@_tparam_t _tsfv_t _tthe_t _tSpeciesFeatureValue_t_t _tstructure_t.

@_tmemberof_t _tSpeciesFeatureValue_t_t

◆ SpeciesFeatureValue_getValue()

char * SpeciesFeatureValue_getValue ( SpeciesFeatureValue_t sfv)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvalue_t" _tattribute_t _tof_t _tthis_t _tSpeciesFeatureValue_t_t.

@_tparam_t _tsfv_t _tthe_t _tSpeciesFeatureValue_t_t _tstructure_t _twhose_t _tvalue_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvalue_t" _tattribute_t _tof_t _tthis_t _tSpeciesFeatureValue_t_t _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tcopydetails_t _tdoc_warning_returns_owned_char_t

@_tmemberof_t _tSpeciesFeatureValue_t_t

◆ SpeciesFeatureValue_hasRequiredAttributes()

int SpeciesFeatureValue_hasRequiredAttributes ( SpeciesFeatureValue_t sfv)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tall_t _tthe_t _trequired_t _tattributes_t _tfor_t _tthis_t _tSpeciesFeatureValue_t_t _tobject_t _thave_t _tbeen_t _tset_t.

@_tparam_t _tsfv_t _tthe_t _tSpeciesFeatureValue_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tto_t _tindicate_t _tthat_t _tall_t _tthe_t _trequired_t _tattributes_t _tof_t _tthis_t _tSpeciesFeatureValue_t_t _thave_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tnote_t _tThe_t _trequired_t _tattributes_t _tfor_t _tthe_t _tSpeciesFeatureValue_t_t _tobject_t _tare_t: @_tli_t "_tvalue_t"

@_tmemberof_t _tSpeciesFeatureValue_t_t

◆ SpeciesFeatureValue_isSetValue()

int SpeciesFeatureValue_isSetValue ( SpeciesFeatureValue_t sfv)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tSpeciesFeatureValue_t_t'_ts_t "_tvalue_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tsfv_t _tthe_t _tSpeciesFeatureValue_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tSpeciesFeatureValue_t_t'_ts_t "_tvalue_t" _tattribute_t _thas_t _tbeen_t _tset_t, _totherwise_t @_tc_t _t0_t (_tfalse_t) _tis_t _treturned_t.

@_tmemberof_t _tSpeciesFeatureValue_t_t

◆ SpeciesFeatureValue_setValue()

int SpeciesFeatureValue_setValue ( SpeciesFeatureValue_t sfv,
const char *  value 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvalue_t" _tattribute_t _tof_t _tthis_t _tSpeciesFeatureValue_t_t.

@_tparam_t _tsfv_t _tthe_t _tSpeciesFeatureValue_t_t _tstructure_t.

@_tparam_t _tvalue_t _tconst_t _tchar_t * _tvalue_t _tof_t _tthe_t "_tvalue_t" _tattribute_t _tto_t _tbe_t _tset_t.

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

@_tmemberof_t _tSpeciesFeatureValue_t_t

◆ SpeciesFeatureValue_unsetValue()

int SpeciesFeatureValue_unsetValue ( SpeciesFeatureValue_t sfv)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvalue_t" _tattribute_t _tof_t _tthis_t _tSpeciesFeatureValue_t_t.

@_tparam_t _tsfv_t _tthe_t _tSpeciesFeatureValue_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 _tSpeciesFeatureValue_t_t