libSBML C API  libSBML 5.20.4 C API
Loading...
Searching...
No Matches
Compartment.cpp File Reference

Implementations of Compartment_t and ListOfCompartments_t. More...

Include dependency graph for Compartment.cpp:

Functions

Compartment_tCompartment_clone (const Compartment_t *c)
 _tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
Compartment_tCompartment_create (unsigned int level, unsigned int version)
 @_tendcond_t
 
Compartment_tCompartment_createWithNS (SBMLNamespaces_t *sbmlns)
 _tCreates_t _ta_t _tnew_t _tCompartment_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t, @_tp_t _tsbmlns_t.
 
void Compartment_free (Compartment_t *c)
 _tFrees_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
const char * Compartment_getCompartmentType (const Compartment_t *c)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_getConstant (const Compartment_t *c)
 _tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
UnitDefinition_tCompartment_getDerivedUnitDefinition (Compartment_t *c)
 _tConstructs_t _tand_t _treturns_t _ta_t _tUnitDefinition_t _tthat_t _tcorresponds_t _tto_t _tthe_t _tunits_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t _tdesignated_t _tsize_t.
 
const char * Compartment_getId (const Compartment_t *c)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
const char * Compartment_getName (const Compartment_t *c)
 _tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
const XMLNamespaces_tCompartment_getNamespaces (Compartment_t *c)
 _tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tstructures_t _tassociated_t _twith_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
const char * Compartment_getOutside (const Compartment_t *c)
 _tGet_t _tthe_t _tidentifier_t, _tif_t _tany_t, _tof_t _tthe_t _tcompartment_t _tthat_t _tis_t _tdesignated_t _tas_t _tbeing_t _toutside_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
double Compartment_getSize (const Compartment_t *c)
 _tGet_t _tthe_t _tsize_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
unsigned int Compartment_getSpatialDimensions (const Compartment_t *c)
 _tGet_t _tthe_t _tnumber_t _tof_t _tspatial_t _tdimensions_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
double Compartment_getSpatialDimensionsAsDouble (const Compartment_t *c)
 _tGet_t _tthe_t _tnumber_t _tof_t _tspatial_t _tdimensions_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t, _tas_t _ta_t _tdouble_t.
 
const char * Compartment_getUnits (const Compartment_t *c)
 _tGet_t _tthe_t _tunits_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t _tsize_t.
 
double Compartment_getVolume (const Compartment_t *c)
 _tGet_t _tthe_t _tvolume_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_hasRequiredAttributes (Compartment_t *c)
 _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 _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t _thave_t _tbeen_t _tset_t.
 
void Compartment_initDefaults (Compartment_t *c)
 _tInitializes_t _tthe_t _tfields_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t _tto_t "_ttypical_t" _tdefault_t _tvalues_t.
 
int Compartment_isSetCompartmentType (const Compartment_t *c)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tcompartmentType_t" _tattribute_t _tis_t _tset_t.
 
int Compartment_isSetConstant (const Compartment_t *c)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tconstant_t" _tattribute_t _tis_t _tset_t.
 
int Compartment_isSetId (const Compartment_t *c)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tid_t" _tattribute_t _tis_t _tset_t.
 
int Compartment_isSetName (const Compartment_t *c)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tname_t" _tattribute_t _tis_t _tset_t.
 
int Compartment_isSetOutside (const Compartment_t *c)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_toutside_t" _tattribute_t _tis_t _tset_t.
 
int Compartment_isSetSize (const Compartment_t *c)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tsize_t" _tattribute_t _tis_t _tset_t.
 
int Compartment_isSetSpatialDimensions (const Compartment_t *c)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tspatialDimensions_t" _tattribute_t _tis_t _tset_t.
 
int Compartment_isSetUnits (const Compartment_t *c)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tunits_t" _tattribute_t _tis_t _tset_t.
 
int Compartment_isSetVolume (const Compartment_t *c)
 _tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructures_t'_ts_t "_tvolume_t" _tattribute_t _tis_t _tset_t.
 
int Compartment_setCompartmentType (Compartment_t *c, const char *sid)
 _tSets_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_setConstant (Compartment_t *c, int value)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_setId (Compartment_t *c, const char *sid)
 _tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_setName (Compartment_t *c, const char *name)
 _tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_setOutside (Compartment_t *c, const char *sid)
 _tSets_t _tthe_t "_toutside_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_setSize (Compartment_t *c, double value)
 _tSets_t _tthe_t "_tsize_t" _tattribute_t (_tor_t "_tvolume_t" _tin_t _tSBML_t _tLevel_t _t1_t) _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_setSpatialDimensions (Compartment_t *c, unsigned int value)
 _tSets_t _tthe_t "_tspatialDimensions_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_setSpatialDimensionsAsDouble (Compartment_t *c, double value)
 _tSets_t _tthe_t "_tspatialDimensions_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_setUnits (Compartment_t *c, const char *sid)
 _tSets_t _tthe_t "_tunits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_setVolume (Compartment_t *c, double value)
 _tSets_t _tthe_t "_tvolume_t" _tattribute_t (_tor_t "_tsize_t" _tin_t _tSBML_t _tLevel_t _t2_t) _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_unsetCompartmentType (Compartment_t *c)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_unsetConstant (Compartment_t *c)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_unsetName (Compartment_t *c)
 _tUnsets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_unsetOutside (Compartment_t *c)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_toutside_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_unsetSize (Compartment_t *c)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsize_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_unsetSpatialDimensions (Compartment_t *c)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspatialDimensions_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_unsetUnits (Compartment_t *c)
 _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tunits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
int Compartment_unsetVolume (Compartment_t *c)
 (_tFor_t _tSBML_t _tLevel_t _t1_t) _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvolume_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.
 
Compartment_tListOfCompartments_getById (ListOf_t *lo, const char *sid)
 _tReturns_t _tthe_t _tCompartment_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.
 
Compartment_tListOfCompartments_removeById (ListOf_t *lo, const char *sid)
 _tRemoves_t _ta_t _tCompartment_t_t _tstructure_t _tbased_t _ton_t _tits_t _tidentifier_t.
 

Detailed Description

Implementations of Compartment_t and ListOfCompartments_t.

Author
Ben Bornstein

Function Documentation

◆ Compartment_clone()

Compartment_t * Compartment_clone ( const Compartment_t c)

_tCreates_t _ta_t _tdeep_t _tcopy_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t _tto_t _tbe_t _tcopied_t.

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

@_tmemberof_t _tCompartment_t_t

◆ Compartment_create()

Compartment_t * Compartment_create ( unsigned int  level,
unsigned int  version 
)

@_tendcond_t

@_tclass_t _tdoc_compartment_units_t

@_tcond_t _tdoxygenIgnored_t

◆ Compartment_createWithNS()

Compartment_t * Compartment_createWithNS ( SBMLNamespaces_t sbmlns)

_tCreates_t _ta_t _tnew_t _tCompartment_t_t _tstructure_t _tusing_t _tthe_t _tgiven_t _tSBMLNamespaces_t_t _tstructure_t, @_tp_t _tsbmlns_t.

@_tcopydetails_t _tdoc_what_are_sbmlnamespaces_t

_tIt_t _tis_t _tworth_t _temphasizing_t _tthat_t _talthough_t _tthis_t _tconstructor_t _tdoes_t _tnot_t _ttake_t _tan_t _tidentifier_t _targument_t, _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tand_t _tbeyond_t, _tthe_t "_tid_t" (_tidentifier_t) _tattribute_t _tof_t _ta_t _tCompartment_t_t _tinstance_t _tis_t _trequired_t _tto_t _thave_t _ta_t _tvalue_t. _tThus_t, _tcallers_t _tare_t _tcautioned_t _tto_t _tassign_t _ta_t _tvalue_t _tafter_t _tcalling_t _tthis_t _tconstructor_t. _tSetting_t _tthe_t _tidentifier_t _tcan_t _tbe_t _taccomplished_t _tusing_t _tthe_t _tmethod_t _tCompartment_setId_t().

@_tparam_t _tsbmlns_t _tan_t _tSBMLNamespaces_t_t _tstructure_t.

@_treturns_t _tthe_t _tnewly_t-_tcreated_t _tCompartment_t_t _tstructure_t, _tor_t _ta_t _tnull_t _tpointer_t _tif_t _tan_t _terror_t _toccurred_t _tduring_t _tconstructions_t

@_tcopydetails_t _tdoc_note_setting_lv_t

@_tmemberof_t _tCompartment_t_t

◆ Compartment_free()

void Compartment_free ( Compartment_t c)

_tFrees_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t _tto_t _tbe_t _tfreed_t.

@_tmemberof_t _tCompartment_t_t

◆ Compartment_getCompartmentType()

const char * Compartment_getCompartmentType ( const Compartment_t c)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthe_t _tCompartment_t_t _tstructure_t @_tp_t _tc_t _tas_t _ta_t _tstring_t.

@_tnote_t _tThe_t "_tcompartmentType_t" _tattribute_t _tis_t _tonly_t _tavailable_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersions_t&_tnbsp_t;_t2_t&_tndash_t;_t4_t.

@_tmemberof_t _tCompartment_t_t

◆ Compartment_getConstant()

int Compartment_getConstant ( const Compartment_t c)

_tGet_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthis_t _tcompartment_t'_ts_t _tsize_t _tis_t _tflagged_t _tas_t _tbeing_t _tconstant_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tCompartment_t_t

◆ Compartment_getDerivedUnitDefinition()

UnitDefinition_t * Compartment_getDerivedUnitDefinition ( Compartment_t c)

_tConstructs_t _tand_t _treturns_t _ta_t _tUnitDefinition_t _tthat_t _tcorresponds_t _tto_t _tthe_t _tunits_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t _tdesignated_t _tsize_t.

@_tcopydetails_t _tdoc_compartment_units_t

@_tparam_t _tc_t _tthe_t _tCompartment_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 _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tcopydetails_t _tdoc_note_unit_analysis_depends_on_model_t

@_tsee_t _tCompartment_isSetUnits_t() @_tsee_t _tCompartment_getUnits_t()

@_tmemberof_t _tCompartment_t_t

Examples
printUnits.c.

◆ Compartment_getId()

const char * Compartment_getId ( const Compartment_t c)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t _tthe_t _tid_t _tof_t _tthis_t _tstructure_t.

@_tmemberof_t _tCompartment_t_t

Examples
printAnnotation.c, and printNotes.c.

◆ Compartment_getName()

const char * Compartment_getName ( const Compartment_t c)

_tReturns_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t _tthe_t _tname_t _tof_t _tthe_t _tCompartment_t_t _tstructure_t @_tp_t _tc_t, _tas_t _ta_t _tpointer_t _tto_t _ta_t _tstring_t.

@_tmemberof_t _tCompartment_t_t

◆ Compartment_getNamespaces()

const XMLNamespaces_t * Compartment_getNamespaces ( Compartment_t c)

_tReturns_t _ta_t _tlist_t _tof_t _tXMLNamespaces_t_t _tstructures_t _tassociated_t _twith_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t _tpointer_t _tto_t _tthe_t _tXMLNamespaces_t_t _tstructure_t _tassociated_t _twith_t _tthis_t _tSBML_t _tstructure_t

@_tmemberof_t _tCompartment_t_t

◆ Compartment_getOutside()

const char * Compartment_getOutside ( const Compartment_t c)

_tGet_t _tthe_t _tidentifier_t, _tif_t _tany_t, _tof_t _tthe_t _tcompartment_t _tthat_t _tis_t _tdesignated_t _tas_t _tbeing_t _toutside_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_toutside_t" _tattribute_t _tof_t _tthis_t _tCompartment_t_t _tstructure_t.

@_tnote_t _tThe_t "_toutside_t" _tattribute_t _tis_t _tdefined_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t _tand_t _tLevel_t&_tnbsp_t;_t2_t, _tbut_t _tdoes_t _tnot_t _texist_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t.

@_tmemberof_t _tCompartment_t_t

◆ Compartment_getSize()

double Compartment_getSize ( const Compartment_t c)

_tGet_t _tthe_t _tsize_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tcopydetails_t _tdoc_compartment_both_size_and_volume_t

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsize_t" _tattribute_t ("_tvolume_t" _tin_t _tLevel_t _t1_t) _tof_t _tthe_t _tCompartment_t_t _tstructure_t @_tp_t _tc_t _tas_t _ta_t _tfloating_t _tpoint_t _tnumber_t.

@_tnote_t _tThis_t _tmethod_t _tis_t _tidentical_t _tto_t _tCompartment_getVolume_t().

@_tsee_t _tCompartment_isSetSize_t() @_tsee_t _tCompartment_getVolume_t()

@_tmemberof_t _tCompartment_t_t

◆ Compartment_getSpatialDimensions()

unsigned int Compartment_getSpatialDimensions ( const Compartment_t c)

_tGet_t _tthe_t _tnumber_t _tof_t _tspatial_t _tdimensions_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspatialDimensions_t" _tattribute_t _tof_t _tthe_t _tCompartment_t_t _tstructure_t @_tp_t _tc_t _tas_t _tan_t _tunsigned_t _tinteger_t

@_tcopydetails_t _tdoc_note_spatial_dimensions_as_double_t

@_tsee_t _tCompartment_getSpatialDimensionsAsDouble_t()

@_tmemberof_t _tCompartment_t_t

◆ Compartment_getSpatialDimensionsAsDouble()

double Compartment_getSpatialDimensionsAsDouble ( const Compartment_t c)

_tGet_t _tthe_t _tnumber_t _tof_t _tspatial_t _tdimensions_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t, _tas_t _ta_t _tdouble_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspatialDimensions_t" _tattribute_t _tof_t _tthe_t _tCompartment_t_t _tstructure_t @_tp_t _tc_t _tas_t _ta_t _tdouble_t.

@_tcopydetails_t _tdoc_note_spatial_dimensions_as_double_t

@_tsee_t _tCompartment_getSpatialDimensions_t()

@_tmemberof_t _tCompartment_t_t

◆ Compartment_getUnits()

const char * Compartment_getUnits ( const Compartment_t c)

_tGet_t _tthe_t _tunits_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t _tsize_t.

_tThe_t _tvalue_t _tof_t _tan_t _tSBML_t _tcompartment_t'_ts_t "_tunits_t" _tattribute_t _testablishes_t _tthe_t _tunit_t _tof_t _tmeasurement_t _tassociated_t _twith_t _tthe_t _tcompartment_t'_ts_t _tsize_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tunits_t" _tattribute_t _tof_t _tthe_t _tCompartment_t_t _tstructure_t, _tas_t _ta_t _tstring_t. _tAn_t _tempty_t _tstring_t _tindicates_t _tthat_t _tno_t _tunits_t _thave_t _tbeen_t _tassigned_t _tto_t _tthe_t _tvalue_t _tof_t _tthe_t _tsize_t.

@_tcopydetails_t _tdoc_note_unassigned_unit_are_not_a_default_t

@_tsee_t _tCompartment_isSetUnits_t() @_tsee_t _tCompartment_setUnits_t() @_tsee_t _tCompartment_getSize_t()

@_tmemberof_t _tCompartment_t_t

◆ Compartment_getVolume()

double Compartment_getVolume ( const Compartment_t c)

_tGet_t _tthe_t _tvolume_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tcopydetails_t _tdoc_compartment_both_size_and_volume_t

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvolume_t" _tattribute_t ("_tsize_t" _tin_t _tLevel_t&_tnbsp_t;_t2_t) _tof_t @_tp_t _tc_t, _tas_t _ta_t _tfloating_t-_tpoint_t _tnumber_t.

@_tcopydetails_t _tdoc_note_compartment_volume_t

@_tnote_t _tThis_t _tmethod_t _tis_t _tidentical_t _tto_t _tCompartment_getSize_t().

@_tsee_t _tCompartment_isSetVolume_t() @_tsee_t _tCompartment_getSize_t()

@_tmemberof_t _tCompartment_t_t

◆ Compartment_hasRequiredAttributes()

int Compartment_hasRequiredAttributes ( Compartment_t c)

_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 _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t _thave_t _tbeen_t _tset_t.

_tThe_t _trequired_t _tattributes_t _tfor_t _ta_t _tCompartment_t_t _tstructure_t _tare_t: @_tli_t _tid_t (_tname_t _tin_t _tSBML_t _tLevel_t _t1_t _tonly_t) @_tli_t _tconstant_t (_tin_t _tSBML_t _tLevel_t _t3_t _tonly_t)

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t _tto_t _tcheck_t.

@_treturn_t @_tc_t _t1_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 _tCompartment_t_t

◆ Compartment_initDefaults()

void Compartment_initDefaults ( Compartment_t c)

_tInitializes_t _tthe_t _tfields_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t _tto_t "_ttypical_t" _tdefault_t _tvalues_t.

_tThe_t _tSBML_t _tCompartment_t _tcomponent_t _thas_t _tslightly_t _tdifferent_t _taspects_t _tand_t _tdefault_t _tattribute_t _tvalues_t _tin_t _tdifferent_t _tSBML_t _tLevels_t _tand_t _tVersions_t. _tThis_t _tmethod_t _tsets_t _tthe_t _tvalues_t _tto_t _tcertain_t _tcommon_t _tdefaults_t, _tbased_t _tmostly_t _ton_t _twhat_t _tthey_t _tare_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t. _tSpecifically_t:

@_tli_t _tSets_t _tattribute_t "_tspatialDimensions_t" _tto_t @_tc_t _t3_t @_tli_t _tSets_t _tattribute_t "_tconstant_t" _tto_t @_tc_t _t1_t (_ttrue_t) @_tli_t (_tApplies_t _tto_t _tLevel_t&_tnbsp_t;_t1_t _tmodels_t _tonly_t) _tSets_t _tattribute_t "_tvolume_t" _tto_t @_tc_t _t1_t._t0_t @_tli_t (_tApplies_t _tto_t _tLevel_t&_tnbsp_t;_t3_t _tmodels_t _tonly_t) _tSets_t _tattribute_t "_tunits_t" _tto_t @_tc_t _tlitre_t

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_tmemberof_t _tCompartment_t_t

◆ Compartment_isSetCompartmentType()

int Compartment_isSetCompartmentType ( const Compartment_t c)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tcompartmentType_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthis_t _tCompartment_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tThe_t "_tcompartmentType_t" _tattribute_t _tis_t _tonly_t _tavailable_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersions_t&_tnbsp_t;_t2_t&_tndash_t;_t4_t.

@_tmemberof_t _tCompartment_t_t

◆ Compartment_isSetConstant()

int Compartment_isSetConstant ( const Compartment_t c)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tconstant_t" _tattribute_t _tis_t _tset_t.

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

@_tmemberof_t _tCompartment_t_t

◆ Compartment_isSetId()

int Compartment_isSetId ( const Compartment_t c)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tid_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

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

@_tmemberof_t _tCompartment_t_t

◆ Compartment_isSetName()

int Compartment_isSetName ( const Compartment_t c)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tname_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

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

@_tmemberof_t _tCompartment_t_t

◆ Compartment_isSetOutside()

int Compartment_isSetOutside ( const Compartment_t c)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_toutside_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_toutside_t" _tattribute_t _tof_t _tthis_t _tCompartment_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tnote_t _tThe_t "_toutside_t" _tattribute_t _tis_t _tdefined_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t _tand_t _tLevel_t&_tnbsp_t;_t2_t, _tbut_t _tdoes_t _tnot_t _texist_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t.

@_tmemberof_t _tCompartment_t_t

◆ Compartment_isSetSize()

int Compartment_isSetSize ( const Compartment_t c)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tsize_t" _tattribute_t _tis_t _tset_t.

_tThis_t _tmethod_t _tis_t _tsimilar_t _tbut_t _tnot_t _tidentical_t _tto_t _tCompartment_isSetVolume_t(). _tThe_t _tlatter_t _tshould_t _tbe_t _tused_t _tin_t _tthe_t _tcontext_t _tof_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t _tmodels_t _tinstead_t _tof_t _tCompartment_isSetSize_t() _tbecause_t _tCompartment_isSetVolume_t() _tperforms_t _textra_t _tprocessing_t _tto_t _ttake_t _tinto_t _taccount_t _tthe_t _tdifference_t _tin_t _tdefault_t _tvalues_t _tbetween_t _tSBML_t _tLevels_t&_tnbsp_t;_t1_t _tand_t&_tnbsp_t;_t2_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tsize_t" _tattribute_t ("_tvolume_t" _tin_t _tLevel_t&_tnbsp_t;_t2_t) _tof_t _tthis_t _tCompartment_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tsee_t _tCompartment_isSetVolume_t() @_tsee_t _tCompartment_setSize_t()

@_tmemberof_t _tCompartment_t_t

◆ Compartment_isSetSpatialDimensions()

int Compartment_isSetSpatialDimensions ( const Compartment_t c)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tspatialDimensions_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tspatialDimensions_t" _tattribute_t _tof_t _tthis_t _tCompartment_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tmemberof_t _tCompartment_t_t

◆ Compartment_isSetUnits()

int Compartment_isSetUnits ( const Compartment_t c)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t'_ts_t "_tunits_t" _tattribute_t _tis_t _tset_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

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

@_tcopydetails_t _tdoc_note_unassigned_unit_are_not_a_default_t

@_tmemberof_t _tCompartment_t_t

◆ Compartment_isSetVolume()

int Compartment_isSetVolume ( const Compartment_t c)

_tPredicate_t _treturning_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t _tgiven_t _tCompartment_t_t _tstructures_t'_ts_t "_tvolume_t" _tattribute_t _tis_t _tset_t.

_tThis_t _tmethod_t _tis_t _tsimilar_t _tbut_t _tnot_t _tidentical_t _tto_t _tCompartment_isSetSize_t(). _tThe_t _tlatter_t _tshould_t _tnot_t _tbe_t _tused_t _tin_t _tthe_t _tcontext_t _tof_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t _tmodels_t _tbecause_t _tthe_t _tpresent_t _tmethod_t _tperforms_t _textra_t _tprocessing_t _tto_t _ttake_t _tinto_t _taccount_t _tthe_t _tdifference_t _tin_t _tdefault_t _tvalues_t _tbetween_t _tSBML_t _tLevels_t&_tnbsp_t;_t1_t _tand_t&_tnbsp_t;_t2_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_treturn_t @_tc_t _t1_t (_ttrue_t) _tif_t _tthe_t "_tvolume_t" _tattribute_t ("_tsize_t" _tin_t _tLevel_t&_tnbsp_t;_t2_t _tand_t _tabove_t) _tof_t _tthis_t _tCompartment_t_t _tstructure_t _tis_t _tset_t, @_tc_t _t0_t (_tfalse_t) _totherwise_t.

@_tcopydetails_t _tdoc_note_compartment_volume_t

@_tsee_t _tCompartment_isSetSize_t() @_tsee_t _tCompartment_setVolume_t()

@_tmemberof_t _tCompartment_t_t

◆ Compartment_setCompartmentType()

int Compartment_setCompartmentType ( Compartment_t c,
const char *  sid 
)

_tSets_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t. @_tparam_t _tsid_t _tthe_t _tidentifier_t _tof_t _ta_t _tCompartmentType_t_t _tstructure_t _tdefined_t _telsewhere_t _tin_t _tthe_t _tenclosing_t _tModel_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_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_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 _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _tsid_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartmentType_t" _tattribute_t.

@_tnote_t _tThe_t "_tcompartmentType_t" _tattribute_t _tis_t _tonly_t _tavailable_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tVersions_t&_tnbsp_t;_t2_t&_tndash_t;_t4_t.

@_tmemberof_t _tCompartment_t_t

◆ Compartment_setConstant()

int Compartment_setConstant ( Compartment_t c,
int  value 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tconstant_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tvalue_t _tan_t _tinteger_t _tindicating_t _twhether_t _tthe_t _tsize_t/_tvolume_t _tof_t _tthe_t _tcompartment_t @_tp_t _tc_t _tshould_t _tbe_t _tconsidered_t _tconstant_t (_tindicated_t _tby_t _ta_t _tnonzero_t @_tp_t _tvalue_t) _tor_t _tvariable_t (@_tp_t _tvalue_t _tis_t _tzero_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tCompartment_t_t

Examples
spec_example1.c.

◆ Compartment_setId()

int Compartment_setId ( Compartment_t c,
const char *  sid 
)

_tSets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tid_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

_tThe_t _tstring_t @_tp_t _tsid_t _tis_t _tcopied_t.

@_tcopydetails_t _tdoc_id_attribute_t

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifier_t _tto_t _twhich_t _tthe_t _tstructures_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _tsid_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t "_tid_t" _tattribute_t.

@_tmemberof_t _tCompartment_t_t

Examples
createExampleSBML.c, and spec_example1.c.

◆ Compartment_setName()

int Compartment_setName ( Compartment_t c,
const char *  name 
)

_tSets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_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 _ta_t _tnull_t _tpointer_t, _tthis_t _tfunction_t _tis_t _tequivalent_t _tto_t _tcalling_t _tCompartment_unsetName_t().

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tname_t _tthe_t _tstring_t _tto_t _twhich_t _tthe_t _tstructures_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _tname_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_tname_t" _tattribute_t.

@_tmemberof_t _tCompartment_t_t

◆ Compartment_setOutside()

int Compartment_setOutside ( Compartment_t c,
const char *  sid 
)

_tSets_t _tthe_t "_toutside_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifier_t _tof_t _ta_t _tcompartment_t _tthat_t _tencloses_t _tthis_t _tone_t. _tThe_t _tstring_t _twill_t _tbe_t _tcopied_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}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _tsid_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_toutside_t" _tattribute_t.

@_tmemberof_t _tCompartment_t_t

◆ Compartment_setSize()

int Compartment_setSize ( Compartment_t c,
double  value 
)

_tSets_t _tthe_t "_tsize_t" _tattribute_t (_tor_t "_tvolume_t" _tin_t _tSBML_t _tLevel_t _t1_t) _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t. @_tparam_t _tvalue_t _ta_t @_tc_t _tdouble_t _trepresenting_t _tthe_t _tsize_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t _tin_t _twhatever_t _tunits_t _tare_t _tin_t _teffect_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 _tCompartment_isSetSize_t() @_tsee_t _tCompartment_setVolume_t()

@_tmemberof_t _tCompartment_t_t

Examples
createExampleSBML.c, and spec_example1.c.

◆ Compartment_setSpatialDimensions()

int Compartment_setSpatialDimensions ( Compartment_t c,
unsigned int  value 
)

_tSets_t _tthe_t "_tspatialDimensions_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t. @_tparam_t _tvalue_t _tan_t _tunsigned_t _tinteger_t _tindicating_t _tthe_t _tnumber_t _tof_t _tdimensions_t _tof_t _tthe_t _tgiven_t _tcompartment_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_INVALID_ATTRIBUTE_VALUE_t, _tOperationReturnValues_t_t} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tCompartment_t_t

Examples
spec_example1.c.

◆ Compartment_setSpatialDimensionsAsDouble()

int Compartment_setSpatialDimensionsAsDouble ( Compartment_t c,
double  value 
)

_tSets_t _tthe_t "_tspatialDimensions_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t. @_tparam_t _tvalue_t _ta_t _tdouble_t _tindicating_t _tthe_t _tnumber_t _tof_t _tdimensions_t _tof_t _tthe_t _tgiven_t _tcompartment_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} @_tli_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tCompartment_t_t

◆ Compartment_setUnits()

int Compartment_setUnits ( Compartment_t c,
const char *  sid 
)

_tSets_t _tthe_t "_tunits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tsid_t _tthe_t _tidentifier_t _tof_t _tthe_t _tdefined_t _tunits_t _tto_t _tuse_t. _tThe_t _tstring_t _twill_t _tbe_t _tcopied_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}

@_tnote_t _tUsing_t _tthis_t _tfunction_t _twith_t _ta_t _tnull_t _tpointer_t _tfor_t @_tp_t _tsid_t _tis_t _tequivalent_t _tto_t _tunsetting_t _tthe_t _tvalue_t _tof_t _tthe_t "_tunits_t" _tattribute_t.

@_tmemberof_t _tCompartment_t_t

◆ Compartment_setVolume()

int Compartment_setVolume ( Compartment_t c,
double  value 
)

_tSets_t _tthe_t "_tvolume_t" _tattribute_t (_tor_t "_tsize_t" _tin_t _tSBML_t _tLevel_t _t2_t) _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

_tThis_t _tmethod_t _tis_t _tidentical_t _tto_t _tCompartment_setSize_t() _tand_t _tis_t _tprovided_t _tfor_t _tcompatibility_t _tbetween_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t _tand_t _thigher_t _tLevels_t _tof_t _tSBML_t.

@_tparam_t _tc_t _tthe_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tvalue_t _ta_t @_tc_t _tdouble_t _trepresenting_t _tthe_t _tvolume_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t _tin_t _twhatever_t _tunits_t _tare_t _tin_t _teffect_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}

@_tcopydetails_t _tdoc_note_compartment_volume_t

@_tsee_t _tCompartment_isSetVolume_t() @_tsee_t _tCompartment_setSize_t()

@_tmemberof_t _tCompartment_t_t

◆ Compartment_unsetCompartmentType()

int Compartment_unsetCompartmentType ( Compartment_t c)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tcompartmentType_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_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 _tCompartment_t_t

◆ Compartment_unsetConstant()

int Compartment_unsetConstant ( Compartment_t c)

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

@_tparam_t _tc_t _tthe_t _tCompartment_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 _tCompartment_t_t

◆ Compartment_unsetName()

int Compartment_unsetName ( Compartment_t c)

_tUnsets_t _tthe_t "_tname_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_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 _tCompartment_t_t

◆ Compartment_unsetOutside()

int Compartment_unsetOutside ( Compartment_t c)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_toutside_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_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 _tCompartment_t_t

◆ Compartment_unsetSize()

int Compartment_unsetSize ( Compartment_t c)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tsize_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

_tIn_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t, _ta_t _tcompartment_t'_ts_t _tvolume_t _thas_t _ta_t _tdefault_t _tvalue_t (@_tc_t _t1_t._t0_t) _tand_t _ttherefore_t <_tem_t>_tshould_t _talways_t _tbe_t _tset_t</_tem_t>. _tCalling_t _tthis_t _tmethod_t _ton_t _ta_t _tLevel_t&_tnbsp_t;_t1_t _tmodel_t _tresets_t _tthe_t _tvalue_t _tto_t @_tc_t _t1_t._t0_t _trather_t _tthan_t _tactually_t _tunsetting_t _tit_t. _tIn_t _tLevel_t&_tnbsp_t;_t2_t, _ta_t _tcompartment_t'_ts_t "_tsize_t" _tis_t _toptional_t _twith_t _tno_t _tdefault_t _tvalue_t, _tand_t _tunsetting_t _tit_t _twill_t _tresult_t _tin_t _tthe_t _tcompartment_t _thaving_t _tno_t _tdefined_t _tsize_t.

@_tparam_t _tc_t _tthe_t _tCompartment_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_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tmemberof_t _tCompartment_t_t

◆ Compartment_unsetSpatialDimensions()

int Compartment_unsetSpatialDimensions ( Compartment_t c)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tspatialDimensions_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

_tIn_t _tSBML_t _tLevels_t _tprior_t _tto_t _tLevel_t&_tnbsp_t;_t3_t, _tcompartments_t _tmust_t _talways_t _thave_t _ta_t _tvalue_t _tfor_t _tthe_t _tnumber_t _tof_t _tdimensions_t. _tConsequently_t, _tcalling_t _tthis_t _tmethod_t _ton_t _ta_t _tmodel_t _tof_t _tSBML_t _tLevel_t _t1_t&_tndash_t;_t2_t _twill_t _tresult_t _tin_t _ta_t _treturn_t _tvalue_t _tof_t @_tsbmlconstant_t{_tLIBSBML_UNEXPECTED_ATTRIBUTE_t, _tOperationReturnValues_t_t}

@_tparam_t _tc_t _tthe_t _tCompartment_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 _tCompartment_t_t

◆ Compartment_unsetUnits()

int Compartment_unsetUnits ( Compartment_t c)

_tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tunits_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

@_tparam_t _tc_t _tthe_t _tCompartment_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 _tCompartment_t_t

◆ Compartment_unsetVolume()

int Compartment_unsetVolume ( Compartment_t c)

(_tFor_t _tSBML_t _tLevel_t _t1_t) _tUnsets_t _tthe_t _tvalue_t _tof_t _tthe_t "_tvolume_t" _tattribute_t _tof_t _tthe_t _tgiven_t _tCompartment_t_t _tstructure_t.

_tThis_t _tmethod_t _tis_t _tidentical_t _tto_t _tCompartment_unsetSize_t(). _tPlease_t _trefer_t _tto_t _tthat_t _tmethod_t'_ts_t _tdocumentation_t _tfor_t _tmore_t _tinformation_t _tabout_t _tits_t _tbehavior_t.

@_tparam_t _tc_t _tthe_t _tCompartment_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_INVALID_OBJECT_t, _tOperationReturnValues_t_t}

@_tcopydetails_t _tdoc_note_compartment_volume_t

@_tsee_t _tCompartment_unsetSize_t()

@_tmemberof_t _tCompartment_t_t

◆ ListOfCompartments_getById()

Compartment_t * ListOfCompartments_getById ( ListOf_t lo,
const char *  sid 
)

_tReturns_t _tthe_t _tCompartment_t_t _tstructure_t _thaving_t _ta_t _tgiven_t _tidentifier_t.

@_tparam_t _tlo_t _tthe_t _tlist_t _tof_t _tCompartments_t_t _tstructures_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 _tListOfCompartments_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 _tListOfCompartments_t_t

◆ ListOfCompartments_removeById()

Compartment_t * ListOfCompartments_removeById ( ListOf_t lo,
const char *  sid 
)

_tRemoves_t _ta_t _tCompartment_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 _tCompartment_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 _tCompartment_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 _tListOfCompartments_t_t