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

Definitions of SpeciesType_t and ListOfSpeciesType. More...

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

Functions

SpeciesType_tListOfSpeciesTypes_getById (ListOf_t *lo, const char *sid)
 _tReturns_t _tthe_t _tSpeciesType_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.
 
SpeciesType_tListOfSpeciesTypes_removeById (ListOf_t *lo, const char *sid)
 _tRemoves_t _ta_t _tSpeciesType_t_t _tstructure_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
SpeciesType_tSpeciesType_clone (const SpeciesType_t *st)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSpeciesType_t_t _tstructure_t
 
SpeciesType_tSpeciesType_create (unsigned int level, unsigned int version)
 _tCreates_t _ta_t _tnew_t _tSpeciesType_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t _tvalues_t.
 
SpeciesType_tSpeciesType_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tSpeciesType_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
 
void SpeciesType_free (SpeciesType_t *st)
 _tFrees_t _tthe_t _tgiven_t _tSpeciesType_t_t _tstructure_t.
 
const char * SpeciesType_getId (const SpeciesType_t *st)
 _tTakes_t _ta_t _tSpeciesType_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.
 
const char * SpeciesType_getName (const SpeciesType_t *st)
 _tTakes_t _ta_t _tSpeciesType_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.
 
const XMLNamespaces_tSpeciesType_getNamespaces (SpeciesType_t *st)
 _tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tSpeciesType_t_t _tstructure_t.
 
int SpeciesType_isSetId (const SpeciesType_t *st)
 _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 _tSpeciesType_t_t _tstructure_t'_ts_t _tidentifier_t _tis_t _tset_t.
 
int SpeciesType_isSetName (const SpeciesType_t *st)
 _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 _tSpeciesType_t_t _tstructure_t'_ts_t _tname_t _tis_t _tset_t.
 
int SpeciesType_setId (SpeciesType_t *st, const char *sid)
 _tAssigns_t _tthe_t _tidentifier_t _tof_t _ta_t _tSpeciesType_t_t _tstructure_t.
 
int SpeciesType_setName (SpeciesType_t *st, const char *name)
 _tAssign_t _tthe_t _tname_t _tof_t _ta_t _tSpeciesType_t_t _tstructure_t.
 
int SpeciesType_unsetName (SpeciesType_t *st)
 _tUnsets_t _tthe_t _tname_t _tof_t _ta_t _tSpeciesType_t_t.
 

Detailed Description

Definitions of SpeciesType_t and ListOfSpeciesType.

Author
Ben Bornstein

Function Documentation

◆ ListOfSpeciesTypes_getById()

SpeciesType_t * ListOfSpeciesTypes_getById ( ListOf_t lo,
const char *  sid 
)

_tReturns_t _tthe_t _tSpeciesType_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.

@_tparam_t _tlo_t _tthe_t _tListOfSpeciesTypes_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 _tListOfSpeciesTypes_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 _tListOfSpeciesTypes_t_t

◆ ListOfSpeciesTypes_removeById()

SpeciesType_t * ListOfSpeciesTypes_removeById ( ListOf_t lo,
const char *  sid 
)

_tRemoves_t _ta_t _tSpeciesType_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 _tSpeciesType_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 _tSpeciesType_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 _tListOfSpeciesTypes_t_t

◆ SpeciesType_clone()

SpeciesType_t * SpeciesType_clone ( const SpeciesType_t st)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSpeciesType_t_t _tstructure_t

@_tparam_t _tst_t _tthe_t _tSpeciesType_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

@_treturn_t _ta_t (_tdeep_t) _tcopy_t _tof_t _tthis_t _tSpeciesType_t_t _tstructure_t.

@_tmemberof_t _tSpeciesType_t_t

◆ SpeciesType_create()

SpeciesType_t * SpeciesType_create ( unsigned int  level,
unsigned int  version 
)

_tCreates_t _ta_t _tnew_t _tSpeciesType_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 _tSpeciesType_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 _tSpeciesType_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tSpeciesType_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tSpeciesType_t_t

_tCreates_t _ta_t _tnew_t _tSpeciesType_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBML_t @_tp_t _tlevel_t _tand_t @_tp_t _tversion_t _tvalues_t.

@_tcond_t _tdoxygenIgnored_t

◆ SpeciesType_createWithNS()

SpeciesType_t * SpeciesType_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tSpeciesType_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 _tSpeciesType_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tSpeciesType_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tSpeciesType_t_t

◆ SpeciesType_free()

void SpeciesType_free ( SpeciesType_t st)

_tFrees_t _tthe_t _tgiven_t _tSpeciesType_t_t _tstructure_t.

@_tparam_t _tst_t _tthe_t _tSpeciesType_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tSpeciesType_t_t

◆ SpeciesType_getId()

const char * SpeciesType_getId ( const SpeciesType_t st)

_tTakes_t _ta_t _tSpeciesType_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.

@_tparam_t _tst_t _tthe_t _tSpeciesType_t_t _tstructure_t _twhose_t _tidentifier_t _tis_t _tsought_t.

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

@_tmemberof_t _tSpeciesType_t_t

◆ SpeciesType_getName()

const char * SpeciesType_getName ( const SpeciesType_t st)

_tTakes_t _ta_t _tSpeciesType_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.

@_tparam_t _tst_t _tthe_t _tSpeciesType_t_t _twhose_t _tname_t _tis_t _tsought_t.

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

@_tmemberof_t _tSpeciesType_t_t

◆ SpeciesType_getNamespaces()

const XMLNamespaces_t * SpeciesType_getNamespaces ( SpeciesType_t st)

_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tSpeciesType_t_t _tstructure_t.

@_tparam_t _tst_t _tthe_t _tSpeciesType_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 _tSpeciesType_t_t

◆ SpeciesType_isSetId()

int SpeciesType_isSetId ( const SpeciesType_t st)

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

@_tparam_t _tst_t _tthe_t _tSpeciesType_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tid_t" _tfield_t _tof_t _tthe_t _tgiven_t _tSpeciesType_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpeciesType_t_t

◆ SpeciesType_isSetName()

int SpeciesType_isSetName ( const SpeciesType_t st)

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

@_tparam_t _tst_t _tthe_t _tSpeciesType_t_t _tstructure_t _tto_t _tquery_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tname_t" _tfield_t _tof_t _tthe_t _tgiven_t _tSpeciesType_t_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpeciesType_t_t

◆ SpeciesType_setId()

int SpeciesType_setId ( SpeciesType_t st,
const char *  sid 
)

_tAssigns_t _tthe_t _tidentifier_t _tof_t _ta_t _tSpeciesType_t_t _tstructure_t.

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

@_tparam_t _tst_t _tthe_t _tSpeciesType_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 _tSpeciesType_t_t

◆ SpeciesType_setName()

int SpeciesType_setName ( SpeciesType_t st,
const char *  name 
)

_tAssign_t _tthe_t _tname_t _tof_t _ta_t _tSpeciesType_t_t _tstructure_t.

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

@_tparam_t _tst_t _tthe_t _tSpeciesType_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 _tSpeciesType_t_t

◆ SpeciesType_unsetName()

int SpeciesType_unsetName ( SpeciesType_t st)

_tUnsets_t _tthe_t _tname_t _tof_t _ta_t _tSpeciesType_t_t.

@_tparam_t _tst_t _tthe_t _tSpeciesType_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 _tSpeciesType_t_t