libSBML C API
5.18.0
|
A CompartmentReference_t object is a child of an extended Compartment_t (via the MultiCompartmentPlugin_t), and provides a way for that Compartment_t to reference another Compartment_t, and indicates that the referenced Compartment_t is a sub-compartment in a composite parent compartment. Compartments may be arbitrarily nested in this way, but this nesting cannot be circular.
CompartmentReference_t * CompartmentReference_clone | ( | CompartmentReference_t * | cr | ) |
Creates and returns a deep copy of this CompartmentReference_t object.
cr | the CompartmentReference_t structure. |
CompartmentReference_t * CompartmentReference_create | ( | unsigned int | level, |
unsigned int | version, | ||
unsigned int | pkgVersion | ||
) |
Creates a new CompartmentReference_t using the given SBML Level, Version and “multi” package version.
level | an unsigned int, the SBML Level to assign to this CompartmentReference_t. |
version | an unsigned int, the SBML Version to assign to this CompartmentReference_t. |
pkgVersion | an unsigned int, the SBML Multi Version to assign to this CompartmentReference_t. |
void CompartmentReference_free | ( | CompartmentReference_t * | cr | ) |
Frees this CompartmentReference_t object.
cr | the CompartmentReference_t structure. |
char * CompartmentReference_getCompartment | ( | const CompartmentReference_t * | cr | ) |
Returns the value of the "compartment" attribute of this CompartmentReference_t.
cr | the CompartmentReference_t structure whose compartment is sought. |
char * CompartmentReference_getId | ( | const CompartmentReference_t * | cr | ) |
Returns the value of the "id" attribute of this CompartmentReference_t.
cr | the CompartmentReference_t structure whose id is sought. |
char * CompartmentReference_getName | ( | const CompartmentReference_t * | cr | ) |
Returns the value of the "name" attribute of this CompartmentReference_t.
cr | the CompartmentReference_t structure whose name is sought. |
int CompartmentReference_hasRequiredAttributes | ( | CompartmentReference_t * | cr | ) |
Predicate returning 1
(true) if all the required attributes for this CompartmentReference_t object have been set.
cr | the CompartmentReference_t structure. |
1
(true) to indicate that all the required attributes of this CompartmentReference_t have been set, otherwise 0
(false) is returned.int CompartmentReference_isSetCompartment | ( | const CompartmentReference_t * | cr | ) |
Predicate returning 1
(true) if this CompartmentReference_t's "compartment" attribute is set.
cr | the CompartmentReference_t structure. |
1
(true) if this CompartmentReference_t's "compartment" attribute has been set, otherwise 0
(false) is returned. int CompartmentReference_isSetId | ( | const CompartmentReference_t * | cr | ) |
Predicate returning 1
(true) if this CompartmentReference_t's "id" attribute is set.
cr | the CompartmentReference_t structure. |
1
(true) if this CompartmentReference_t's "id" attribute has been set, otherwise 0
(false) is returned. int CompartmentReference_isSetName | ( | const CompartmentReference_t * | cr | ) |
Predicate returning 1
(true) if this CompartmentReference_t's "name" attribute is set.
cr | the CompartmentReference_t structure. |
1
(true) if this CompartmentReference_t's "name" attribute has been set, otherwise 0
(false) is returned. int CompartmentReference_setCompartment | ( | CompartmentReference_t * | cr, |
const char * | compartment | ||
) |
Sets the value of the "compartment" attribute of this CompartmentReference_t.
cr | the CompartmentReference_t structure. |
compartment | const char * value of the "compartment" attribute to be set. |
int CompartmentReference_setId | ( | CompartmentReference_t * | cr, |
const char * | id | ||
) |
Sets the value of the "id" attribute of this CompartmentReference_t.
cr | the CompartmentReference_t structure. |
id | const char * value of the "id" attribute to be set. |
id
= NULL
or an empty string is equivalent to calling CompartmentReference_unsetId(). int CompartmentReference_setName | ( | CompartmentReference_t * | cr, |
const char * | name | ||
) |
Sets the value of the "name" attribute of this CompartmentReference_t.
cr | the CompartmentReference_t structure. |
name | const char * value of the "name" attribute to be set. |
name
= NULL
or an empty string is equivalent to calling CompartmentReference_unsetName(). int CompartmentReference_unsetCompartment | ( | CompartmentReference_t * | cr | ) |
Unsets the value of the "compartment" attribute of this CompartmentReference_t.
cr | the CompartmentReference_t structure. |
int CompartmentReference_unsetId | ( | CompartmentReference_t * | cr | ) |
Unsets the value of the "id" attribute of this CompartmentReference_t.
cr | the CompartmentReference_t structure. |
int CompartmentReference_unsetName | ( | CompartmentReference_t * | cr | ) |
Unsets the value of the "name" attribute of this CompartmentReference_t.
cr | the CompartmentReference_t structure. |