libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
ListOf.h File Reference
Include dependency graph for ListOf.h:
This graph shows which files directly or indirectly include this file:

Functions

int ListOf_append (ListOf_t *lo, const SBase_t *item)
 _tAdds_t _ta_t _tcopy_t _tof_t _ta_t _tgiven_t _titem_t _tto_t _tthe_t _tend_t _tof_t _ta_t _tListOf_t_t _tlist_t.
 
int ListOf_appendAndOwn (ListOf_t *lo, SBase_t *disownedItem)
 _tAdds_t _tthe_t _tgiven_t _titem_t _tto_t _tthe_t _tend_t _tof_t _ta_t _tListOf_t_t _tlist_t.
 
int ListOf_appendFrom (ListOf_t *lo, ListOf_t *list)
 _tAdds_t _tclones_t _tof_t _tone_t _tlist_t _tof_t _titems_t _tto_t _tanother_t.
 
void ListOf_clear (ListOf_t *lo, int doDelete)
 _tRemoves_t _tall_t _titems_t _tin_t _tthis_t _tListOf_t_t _tstructure_t.
 
ListOf_tListOf_clone (const ListOf_t *lo)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t.
 
ListOf_tListOf_create (unsigned int level, unsigned int version)
 @_tclass_t _tdoc_note_bare_listof_t
 
void ListOf_free (ListOf_t *lo)
 _tFrees_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t.
 
SBase_tListOf_get (ListOf_t *lo, unsigned int n)
 _tReturns_t _tthe_t <_tem_t>_tn_t</_tem_t>_tth_t _titem_t _tof_t _ta_t _tgiven_t _tlist_t.
 
int ListOf_getItemTypeCode (const ListOf_t *lo)
 _tGet_t _tthe_t _ttype_t _tcode_t _tof_t _tthe_t _tobjects_t _tcontained_t _tin_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t.
 
int ListOf_insert (ListOf_t *lo, int location, const SBase_t *item)
 _tInserts_t _ta_t _tcopy_t _tof_t _tan_t _titem_t _tinto_t _ta_t _tListOf_t_t _tlist_t _tat_t _ta_t _tgiven_t _tposition_t.
 
int ListOf_insertAndOwn (ListOf_t *lo, int location, SBase_t *disownedItem)
 _tInserts_t _tan_t _titem_t _tinto_t _ta_t _tListOf_t_t _tlist_t _tat_t _ta_t _tgiven_t _tposition_t.
 
SBase_tListOf_remove (ListOf_t *lo, unsigned int n)
 _tRemoves_t _tthe_t <_tem_t>_tn_t</_tem_t>_tth_t _titem_t _tfrom_t _tthis_t _tListOf_t_t _tlist_t _tand_t _treturns_t _tit_t.
 
unsigned int ListOf_size (const ListOf_t *lo)
 _tReturns_t _tthe_t _tnumber_t _tof_t _titems_t _tin_t _tthis_t _tListOf_t_t _titems_t.
 

Detailed Description

Function Documentation

◆ ListOf_append()

int ListOf_append ( ListOf_t lo,
const SBase_t item 
)

_tAdds_t _ta_t _tcopy_t _tof_t _ta_t _tgiven_t _titem_t _tto_t _tthe_t _tend_t _tof_t _ta_t _tListOf_t_t _tlist_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _twhich_t _tthe_t @_tp_t _titem_t _tshould_t _tbe_t _tappended_t. @_tparam_t _titem_t _tthe_t _titem_t _tto_t _tappend_t _tto_t _tthe_t _tlist_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}

@_tsee_t _tListOf_appendAndOwn_t()

@_tmemberof_t _tListOf_t_t

◆ ListOf_appendAndOwn()

int ListOf_appendAndOwn ( ListOf_t lo,
SBase_t disownedItem 
)

_tAdds_t _tthe_t _tgiven_t _titem_t _tto_t _tthe_t _tend_t _tof_t _ta_t _tListOf_t_t _tlist_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _twhich_t _tthe_t @_tp_t _tdisownedItem_t _tshould_t _tbe_t _tappended_t. @_tparam_t _tdisownedItem_t _tthe_t _titem_t _tto_t _tappend_t _tto_t _tthe_t _tlist_t. _tWill_t _tbecome_t _ta_t _tchild_t _tof_t _tthe_t _tparent_t _tlist_t.

_tUnlike_t _tListOf_append_t(), _tthis_t _tfunction_t _tdoes_t _tnot_t _tcopy_t _tthe_t @_tp_t _tdisownedItem_t. _tThe_t _tgiven_t @_tp_t _tlo_t _tlist_t _twill_t _tcontain_t _tthe_t _toriginal_t _titem_t, _tand_t _tbecomes_t _tresponsible_t _tfor_t _tits_t _tdeletion_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}

@_tsee_t _tListOf_append_t()

@_tmemberof_t _tListOf_t_t

◆ ListOf_appendFrom()

int ListOf_appendFrom ( ListOf_t lo,
ListOf_t list 
)

_tAdds_t _tclones_t _tof_t _tone_t _tlist_t _tof_t _titems_t _tto_t _tanother_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tlist_t _tto_t _twhich_t @_tp_t _tlist_t _twill_t _tbe_t _tappended_t. @_tparam_t _tlist_t _tthe_t _tlist_t _tof_t _titems_t _tto_t _tappend_t _tto_t @_tp_t _tlo_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 _tListOf_t_t

◆ ListOf_clear()

void ListOf_clear ( ListOf_t lo,
int  doDelete 
)

_tRemoves_t _tall_t _titems_t _tin_t _tthis_t _tListOf_t_t _tstructure_t.

_tIf_t @_tp_t _tdoDelete_t _tis_t @_tc_t _tnonzero_t (_ttrue_t), _tall_t _titems_t _tin_t _tthis_t _tListOf_t_t _tstructure_t _tare_t _tboth_t _tdeleted_t _tand_t _tcleared_t, _tand_t _tthus_t _tthe_t _tcaller_t _tdoesn_t'_tt_t _thave_t _tto_t _tdelete_t _tthose_t _titems_t. _tOtherwise_t, _tif_t @_tp_t _tdoDelete_t _tis_t @_tc_t _t0_t (_tfalse_t), _tall_t _titems_t _tare_t _tonly_t _tcleared_t _tfrom_t _tthis_t _tListOf_t_t _tstructure_t _tand_t _tthe_t _tcaller_t _tis_t _tresponsible_t _tfor_t _tdeleting_t _tall_t _titems_t. (_tIn_t _tthe_t _tlatter_t _tcase_t, _tcallers_t _tare_t _tadvised_t _tto_t _tstore_t _tpointers_t _tto_t _tall_t _titems_t _telsewhere_t _tbefore_t _tcalling_t _tthis_t _tfunction_t.)

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _tclear_t. @_tparam_t _tdoDelete_t _twhether_t _tto_t _tdelete_t _tthe_t _titems_t.

@_tmemberof_t _tListOf_t_t

◆ ListOf_clone()

ListOf_t * ListOf_clone ( const ListOf_t lo)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _ta_t _tfailure_t _toccurred_t.

@_tmemberof_t _tListOf_t_t

◆ ListOf_create()

ListOf_t * ListOf_create ( unsigned int  level,
unsigned int  version 
)

@_tclass_t _tdoc_note_bare_listof_t

@_tnote_t _tBare_t _tListOf_t @_tif_t _tconly_t _tstructures_t @_telse_t _tobjects_t@_tendif_t _tare_t _timpossible_t _tto_t _tadd_t _tto_t _tSBML_t _tmodels_t. _tThe_t _tListOf_t @_tif_t _tconly_t _tstructure_t _ttype_t@_telse_t _tclass_t@_tendif_t _tis_t _tsimply_t _tthe_t _tbase_t _tof_t <_tem_t>_tother_t</_tem_t> @_tif_t _tconly_t _tstructure_t _ttypes_t @_telse_t _tclasses_t@_tendif_t _tin_t _tlibSBML_t. _tCalling_t _tprograms_t _tare_t _tnot_t _tintended_t _tto_t _tcreate_t _tbare_t _tListOf_t @_tif_t _tconly_t _tstructures_t @_telse_t _tobjects_t@_tendif_t _tthemselves_t.

_tCreates_t _ta_t _tnew_t _tinstance_t _tof_t _ta_t _tListOf_t_t _tstructure_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 _tListOf_t_t _tstructure_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 _tListOf_t_t _tstructure_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t-_tcreated_t _tListOf_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_bare_listof_t

@_tmemberof_t _tListOf_t_t

@_tclass_t _tdoc_note_bare_listof_t

@_tcond_t _tdoxygenIgnored_t

◆ ListOf_free()

void ListOf_free ( ListOf_t lo)

_tFrees_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t.

_tThis_t _tfunction_t _tassumes_t _teach_t _titem_t _tin_t _tthe_t _tlist_t _tis_t _tderived_t _tfrom_t _tSBase_t_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tListOf_t_t

◆ ListOf_get()

SBase_t * ListOf_get ( ListOf_t lo,
unsigned int  n 
)

_tReturns_t _tthe_t <_tem_t>_tn_t</_tem_t>_tth_t _titem_t _tof_t _ta_t _tgiven_t _tlist_t.

@_tparam_t _tlo_t _tthe_t _tlist_t _tfrom_t _twhich_t _tto_t _tretrieve_t _tthe_t _titem_t. @_tparam_t _tn_t _tthe_t _tindex_t _tof_t _tthe_t _titem_t _tto_t _tretrieve_t.

@_treturn_t _tthe_t <_tem_t>_tn_t</_tem_t>_tth_t _titem_t _tin_t _tthis_t _tListOf_t _titems_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _tthe_t _tindex_t _tnumber_t @_tp_t _tn_t _trefers_t _tto_t _ta_t _tnonexistent_t _tposition_t _tin_t @_tp_t _tlo_t.

@_tsee_t _tListOf_size_t()

@_tmemberof_t _tListOf_t_t

◆ ListOf_getItemTypeCode()

int ListOf_getItemTypeCode ( const ListOf_t lo)

_tGet_t _tthe_t _ttype_t _tcode_t _tof_t _tthe_t _tobjects_t _tcontained_t _tin_t _tthe_t _tgiven_t _tListOf_t_t _tstructure_t.

@_tcopydetails_t _tdoc_what_are_typecodes_t

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _twhose_t _titem_t _ttype_t _tcodes_t _tare_t _tsought_t.

@_treturn_t _tthe_t _ttype_t _tcode_t _tcorresponding_t _tto_t _tthe_t _tobjects_t _tin_t @_tp_t _tlo_t, _tor_t @_tsbmlconstant_t{_tSBML_UNKNOWN_t, _tSBMLTypeCode_t_t}.

@_tmemberof_t _tListOf_t_t

◆ ListOf_insert()

int ListOf_insert ( ListOf_t lo,
int  location,
const SBase_t item 
)

_tInserts_t _ta_t _tcopy_t _tof_t _tan_t _titem_t _tinto_t _ta_t _tListOf_t_t _tlist_t _tat_t _ta_t _tgiven_t _tposition_t.

@_tparam_t _tlo_t _tthe_t _tlist_t _tinto_t _twhich_t @_tp_t _titem_t _twill_t _tbe_t _tinserted_t. @_tparam_t _tlocation_t _tthe_t _tstarting_t _tindex_t _tfor_t _tthe_t @_tp_t _titem_t _tin_t _tthe_t @_tp_t _tlo_t _tlist_t. @_tparam_t _titem_t _tthe_t _titem_t _tto_t _tappend_t _tto_t _tinsert_t _tinto_t @_tp_t _tlo_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 _tListOf_t_t

◆ ListOf_insertAndOwn()

int ListOf_insertAndOwn ( ListOf_t lo,
int  location,
SBase_t disownedItem 
)

_tInserts_t _tan_t _titem_t _tinto_t _ta_t _tListOf_t_t _tlist_t _tat_t _ta_t _tgiven_t _tposition_t.

_tUnlike_t _tListOf_insert_t(), _tthis_t _tfunction_t _tdoes_t _tnot_t _tclone_t @_tp_t _tdisownedItem_t _tbefore_t _tinserting_t _tit_t _tinto_t @_tp_t _tlo_t, _twhich_t _tmeans_t _tthat_t @_tp_t _tlo_t _tbecomes_t _tthe_t _towner_t.

@_tparam_t _tlo_t _tthe_t _tlist_t _tinto_t _twhich_t @_tp_t _tdisownedItem_t _twill_t _tbe_t _tinserted_t. @_tparam_t _tlocation_t _tthe_t _tstarting_t _tindex_t _tfor_t _tthe_t @_tp_t _tdisownedItem_t _tin_t _tthe_t @_tp_t _tlo_t _tlist_t. @_tparam_t _tdisownedItem_t _tthe_t _titem_t _tto_t _tappend_t _tto_t _tinsert_t _tinto_t @_tp_t _tlo_t. _tWill_t _tbecome_t _ta_t _tchild_t _tof_t _tthe_t _tparent_t _tlist_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 _tListOf_t_t

◆ ListOf_remove()

SBase_t * ListOf_remove ( ListOf_t lo,
unsigned int  n 
)

_tRemoves_t _tthe_t <_tem_t>_tn_t</_tem_t>_tth_t _titem_t _tfrom_t _tthis_t _tListOf_t_t _tlist_t _tand_t _treturns_t _tit_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 _tfrom_t _twhich_t _tthe_t _titem_t _tshould_t _tbe_t _tremoved_t. @_tparam_t _tn_t _tthe_t _tindex_t _tnumber_t _tof_t _tthe_t _titem_t _tto_t _tremove_t.

@_treturn_t _tthe_t _titem_t _tremoved_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _tno_t _titem_t _texisted_t _tat_t _tthe_t _tindex_t @_tp_t _tn_t.

@_tmemberof_t _tListOf_t_t

◆ ListOf_size()

unsigned int ListOf_size ( const ListOf_t lo)

_tReturns_t _tthe_t _tnumber_t _tof_t _titems_t _tin_t _tthis_t _tListOf_t_t _titems_t.

@_tparam_t _tlo_t _tthe_t _tListOf_t_t _tstructure_t _tto_t _tcount_t.

@_treturn_t _tthe_t _tnumber_t _tof_t _titems_t _tin_t @_tp_t _tlo_t.

@_tmemberof_t _tListOf_t_t