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

Definitions of Species_t and ListOfSpecies_t. More...

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

Functions

Species_tListOfSpecies_getById (ListOf_t *lo, const char *sid)
 _tReturns_t _tthe_t _tSpecies_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.
 
Species_tListOfSpecies_removeById (ListOf_t *lo, const char *sid)
 _tRemoves_t _ta_t _tSpecies_t_t _tstructure_t _tbased_t _ton_t _tits_t _tidentifier_t.
 
Species_tSpecies_clone (const Species_t *s)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t
 
Species_tSpecies_create (unsigned int level, unsigned int version)
 @_tclass_t _tdoc_warning_species_spatialSizeUnits_t
 
Species_tSpecies_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tSpecies_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t.
 
void Species_free (Species_t *s)
 _tFrees_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_getBoundaryCondition (const Species_t *s)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tboundaryCondition_t" _tattribute_t.
 
int Species_getCharge (const Species_t *s)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcharge_t" _tattribute_t.
 
const char * Species_getCompartment (const Species_t *s)
 _tGet_t _tthe_t _tcompartment_t _tin_t _twhich_t _tthis_t _tspecies_t _tis_t _tlocated_t.
 
int Species_getConstant (const Species_t *s)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t.
 
const char * Species_getConversionFactor (const Species_t *s)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconversionFactor_t" _tattribute_t.
 
UnitDefinition_tSpecies_getDerivedUnitDefinition (Species_t *s)
 _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 _tSpecies_t_t _tstructure_t.
 
int Species_getHasOnlySubstanceUnits (const Species_t *s)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_thasOnlySubstanceUnits_t" _tattribute_t.
 
const char * Species_getId (const Species_t *s)
 _tTakes_t _ta_t _tSpecies_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.
 
double Species_getInitialAmount (const Species_t *s)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tinitialAmount_t" _tattribute_t.
 
double Species_getInitialConcentration (const Species_t *s)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tinitialConcentration_t" _tattribute_t.
 
const char * Species_getName (const Species_t *s)
 _tTakes_t _ta_t _tSpecies_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.
 
const XMLNamespaces_tSpecies_getNamespaces (Species_t *s)
 _tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tSpecies_t_t _tstructure_t.
 
const char * Species_getSpatialSizeUnits (const Species_t *s)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspatialSizeUnits_t" _tattribute_t.
 
const char * Species_getSpeciesType (const Species_t *s)
 _tGet_t _tthe_t _tspecies_t _ttype_t _tof_t _tthis_t _tSpecies_t_t _tstructure_t, _tas_t _tindicated_t _tby_t _tthe_t _tSpecies_t_t _tstructure_t'_ts_t "_tspeciesType_t" _tattribute_t _tvalue_t.
 
const char * Species_getSubstanceUnits (const Species_t *s)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsubstanceUnit_t" _tattribute_t.
 
const char * Species_getUnits (const Species_t *s)
 (_tSBML_t _tLevel_t _t1_t _tonly_t) _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tunits_t" _tattribute_t.
 
int Species_hasRequiredAttributes (Species_t *s)
 _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 _tSpecies_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
void Species_initDefaults (Species_t *s)
 _tInitializes_t _tthe_t _tattributes_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tto_t _tthe_t _tdefaults_t _tdefined_t _tin_t _tthe_t _tspecification_t _tof_t _tthe_t _trelevant_t _tLevel_t/_tVersion_t _tof_t _tSBML_t.
 
int Species_isSetBoundaryCondition (const Species_t *s)
 _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 _tattribute_t "_tboundaryCondition_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_isSetCharge (const Species_t *s)
 _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 _tattribute_t "_tcharge_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_isSetCompartment (const Species_t *s)
 _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 _tattribute_t "_tcompartment_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_isSetConstant (const Species_t *s)
 _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 _tattribute_t "_tconstant_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_isSetConversionFactor (const Species_t *s)
 _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 _tattribute_t "_tconversionFactor_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_isSetHasOnlySubstanceUnits (const Species_t *s)
 _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 _tattribute_t "_thasOnlySubstanceUnits_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_isSetId (const Species_t *s)
 _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 _tattribute_t "_tid_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_isSetInitialAmount (const Species_t *s)
 _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 _tattribute_t "_tinitialAmount_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_isSetInitialConcentration (const Species_t *s)
 _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 _tattribute_t "_tcompartment_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_isSetName (const Species_t *s)
 _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 _tattribute_t "_tname_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_isSetSpatialSizeUnits (const Species_t *s)
 _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 _tattribute_t "_tspatialSizeUnits_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_isSetSpeciesType (const Species_t *s)
 _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 _tattribute_t "_tspeciesType_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_isSetSubstanceUnits (const Species_t *s)
 _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 _tattribute_t "_tsubstanceUnits_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_isSetUnits (const Species_t *s)
 (_tSBML_t _tLevel_t _t1_t _tonly_t) _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 _tattribute_t "_tunits_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.
 
int Species_setBoundaryCondition (Species_t *s, int value)
 _tSets_t _tthe_t "_tboundaryCondition_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_setCharge (Species_t *s, int value)
 _tSets_t _tthe_t "_tcharge_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_setCompartment (Species_t *s, const char *sid)
 _tSets_t _tthe_t "_tcompartment_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_setConstant (Species_t *s, int value)
 _tSets_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_setConversionFactor (Species_t *s, const char *sid)
 _tSets_t _tthe_t "_tconversionFactor_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_setHasOnlySubstanceUnits (Species_t *s, int value)
 _tSets_t _tthe_t "_thasOnlySubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_setId (Species_t *s, const char *sid)
 _tSets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_setInitialAmount (Species_t *s, double value)
 _tSets_t _tthe_t "_tinitialAmount_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_setInitialConcentration (Species_t *s, double value)
 _tSets_t _tthe_t "_tinitialConcentration_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_setName (Species_t *s, const char *name)
 _tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_setSpatialSizeUnits (Species_t *s, const char *sid)
 _tSets_t _tthe_t "_tspatialSizeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_setSpeciesType (Species_t *s, const char *sid)
 _tSets_t _tthe_t "_tspeciesType_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_setSubstanceUnits (Species_t *s, const char *sid)
 _tSets_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_setUnits (Species_t *s, const char *sname)
 (_tSBML_t _tLevel_t _t1_t _tonly_t) _tSets_t _tthe_t "_tunits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetBoundaryCondition (Species_t *s)
 _tUnsets_t _tthe_t "_tboundaryCondition_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetCharge (Species_t *s)
 _tUnsets_t _tthe_t "_tcharge_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetCompartment (Species_t *s)
 _tUnsets_t _tthe_t "_tcompartment_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetConstant (Species_t *c)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetConversionFactor (Species_t *s)
 _tUnsets_t _tthe_t "_tconversionFactor_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetHasOnlySubstanceUnits (Species_t *s)
 _tUnsets_t _tthe_t "_thasOnlySubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetId (Species_t *s)
 _tUnsets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetInitialAmount (Species_t *s)
 _tUnsets_t _tthe_t "_tinitialAmount_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetInitialConcentration (Species_t *s)
 _tUnsets_t _tthe_t "_tinitialConcentration_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetName (Species_t *s)
 _tUnsets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetSpatialSizeUnits (Species_t *s)
 _tUnsets_t _tthe_t "_tspatialSizeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetSpeciesType (Species_t *s)
 _tUnsets_t _tthe_t "_tspeciesType_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetSubstanceUnits (Species_t *s)
 _tUnsets_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 
int Species_unsetUnits (Species_t *s)
 _tUnsets_t _tthe_t "_tunits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.
 

Detailed Description

Definitions of Species_t and ListOfSpecies_t.

Author
Ben Bornstein

Function Documentation

◆ ListOfSpecies_getById()

Species_t * ListOfSpecies_getById ( ListOf_t lo,
const char *  sid 
)

_tReturns_t _tthe_t _tSpecies_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.

@_tparam_t _tlo_t _tthe_t _tListOfSpecies_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 _tListOfSpecies_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 _tListOfSpecies_t_t

◆ ListOfSpecies_removeById()

Species_t * ListOfSpecies_removeById ( ListOf_t lo,
const char *  sid 
)

_tRemoves_t _ta_t _tSpecies_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 _tSpecies_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 _tSpecies_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 _tListOfSpecies_t_t

◆ Species_clone()

Species_t * Species_clone ( const Species_t s)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

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

@_tmemberof_t _tSpecies_t_t

◆ Species_create()

Species_t * Species_create ( unsigned int  level,
unsigned int  version 
)

@_tclass_t _tdoc_warning_species_spatialSizeUnits_t

@_twarning_t <_tspan_t _tclass_t="_twarning_t">_tIn_t _tversions_t _tof_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tbefore_t _tVersion_t&_tnbsp_t;_t3_t, _tthe_t _tclass_t _tSpecies_t _tincluded_t _tan_t _tattribute_t _tcalled_t "_tspatialSizeUnits_t", _twhich_t _tallowed_t _texplicitly_t _tsetting_t _tthe_t _tunits_t _tof_t _tsize_t _tfor_t _tinitial_t _tconcentration_t. _tThis_t _tattribute_t _twas_t _tremoved_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t3_t. _tLibSBML_t _tretains_t _tthis_t _tattribute_t _tfor_t _tcompatibility_t _twith_t _tolder_t _tdefinitions_t _tof_t _tLevel_t&_tnbsp_t;_t2_t, _tbut_t _tits_t _tuse_t _tis_t _tstrongly_t _tdiscouraged_t _tbecause_t _tit_t _tis_t _tincompatible_t _twith_t _tlevels_t _tand_t _tversions_t _tof_t _tSBML_t _tbeyond_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t2_t.</_tspan_t>

@_tclass_t _tdoc_note_species_units_t

@_tnote_t _tThe_t "_tunits_t" _tattribute_t _tis_t _tdefined_t _tonly_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t. _tIn_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tand_t _tLevel_t&_tnbsp_t;_t3_t, _tit_t _thas_t _tbeen_t _treplaced_t _tby_t _ta_t _tcombination_t _tof_t "_tsubstanceUnits_t" _tand_t _tthe_t _tunits_t _tof_t _tthe_t _tCompartment_t _tobject_t _tin_t _twhich_t _ta_t _tspecies_t _tis_t _tlocated_t. _tIn_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersions_t&_tnbsp_t;_t1_t&_tndash_t;_t2_t, _tan_t _tadditional_t _tattribute_t "_tspatialSizeUnits_t" _thelps_t _tdetermine_t _tthe_t _tunits_t _tof_t _tthe_t _tspecies_t _tquantity_t, _tbut_t _tthis_t _tattribute_t _twas_t _tremoved_t _tin_t _tlater_t _tversions_t _tof_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t.

@_tclass_t _tdoc_note_charge_deprecated_t

@_tnote_t _tBeginning_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersion_t&_tnbsp_t;_t2_t, _tthe_t "_tcharge_t" _tattribute_t _ton_t _tSpecies_t _tis_t _tdeprecated_t _tand_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t _tit_t _tdoes_t _tnot_t _texist_t _tat_t _tall_t. _tIts_t _tuse_t _tstrongly_t _tdiscouraged_t. _tIts_t _tpresence_t _tis_t _tconsidered_t _ta_t _tmisfeature_t _tin_t _tearlier_t _tdefinitions_t _tof_t _tSBML_t _tbecause_t _tits_t _timplications_t _tfor_t _tthe_t _tmathematics_t _tof_t _ta_t _tmodel_t _twere_t _tnever_t _tdefined_t, _tand_t _tin_t _tany_t _tcase_t, _tno_t _tknown_t _tmodeling_t _tsystem_t _tever_t _tused_t _tit_t. _tInstead_t, _tmodels_t _ttake_t _taccount_t _tof_t _tcharge_t _tvalues_t _tdirectly_t _tin_t _ttheir_t _tdefinitions_t _tof_t _tspecies_t _tby_t (_tfor_t _texample_t) _thaving_t _tseparate_t _tspecies_t _tidentities_t _tfor_t _tthe_t _tcharged_t _tand_t _tuncharged_t _tversions_t _tof_t _tthe_t _tsame_t _tspecies_t. _tThis_t _tallows_t _tthe_t _tcondition_t _tto_t _taffect_t _tmodel_t _tmathematics_t _tdirectly_t. _tLibSBML_t _tretains_t _tthis_t _tmethod_t _tfor_t _teasier_t _tcompatibility_t _twith_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t.

_tCreates_t _ta_t _tnew_t _tSpecies_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 _tSpecies_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 _tSpecies_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tSpecies_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tSpecies_t_t

@_tclass_t _tdoc_warning_species_spatialSizeUnits_t

@_tcond_t _tdoxygenIgnored_t

◆ Species_createWithNS()

Species_t * Species_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tSpecies_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 _tSpecies_t_t.

@_treturn_t _ta_t _tpointer_t _tto_t _tthe_t _tnewly_t _tcreated_t _tSpecies_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tSpecies_t_t

◆ Species_free()

void Species_free ( Species_t s)

_tFrees_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getBoundaryCondition()

int Species_getBoundaryCondition ( const Species_t s)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tboundaryCondition_t" _tattribute_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _tthe_t _tvalue_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t'_ts_t "_tboundaryCondition_t" _tattribute_t _tvalue_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getCharge()

int Species_getCharge ( const Species_t s)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcharge_t" _tattribute_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t _tthe_t _tcharge_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tnote_t _tBeginning_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t&_tnbsp_t;_t2_t, _tthe_t "_tcharge_t" _tattribute_t _ton_t _tSpecies_t_t _tis_t _tdeprecated_t _tand_t _tits_t _tuse_t _tstrongly_t _tdiscouraged_t. _tIts_t _tpresence_t _tis_t _tconsidered_t _ta_t _tmisfeature_t _tin_t _tearlier_t _tdefinitions_t _tof_t _tSBML_t _tbecause_t _tits_t _timplications_t _tfor_t _tthe_t _tmathematics_t _tof_t _ta_t _tmodel_t _twere_t _tnever_t _tdefined_t, _tand_t _tin_t _tany_t _tcase_t, _tno_t _tknown_t _tmodeling_t _tsystem_t _tever_t _tused_t _tit_t. _tInstead_t, _tmodels_t _ttake_t _taccount_t _tof_t _tcharge_t _tvalues_t _tdirectly_t _tin_t _ttheir_t _tdefinitions_t _tof_t _tspecies_t _tby_t (_tfor_t _texample_t) _thaving_t _tseparate_t _tspecies_t _tidentities_t _tfor_t _tthe_t _tcharged_t _tand_t _tuncharged_t _tversions_t _tof_t _tthe_t _tsame_t _tspecies_t. _tThis_t _tallows_t _tthe_t _tcondition_t _tto_t _taffect_t _tmodel_t _tmathematics_t _tdirectly_t. _tLibSBML_t _tretains_t _tthis_t _tmethod_t _tfor_t _teasier_t _tcompatibility_t _twith_t _tSBML_t _tLevel_t _t1_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getCompartment()

const char * Species_getCompartment ( const Species_t s)

_tGet_t _tthe_t _tcompartment_t _tin_t _twhich_t _tthis_t _tspecies_t _tis_t _tlocated_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartment_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t, _tas_t _ta_t _tstring_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getConstant()

int Species_getConstant ( const Species_t s)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _tthe_t _tvalue_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t'_ts_t "_tconstant_t" _tattribute_t _tvalue_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getConversionFactor()

const char * Species_getConversionFactor ( const Species_t s)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconversionFactor_t" _tattribute_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t _tthe_t "_tconversionFactor_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t, _tas_t _ta_t _tstring_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getDerivedUnitDefinition()

UnitDefinition_t * Species_getDerivedUnitDefinition ( Species_t s)

_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 _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_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 _tSpecies_t_t _tstrucuture_t.

@_tnote_t _tThis_t _tfunction_t _treturns_t _tthe_t _tunits_t _tof_t _tthe_t _tSpecies_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 _tor_t _tthose_t _tderived_t _tfrom_t _tthe_t _tdefault_t _tunits_t _tof_t _tthe_t _tModel_t_t _tcontaining_t _tthis_t _tSpecies_t_t _tand_t _tit_t'_ts_t _tCompartment_t_t.

_tNote_t _tthat_t _tthe_t _tfunctionality_t _tthat_t _tfacilitates_t _tunit_t _tanalysis_t _tdepends_t _ton_t _tthe_t _tmodel_t _tas_t _ta_t _twhole_t. _tThus_t, _tin_t _tcases_t _twhere_t _tthe_t _tstructure_t _thas_t _tnot_t _tbeen_t _tadded_t _tto_t _ta_t _tmodel_t _tor_t _tthe_t _tmodel_t _titself_t _tis_t _tincomplete_t, _tunit_t _tanalysis_t _tis_t _tnot_t _tpossible_t _tand_t _tthis_t _tmethod_t _twill_t _treturn_t @_tc_t _tNULL_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getHasOnlySubstanceUnits()

int Species_getHasOnlySubstanceUnits ( const Species_t s)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_thasOnlySubstanceUnits_t" _tattribute_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tor_t @_tc_t _t0_t (_tfalse_t) _tdepending_t _ton_t _tthe_t _tvalue_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t'_ts_t "_thasOnlySubstanceUnits_t" _tattribute_t _tvalue_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getId()

const char * Species_getId ( const Species_t s)

_tTakes_t _ta_t _tSpecies_t_t _tstructure_t _tand_t _treturns_t _tits_t _tidentifier_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _twhose_t _tidentifier_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tidentifier_t _tof_t _tthe_t _tSpecies_t_t _tstructure_t @_tp_t _ts_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getInitialAmount()

double Species_getInitialAmount ( const Species_t s)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tinitialAmount_t" _tattribute_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t _tthe_t "_tinitialAmount_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t, _tas_t _ta_t _tfloating_t _tpoint_t _tnumber_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getInitialConcentration()

double Species_getInitialConcentration ( const Species_t s)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tinitialConcentration_t" _tattribute_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t _tthe_t "_tinitialConcentration_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t, _tas_t _ta_t _tfloating_t _tpoint_t _tnumber_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getName()

const char * Species_getName ( const Species_t s)

_tTakes_t _ta_t _tSpecies_t_t _tstructure_t _tand_t _treturns_t _tits_t _tname_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _twhose_t _tname_t _tis_t _tsought_t.

@_treturn_t _tthe_t _tname_t _tof_t _tthe_t _tSpecies_t_t _tstructure_t @_tp_t _ts_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getNamespaces()

const XMLNamespaces_t * Species_getNamespaces ( Species_t s)

_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tassociated_t _twith_t _tthis_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_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 _tSpecies_t_t

◆ Species_getSpatialSizeUnits()

const char * Species_getSpatialSizeUnits ( const Species_t s)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspatialSizeUnits_t" _tattribute_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t _tthe_t _tspatialSizeUnits_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t.

@_tcopydetails_t _tdoc_warning_species_spatialSizeUnits_t

@_tmemberof_t _tSpecies_t_t

◆ Species_getSpeciesType()

const char * Species_getSpeciesType ( const Species_t s)

_tGet_t _tthe_t _tspecies_t _ttype_t _tof_t _tthis_t _tSpecies_t_t _tstructure_t, _tas_t _tindicated_t _tby_t _tthe_t _tSpecies_t_t _tstructure_t'_ts_t "_tspeciesType_t" _tattribute_t _tvalue_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspeciesType_t" _tattribute_t _tof_t _tthe_t _tSpecies_t_t _tstructure_t @_tp_t _ts_t _tas_t _ta_t _tstring_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getSubstanceUnits()

const char * Species_getSubstanceUnits ( const Species_t s)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsubstanceUnit_t" _tattribute_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t, _tas_t _ta_t _tstring_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_getUnits()

const char * Species_getUnits ( const Species_t s)

(_tSBML_t _tLevel_t _t1_t _tonly_t) _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tunits_t" _tattribute_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t _tthe_t _tunits_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_hasRequiredAttributes()

int Species_hasRequiredAttributes ( Species_t s)

_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 _tSpecies_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

_tThe_t _trequired_t _tattributes_t _tfor_t _ta_t _tSpecies_t_t _tstructure_t _tare_t: @_tli_t _tid_t (_tname_t _tL1_t) @_tli_t _tcompartment_t @_tli_t _tinitialAmount_t (_tL1_t _tonly_t) @_tli_t _thasOnlySubstanceUnits_t (_tL3_t _ton_t) @_tli_t _tboundaryCondition_t (_tL3_t _ton_t) @_tli_t _tconstant_t (_tL3_t _ton_t)

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _tto_t _tcheck_t.

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

@_tmemberof_t _tSpecies_t_t

◆ Species_initDefaults()

void Species_initDefaults ( Species_t s)

_tInitializes_t _tthe_t _tattributes_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tto_t _tthe_t _tdefaults_t _tdefined_t _tin_t _tthe_t _tspecification_t _tof_t _tthe_t _trelevant_t _tLevel_t/_tVersion_t _tof_t _tSBML_t.

@_tli_t _tsets_t "_tboundaryCondition_t" _tto_t @_tc_t _ttrue_t @_tli_t (_tLevel_t _t2_t _tonly_t) _tsets_t "_tconstant_t" _tto_t @_tc_t _tfalse_t @_tli_t (_tLevel_t _t2_t _tonly_t) _tsets_t "_thasOnlySubstanceUnits_t" _tto_t @_tc_t _tfalse_t

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetBoundaryCondition()

int Species_isSetBoundaryCondition ( const Species_t s)

_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 _tattribute_t "_tboundaryCondition_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tboundaryCondition_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetCharge()

int Species_isSetCharge ( const Species_t s)

_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 _tattribute_t "_tcharge_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tcharge_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tBeginning_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t&_tnbsp_t;_t2_t, _tthe_t "_tcharge_t" _tattribute_t _ton_t _tSpecies_t_t _tin_t _tSBML_t _tis_t _tdeprecated_t _tand_t _tits_t _tuse_t _tstrongly_t _tdiscouraged_t. _tIts_t _tpresence_t _tis_t _tconsidered_t _ta_t _tmisfeature_t _tin_t _tearlier_t _tdefinitions_t _tof_t _tSBML_t _tbecause_t _tits_t _timplications_t _tfor_t _tthe_t _tmathematics_t _tof_t _ta_t _tmodel_t _twere_t _tnever_t _tdefined_t, _tand_t _tin_t _tany_t _tcase_t, _tno_t _tknown_t _tmodeling_t _tsystem_t _tever_t _tused_t _tit_t. _tInstead_t, _tmodels_t _ttake_t _taccount_t _tof_t _tcharge_t _tvalues_t _tdirectly_t _tin_t _ttheir_t _tdefinitions_t _tof_t _tspecies_t _tby_t (_tfor_t _texample_t) _thaving_t _tseparate_t _tspecies_t _tidentities_t _tfor_t _tthe_t _tcharged_t _tand_t _tuncharged_t _tversions_t _tof_t _tthe_t _tsame_t _tspecies_t. _tThis_t _tallows_t _tthe_t _tcondition_t _tto_t _taffect_t _tmodel_t _tmathematics_t _tdirectly_t. _tLibSBML_t _tretains_t _tthis_t _tmethod_t _tfor_t _teasier_t _tcompatibility_t _twith_t _tSBML_t _tLevel_t _t1_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetCompartment()

int Species_isSetCompartment ( const Species_t s)

_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 _tattribute_t "_tcompartment_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tcompartment_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetConstant()

int Species_isSetConstant ( const Species_t s)

_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 _tattribute_t "_tconstant_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetConversionFactor()

int Species_isSetConversionFactor ( const Species_t s)

_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 _tattribute_t "_tconversionFactor_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tconversionFactor_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetHasOnlySubstanceUnits()

int Species_isSetHasOnlySubstanceUnits ( const Species_t s)

_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 _tattribute_t "_thasOnlySubstanceUnits_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_thasOnlySubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetId()

int Species_isSetId ( const Species_t s)

_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 _tattribute_t "_tid_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

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

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetInitialAmount()

int Species_isSetInitialAmount ( const Species_t s)

_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 _tattribute_t "_tinitialAmount_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tinitialAmount_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tIn_t _tSBML_t _tLevel_t _t1_t, _tSpecies_t_t' "_tinitialAmount_t" _tis_t _trequired_t _tand_t _ttherefore_t <_tem_t>_tshould_t _talways_t _tbe_t _tset_t</_tem_t>. (_tHowever_t, _tin_t _tLevel_t _t1_t, _tthe_t _tattribute_t _thas_t _tno_t _tdefault_t _tvalue_t _teither_t, _tso_t _tthis_t _tmethod_t _twill_t _tnot_t _treturn_t _tnonzero_t _tuntil_t _ta_t _tvalue_t _thas_t _tbeen_t _tassigned_t.) _tIn_t _tSBML_t _tLevel_t _t2_t, "_tinitialAmount_t" _tis_t _toptional_t _tand_t _tas_t _tsuch_t _tmay_t _tor_t _tmay_t _tnot_t _tbe_t _tset_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetInitialConcentration()

int Species_isSetInitialConcentration ( const Species_t s)

_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 _tattribute_t "_tcompartment_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tcompartment_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetName()

int Species_isSetName ( const Species_t s)

_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 _tattribute_t "_tname_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

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

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetSpatialSizeUnits()

int Species_isSetSpatialSizeUnits ( const Species_t s)

_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 _tattribute_t "_tspatialSizeUnits_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tspatialSizeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tcopydetails_t _tdoc_warning_species_spatialSizeUnits_t

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetSpeciesType()

int Species_isSetSpeciesType ( const Species_t s)

_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 _tattribute_t "_tspeciesType_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tspeciesType_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetSubstanceUnits()

int Species_isSetSubstanceUnits ( const Species_t s)

_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 _tattribute_t "_tsubstanceUnits_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_isSetUnits()

int Species_isSetUnits ( const Species_t s)

(_tSBML_t _tLevel_t _t1_t _tonly_t) _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 _tattribute_t "_tunits_t" _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tunits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_setBoundaryCondition()

int Species_setBoundaryCondition ( Species_t s,
int  value 
)

_tSets_t _tthe_t "_tboundaryCondition_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tvalue_t @_tc_t _tnonzero_t _tto_t _tindicate_t _ttrue_t, @_tc_t _tzero_t _tto_t _tindicate_t _tfalse_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 _tSpecies_t_t

◆ Species_setCharge()

int Species_setCharge ( Species_t s,
int  value 
)

_tSets_t _tthe_t "_tcharge_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tvalue_t _tthe_t _tvalue_t _tof_t _tcharge_t _tto_t _tassign_t _tto_t _tthe_t "_tcharge_t" _tattribute_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tnote_t _tBeginning_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t&_tnbsp_t;_t2_t, _tthe_t "_tcharge_t" _tattribute_t _ton_t _tSpecies_t_t _tin_t _tSBML_t _tis_t _tdeprecated_t _tand_t _tits_t _tuse_t _tstrongly_t _tdiscouraged_t. _tIts_t _tpresence_t _tis_t _tconsidered_t _ta_t _tmisfeature_t _tin_t _tearlier_t _tdefinitions_t _tof_t _tSBML_t _tbecause_t _tits_t _timplications_t _tfor_t _tthe_t _tmathematics_t _tof_t _ta_t _tmodel_t _twere_t _tnever_t _tdefined_t, _tand_t _tin_t _tany_t _tcase_t, _tno_t _tknown_t _tmodeling_t _tsystem_t _tever_t _tused_t _tit_t. _tInstead_t, _tmodels_t _ttake_t _taccount_t _tof_t _tcharge_t _tvalues_t _tdirectly_t _tin_t _ttheir_t _tdefinitions_t _tof_t _tspecies_t _tby_t (_tfor_t _texample_t) _thaving_t _tseparate_t _tspecies_t _tidentities_t _tfor_t _tthe_t _tcharged_t _tand_t _tuncharged_t _tversions_t _tof_t _tthe_t _tsame_t _tspecies_t. _tThis_t _tallows_t _tthe_t _tcondition_t _tto_t _taffect_t _tmodel_t _tmathematics_t _tdirectly_t. _tLibSBML_t _tretains_t _tthis_t _tmethod_t _tfor_t _teasier_t _tcompatibility_t _twith_t _tSBML_t _tLevel_t _t1_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_setCompartment()

int Species_setCompartment ( Species_t s,
const char *  sid 
)

_tSets_t _tthe_t "_tcompartment_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tcompartment_t. _tIf_t _tthe_t _tstring_t _tis_t @_tc_t _tNULL_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tSpecies_unsetCompartment_t().

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifer_t _tto_t _twhich_t _tthe_t "_tcompartment_t" _tattribute_t _tshould_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}

@_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 "_tcompartment_t" _tattribute_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_setConstant()

int Species_setConstant ( Species_t s,
int  value 
)

_tSets_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tvalue_t @_tc_t _tnonzero_t _tto_t _tindicate_t _ttrue_t, @_tc_t _tzero_t _tto_t _tindicate_t _tfalse_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSpecies_t_t

◆ Species_setConversionFactor()

int Species_setConversionFactor ( Species_t s,
const char *  sid 
)

_tSets_t _tthe_t "_tconversionFactor_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tsid_t. _tIf_t _tthe_t _tstring_t _tis_t @_tc_t _tNULL_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tSpecies_unsetConversionFactor_t().

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifer_t _tto_t _twhich_t _tthe_t "_tconversionFactor_t" _tattribute_t _tshould_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_UNEXPECTED_ATTRIBUTE_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 "_tconversionFactor_t" _tattribute_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_setHasOnlySubstanceUnits()

int Species_setHasOnlySubstanceUnits ( Species_t s,
int  value 
)

_tSets_t _tthe_t "_thasOnlySubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tvalue_t @_tc_t _tnonzero_t _tto_t _tindicate_t _ttrue_t, @_tc_t _tzero_t _tto_t _tindicate_t _tfalse_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSpecies_t_t

◆ Species_setId()

int Species_setId ( Species_t s,
const char *  sid 
)

_tSets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tsid_t. _tIf_t _tthe_t _tstring_t _tis_t @_tc_t _tNULL_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tSpecies_unsetId_t().

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifier_t _tstring_t _tto_t _twhich_t _tthe_t "_tid_t" _tattribute_t _tshould_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}

@_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 _tSpecies_t_t

◆ Species_setInitialAmount()

int Species_setInitialAmount ( Species_t s,
double  value 
)

_tSets_t _tthe_t "_tinitialAmount_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

_tAs_t _ta_t _tside_t-_teffect_t, _tcalling_t _tthis_t _tfunction_t _talso_t _tunsets_t _tthe_t "_tinitialConcentration_t" _tattribute_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tvalue_t _tthe_t _tnumerical_t _tvalue_t _tfor_t _tthe_t "_tinitialAmount_t" _tattribute_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 _tSpecies_t_t

◆ Species_setInitialConcentration()

int Species_setInitialConcentration ( Species_t s,
double  value 
)

_tSets_t _tthe_t "_tinitialConcentration_t" _tattribute_t _tvalue_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

_tAs_t _ta_t _tside_t-_teffect_t, _tcalling_t _tthis_t _tfunction_t _talso_t _tunsets_t _tthe_t "_tinitialAmount_t" _tattribute_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tvalue_t _tthe_t _tnumerical_t _tvalue_t _tfor_t _tthe_t "_tinitialConcentration_t" _tattribute_t.

@_tcopydetails_t _tdoc_returns_success_code_t @_tli_t @_tsbmlconstant_t{_tLIBSBML_OPERATION_SUCCESS_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tSpecies_t_t

◆ Species_setName()

int Species_setName ( Species_t s,
const char *  name 
)

_tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tname_t. _tIf_t _tthe_t _tstring_t _tis_t @_tc_t _tNULL_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tSpecies_unsetName_t().

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tname_t _tthe_t _tname_t _tstring_t _tto_t _twhich_t _tthe_t "_tname_t" _tattribute_t _tshould_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}

@_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 _tSpecies_t_t

◆ Species_setSpatialSizeUnits()

int Species_setSpatialSizeUnits ( Species_t s,
const char *  sid 
)

_tSets_t _tthe_t "_tspatialSizeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tsid_t. _tIf_t _tthe_t _tstring_t _tis_t @_tc_t _tNULL_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tSpecies_unsetSpatialSizeUnits_t().

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifer_t _tto_t _twhich_t _tthe_t "_tspatialSizeUnits_t" _tattribute_t _tshould_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_UNEXPECTED_ATTRIBUTE_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 "_tspatialSizeUnits_t" _tattribute_t.

@_tcopydetails_t _tdoc_warning_species_spatialSizeUnits_t

@_tmemberof_t _tSpecies_t_t

◆ Species_setSpeciesType()

int Species_setSpeciesType ( Species_t s,
const char *  sid 
)

_tSets_t _tthe_t "_tspeciesType_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tsid_t. _tIf_t _tthe_t _tstring_t _tis_t @_tc_t _tNULL_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tSpecies_unsetSpeciesType_t().

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifer_t _tto_t _twhich_t _tthe_t "_tspeciesType_t" _tattribute_t _tshould_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_UNEXPECTED_ATTRIBUTE_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 "_tspeciesType_t" _tattribute_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_setSubstanceUnits()

int Species_setSubstanceUnits ( Species_t s,
const char *  sid 
)

_tSets_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tsid_t. _tIf_t _tthe_t _tstring_t _tis_t @_tc_t _tNULL_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tSpecies_unsetSubstanceUnits_t().

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifer_t _tto_t _twhich_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tshould_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}

@_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 "_tsubstanceUnits_t" _tattribute_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_setUnits()

int Species_setUnits ( Species_t s,
const char *  sname 
)

(_tSBML_t _tLevel_t _t1_t _tonly_t) _tSets_t _tthe_t "_tunits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

_tThis_t _tfunction_t _tcopies_t _tthe_t _tstring_t _tgiven_t _tin_t @_tp_t _tsid_t. _tIf_t _tthe_t _tstring_t _tis_t @_tc_t _tNULL_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tSpecies_unsetUnits_t().

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tsname_t _tthe_t _tidentifer_t _tto_t _twhich_t _tthe_t "_tunits_t" _tattribute_t _tshould_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}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _tan_t @_tp_t _tsname_t _tof_t _tNULL_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tunits_t" _tattribute_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_unsetBoundaryCondition()

int Species_unsetBoundaryCondition ( Species_t s)

_tUnsets_t _tthe_t "_tboundaryCondition_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _twhose_t _tattribute_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 _tSpecies_t_t

◆ Species_unsetCharge()

int Species_unsetCharge ( Species_t s)

_tUnsets_t _tthe_t "_tcharge_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _twhose_t _tattribute_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}

@_tnote_t _tBeginning_t _tin_t _tSBML_t _tLevel_t _t2_t _tVersion_t&_tnbsp_t;_t2_t, _tthe_t "_tcharge_t" _tattribute_t _ton_t _tSpecies_t_t _tin_t _tSBML_t _tis_t _tdeprecated_t _tand_t _tits_t _tuse_t _tstrongly_t _tdiscouraged_t. _tIts_t _tpresence_t _tis_t _tconsidered_t _ta_t _tmisfeature_t _tin_t _tearlier_t _tdefinitions_t _tof_t _tSBML_t _tbecause_t _tits_t _timplications_t _tfor_t _tthe_t _tmathematics_t _tof_t _ta_t _tmodel_t _twere_t _tnever_t _tdefined_t, _tand_t _tin_t _tany_t _tcase_t, _tno_t _tknown_t _tmodeling_t _tsystem_t _tever_t _tused_t _tit_t. _tInstead_t, _tmodels_t _ttake_t _taccount_t _tof_t _tcharge_t _tvalues_t _tdirectly_t _tin_t _ttheir_t _tdefinitions_t _tof_t _tspecies_t _tby_t (_tfor_t _texample_t) _thaving_t _tseparate_t _tspecies_t _tidentities_t _tfor_t _tthe_t _tcharged_t _tand_t _tuncharged_t _tversions_t _tof_t _tthe_t _tsame_t _tspecies_t. _tThis_t _tallows_t _tthe_t _tcondition_t _tto_t _taffect_t _tmodel_t _tmathematics_t _tdirectly_t. _tLibSBML_t _tretains_t _tthis_t _tmethod_t _tfor_t _teasier_t _tcompatibility_t _twith_t _tSBML_t _tLevel_t _t1_t.

@_tmemberof_t _tSpecies_t_t

◆ Species_unsetCompartment()

int Species_unsetCompartment ( Species_t s)

_tUnsets_t _tthe_t "_tcompartment_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _twhose_t _tattribute_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 _tSpecies_t_t

◆ Species_unsetConstant()

int Species_unsetConstant ( Species_t c)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tSpecies_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 _tSpecies_t_t

◆ Species_unsetConversionFactor()

int Species_unsetConversionFactor ( Species_t s)

_tUnsets_t _tthe_t "_tconversionFactor_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _twhose_t _tattribute_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 _tSpecies_t_t

◆ Species_unsetHasOnlySubstanceUnits()

int Species_unsetHasOnlySubstanceUnits ( Species_t s)

_tUnsets_t _tthe_t "_thasOnlySubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _twhose_t _tattribute_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 _tSpecies_t_t

◆ Species_unsetId()

int Species_unsetId ( Species_t s)

_tUnsets_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_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}

@_tmemberof_t _tSpecies_t_t

◆ Species_unsetInitialAmount()

int Species_unsetInitialAmount ( Species_t s)

_tUnsets_t _tthe_t "_tinitialAmount_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _twhose_t _tattribute_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 _tSpecies_t_t

◆ Species_unsetInitialConcentration()

int Species_unsetInitialConcentration ( Species_t s)

_tUnsets_t _tthe_t "_tinitialConcentration_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _twhose_t _tattribute_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 _tSpecies_t_t

◆ Species_unsetName()

int Species_unsetName ( Species_t s)

_tUnsets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_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}

@_tmemberof_t _tSpecies_t_t

◆ Species_unsetSpatialSizeUnits()

int Species_unsetSpatialSizeUnits ( Species_t s)

_tUnsets_t _tthe_t "_tspatialSizeUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _twhose_t _tattribute_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}

@_tcopydetails_t _tdoc_warning_species_spatialSizeUnits_t

@_tmemberof_t _tSpecies_t_t

◆ Species_unsetSpeciesType()

int Species_unsetSpeciesType ( Species_t s)

_tUnsets_t _tthe_t "_tspeciesType_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _twhose_t _tattribute_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 _tSpecies_t_t

◆ Species_unsetSubstanceUnits()

int Species_unsetSubstanceUnits ( Species_t s)

_tUnsets_t _tthe_t "_tsubstanceUnits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _twhose_t _tattribute_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 _tSpecies_t_t

◆ Species_unsetUnits()

int Species_unsetUnits ( Species_t s)

_tUnsets_t _tthe_t "_tunits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tSpecies_t_t _tstructure_t.

@_tparam_t _ts_t _tthe_t _tSpecies_t_t _tstructure_t _twhose_t _tattribute_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 _tSpecies_t_t