libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
ListOfMembers.h File Reference

Definition of the ListOfMembers_t class. More...

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

Functions

Member_tListOfMembers_getById (ListOf_t *lo, const char *sid)
 _tGet_t _ta_t _tMember_t_t _tfrom_t _tthe_t _tListOf_t_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
char * ListOfMembers_getId (const ListOf_t *lo)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tListOf_t_t.
 
Member_tListOfMembers_getMember (ListOf_t *lo, unsigned int n)
 _tGet_t _ta_t _tMember_t_t _tfrom_t _tthe_t _tListOf_t_t.
 
char * ListOfMembers_getName (const ListOf_t *lo)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tListOf_t_t.
 
int ListOfMembers_isSetId (const ListOf_t *lo)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tListOf_t_t'_ts_t "_tid_t" _tattribute_t _tis_t _tset_t.
 
int ListOfMembers_isSetName (const ListOf_t *lo)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tListOf_t_t'_ts_t "_tname_t" _tattribute_t _tis_t _tset_t.
 
Member_tListOfMembers_remove (ListOf_t *lo, unsigned int n)
 _tRemoves_t _tthe_t _tnth_t _tMember_t_t _tfrom_t _tthis_t _tListOf_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
Member_tListOfMembers_removeById (ListOf_t *lo, const char *sid)
 _tRemoves_t _tthe_t _tMember_t_t _tfrom_t _tthis_t _tListOf_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.
 
int ListOfMembers_setId (ListOf_t *lo, const char *id)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tListOf_t_t.
 
int ListOfMembers_setName (ListOf_t *lo, const char *name)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tListOf_t_t.
 
int ListOfMembers_unsetId (ListOf_t *lo)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tListOf_t_t.
 
int ListOfMembers_unsetName (ListOf_t *lo)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tListOf_t_t.
 

Detailed Description

Definition of the ListOfMembers_t class.

Author
SBMLTeam

Function Documentation

◆ ListOfMembers_getById()

Member_t * ListOfMembers_getById ( ListOf_t lo,
const char *  sid 
)

_tGet_t _ta_t _tMember_t_t _tfrom_t _tthe_t _tListOf_t_t _tbased_t _ton_t _tits_t _tidentifier_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t _tidentifier_t _tof_t _tthe_t _tMember_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tMember_t_t _tin_t _tthis_t _tListOf_t_t _twith_t _tthe_t _tgiven_t @_tp_t _tsid_t _tor_t @_tc_t _tNULL_t _tif_t _tno_t _tsuch_t _tMember_t_t _texists_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tListOfMembers_t_t

◆ ListOfMembers_getId()

char * ListOfMembers_getId ( const ListOf_t lo)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tListOf_t_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _twhose_t _tid_t _tis_t _tsought_t.

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

@_tcopydetails_t _tdoc_warning_returns_owned_char_t

@_tmemberof_t _tListOfMembers_t_t

◆ ListOfMembers_getMember()

Member_t * ListOfMembers_getMember ( ListOf_t lo,
unsigned int  n 
)

_tGet_t _ta_t _tMember_t_t _tfrom_t _tthe_t _tListOf_t_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tn_t _tan_t _tunsigned_t _tint_t _trepresenting_t _tthe_t _tindex_t _tof_t _tthe_t _tMember_t_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t _tnth_t _tMember_t_t _tin_t _tthis_t _tListOf_t_t. _tIf_t _tthe_t _tindex_t @_tp_t _tn_t _tis_t _tinvalid_t, @_tc_t _tNULL_t _tis_t _treturned_t.

@_tcopydetails_t _tdoc_returned_unowned_pointer_t

@_tmemberof_t _tListOfMembers_t_t

◆ ListOfMembers_getName()

char * ListOfMembers_getName ( const ListOf_t lo)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tListOf_t_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _twhose_t _tname_t _tis_t _tsought_t.

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

@_tcopydetails_t _tdoc_warning_returns_owned_char_t

@_tmemberof_t _tListOfMembers_t_t

◆ ListOfMembers_isSetId()

int ListOfMembers_isSetId ( const ListOf_t lo)

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

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t.

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

@_tmemberof_t _tListOfMembers_t_t

◆ ListOfMembers_isSetName()

int ListOfMembers_isSetName ( const ListOf_t lo)

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

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t.

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

@_tmemberof_t _tListOfMembers_t_t

◆ ListOfMembers_remove()

Member_t * ListOfMembers_remove ( ListOf_t lo,
unsigned int  n 
)

_tRemoves_t _tthe_t _tnth_t _tMember_t_t _tfrom_t _tthis_t _tListOf_t_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tn_t _tan_t _tunsigned_t _tint_t _trepresenting_t _tthe_t _tindex_t _tof_t _tthe_t _tMember_t_t _tto_t _tremove_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnth_t _tMember_t_t _tin_t _tthis_t _tListOf_t_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tListOfMembers_t_t

◆ ListOfMembers_removeById()

Member_t * ListOfMembers_removeById ( ListOf_t lo,
const char *  sid 
)

_tRemoves_t _tthe_t _tMember_t_t _tfrom_t _tthis_t _tListOf_t_t _tbased_t _ton_t _tits_t _tidentifier_t _tand_t _treturns_t _ta_t _tpointer_t _tto_t _tit_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _tsearch_t.

@_tparam_t _tsid_t _ta_t _tstring_t _trepresenting_t _tthe_t _tidentifier_t _tof_t _tthe_t _tMember_t_t _tto_t _tremove_t.

@_treturn_t _tthe_t _tMember_t_t _tin_t _tthis_t _tListOf_t_t _tbased_t _ton_t _tthe_t _tidentifier_t _tor_t _tNULL_t _tif_t _tno_t _tsuch_t _tMember_t_t _texists_t.

@_tcopydetails_t _tdoc_warning_returns_owned_pointer_t

@_tmemberof_t _tListOfMembers_t_t

◆ ListOfMembers_setId()

int ListOfMembers_setId ( ListOf_t lo,
const char *  id 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tListOf_t_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t.

@_tparam_t _tid_t _tconst_t _tchar_t * _tvalue_t _tof_t _tthe_t "_tid_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}

_tCalling_t _tthis_t _tfunction_t _twith_t @_tp_t _tid_t = @_tc_t _tNULL_t _tor_t _tan_t _tempty_t _tstring_t _tis_t _tequivalent_t _tto_t _tcalling_t _tListOfMembers_unsetId_t().

@_tmemberof_t _tListOfMembers_t_t

◆ ListOfMembers_setName()

int ListOfMembers_setName ( ListOf_t lo,
const char *  name 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tListOf_t_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t.

@_tparam_t _tname_t _tconst_t _tchar_t * _tvalue_t _tof_t _tthe_t "_tname_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_OBJECT_t, _tOperationReturnValues_t_t}

_tCalling_t _tthis_t _tfunction_t _twith_t @_tp_t _tname_t = @_tc_t _tNULL_t _tor_t _tan_t _tempty_t _tstring_t _tis_t _tequivalent_t _tto_t _tcalling_t _tListOfMembers_unsetName_t().

@_tmemberof_t _tListOfMembers_t_t

◆ ListOfMembers_unsetId()

int ListOfMembers_unsetId ( ListOf_t lo)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthis_t _tListOf_t_t.

@_tparam_t _tlo_t _tthe_t _tListOf_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 _tListOfMembers_t_t

◆ ListOfMembers_unsetName()

int ListOfMembers_unsetName ( ListOf_t lo)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthis_t _tListOf_t_t.

@_tparam_t _tlo_t _tthe_t _tListOf_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 _tListOfMembers_t_t