libSBML C API
libSBML 5.20.2 C API
|
Definitions of Compartment_t and ListOfCompartments_t. More...
Functions | |
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. | |
Compartment_t * | Compartment_create (unsigned int level, unsigned int version) |
@_tclass_t _tdoc_compartment_units_t | |
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. | |
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_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. | |
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_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. | |
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_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. | |
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. | |
Definitions of Compartment_t and ListOfCompartments_t.
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_t * Compartment_create | ( | unsigned int | level, |
unsigned int | version | ||
) |
@_tclass_t _tdoc_compartment_units_t
@_tpar_t _tCompartments_t _tin_t _tSBML_t _thave_t _tan_t _tattribute_t ("_tunits_t") _tfor_t _tdeclaring_t _tthe_t _tunits_t _tof_t _tmeasurement_t _tintended_t _tfor_t _tthe_t _tvalue_t _tof_t _tthe_t _tcompartment_t'_ts_t _tsize_t. _tIn_t _tthe_t _tabsence_t _tof_t _ta_t _tvalue_t _tgiven_t _tfor_t _tthis_t _tattribute_t, _tthe_t _tunits_t _tare_t _tinherited_t _tfrom_t _tvalues_t _teither_t _tdefined_t _ton_t _tthe_t _tenclosing_t _tModel_t (_tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t) _tor_t _tin_t _tdefaults_t (_tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t). _tThis_t _tmethod_t _treturns_t _ta_t @_tif_t _tconly_t _tUnitDefinition_t_t _tstructure_t @_telse_t _tUnitDefinition_t _tobject_t@_tendif_t _tbased_t _ton_t _thow_t _tthis_t _tcompartment_t'_ts_t _tunits_t _tare_t _tinterpreted_t _taccording_t _tto_t _tthe_t _trelevant_t _tSBML_t _tguidelines_t, _tor_t _tit_t _treturns_t @_tc_t _tNULL_t _tif_t _tno_t _tunits_t _thave_t _tbeen_t _tdeclared_t _tand_t _tno_t _tdefaults_t _tare_t _tdefined_t _tby_t _tthe_t _trelevant_t _tSBML_t _tspecification_t.
_tNote_t _tthat_t _tunit_t _tdeclarations_t _tfor_t @_tif_t _tconly_t _tCompartment_t_t _tstructures_t @_telse_t _tCompartment_t _tobjects_t @_tendif_t _tare_t _tspecified_t _tin_t _tterms_t _tof_t _tthe_t @_tem_t _tidentifier_t _tof_t _ta_t _tunit_t, _tbut_t @_tem_t _tthis_t _tmethod_t _treturns_t @_tif_t _tconly_t _ta_t _tstructure_t @_telse_t _tan_t _tobject_t @_tendif_t, _tnot_t _ta_t _tunit_t _tidentifier_t. _tIt_t _tdoes_t _tthis_t _tby_t _tconstructing_t _tan_t _tappropriate_t @_tif_t _tconly_t _tUnitDefinition_t_t _tstructure_t @_telse_t _tUnitDefinition_t _tobject_t@_tendif_t. _tFor_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tmodels_t, _tit_t _twill_t _tdo_t _tthis_t _teven_t _twhen_t _tthe_t _tvalue_t _tof_t _tthe_t "_tunits_t" _tattribute_t _tis_t _tone_t _tof_t _tthe_t _tspecial_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tunit_t _tidentifiers_t @_tc_t "_tsubstance_t", @_tc_t "_tvolume_t", @_tc_t "_tarea_t", @_tc_t "_tlength_t" _tor_t @_tc_t "_ttime_t". _tCallers_t _tmay_t _tfind_t _tthis_t _tuseful_t _tin_t _tconjunction_t _twith_t _tthe_t _thelper_t _tmethods_t _tprovided_t _tby_t _tthe_t @_tif_t _tconly_t _tUnitDefinition_t_t _tstructure_t @_telse_t _tUnitDefinition_t _tclass_t@_tendif_t _tfor_t _tcomparing_t _tdifferent_t _tUnitDefinition_t _tobjects_t.
@_tclass_t _tdoc_compartment_both_size_and_volume_t
@_tpar_t _tIn_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t, _tcompartments_t _tare_t _talways_t _tthree_t-_tdimensional_t _tconstructs_t _tand_t _tonly_t _thave_t _tvolumes_t, _twhereas_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t2_t _tand_t _thigher_t, _tcompartments_t _tmay_t _tbe_t _tother_t _tthan_t _tthree_t-_tdimensional_t, _tand_t _ttherefore_t _tthe_t "_tvolume_t" _tattribute_t _tis_t _tnamed_t "_tsize_t" _tin_t _tLevel_t&_tnbsp_t;_t2_t _tand_t _tabove_t. _tLibSBML_t _tprovides_t _tboth_t @_tif_t _tconly_t _tCompartment_getSize_t() _tand_t _tCompartment_getVolume_t() @_telse_t _tgetSize_t() _tand_t _tgetVolume_t()@_tendif_t _tfor_t _teasier_t _tsupport_t _tof_t _tdifferent_t _tSBML_t _tLevels_t.
@_tclass_t _tdoc_note_compartment_volume_t
@_tnote_t _tThe_t _tattribute_t "_tvolume_t" _tonly_t _texists_t _tby_t _tthat_t _tname_t _tin_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t. _tIn_t _tLevel_t&_tnbsp_t;_t2_t _tand_t _tabove_t, _tthe_t _tequivalent_t _tattribute_t _tis_t _tnamed_t "_tsize_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 _tmethods_t _tsuch_t _tas_t @_tif_t _tconly_t _tCompartment_isSetVolume_t() @_telse_t _tisSetVolume_t()@_tendif_t _twill_t _talways_t _treturn_t @_tc_t _ttrue_t _tfor_t _ta_t _tLevel_t&_tnbsp_t;_t1_t _tmodel_t. _tIn_t _tLevel_t&_tnbsp_t;_t2_t, _ta_t _tcompartment_t'_ts_t _tsize_t (_tthe_t _tequivalent_t _tof_t _tSBML_t _tLevel_t&_tnbsp_t;_t1_t'_ts_t "_tvolume_t") _tis_t _toptional_t _tand_t _thas_t _tno_t _tdefault_t _tvalue_t, _tand_t _ttherefore_t _tmay_t _tor_t _tmay_t _tnot_t _tbe_t _tset_t.
@_tclass_t _tdoc_note_spatial_dimensions_as_double_t
@_tnote_t _tIn_t _tSBML_t _tLevel_t&_tnbsp_t;_t3_t, _tthe_t _tdata_t _ttype_t _tof_t _tthe_t "_tspatialDimensions_t" _tattribute_t _tis_t @_tc_t _tdouble_t, _twhereas_t _tin_t _tLevel_t&_tnbsp_t;_t2_t, _tit_t _tis_t @_tc_t _tinteger_t. _tTo_t _tavoid_t _tbackward_t _tcompatibility_t _tissues_t, _tlibSBML_t _tprovides_t _ttwo_t _tseparate_t _tmethods_t _tfor_t _tobtaining_t _tthe_t _tvalue_t _tas_t _teither_t _tan_t _tinteger_t _tor_t _ta_t _ttype_t @_tc_t _tdouble_t, _tfor_t _tmodels_t _twhere_t _tit_t _tis_t _trelevant_t.
@_tclass_t _tdoc_note_unit_analysis_depends_on_model_t
@_tnote_t _tThe_t _tlibSBML_t _tsystem_t _tfor_t _tunit_t _tanalysis_t _tdepends_t _ton_t _tthe_t _tmodel_t _tas_t _ta_t _twhole_t. _tIn_t _tcases_t _twhere_t _tthe_t @_tif_t _tconly_t _tCompartment_t_t _tstructure_t @_telse_t _tCompartment_t _tobject_t@_tendif_t _thas_t _tnot_t _tyet_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 _tconsequently_t _tthis_t _tmethod_t _twill_t _treturn_t @_tc_t _tNULL_t.
_tCreates_t _ta_t _tnew_t _tCompartment_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 _tCompartment_t_t _tstructure_t.
@_tparam_t _tversion_t _tan_t _tunsigned_t _tint_t, _tthe_t _tSBML_t _tVersion_t _tto_t _tassign_t _tto_t _tthis_t _tCompartment_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
@_tclass_t _tdoc_compartment_units_t
@_tcond_t _tdoxygenIgnored_t
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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