libSBML C API  5.18.0
Public Member Functions
MultiSimpleSpeciesReferencePlugin_t Class Reference
Multistate, Multicomponent and Multicompartment Species_t

Detailed Description

multi Extension of SimpleSpeciesReference_t for the "multi" package.

The MultiSpeciesPlugin_t class extends the SimpleSpeciesReference_t class with a new optional attribute "compartmentReference", of type SIdRef, that points to a CompartmentReference_t. The compartmentReference attribute can serve to indicate in which subcompartment the SpeciesReference_t or ModifierSpeciesReference_t (which inherit from SimpleSpeciesReference_t) is located.

Public Member Functions

char * MultiSimpleSpeciesReferencePlugin_getCompartmentReference (const MultiSimpleSpeciesReferencePlugin_t *mssrp)
 Returns the value of the "compartmentReference" attribute of this MultiSimpleSpeciesReferencePlugin_t. More...
 
int MultiSimpleSpeciesReferencePlugin_isSetCompartmentReference (const MultiSimpleSpeciesReferencePlugin_t *mssrp)
 Predicate returning 1 (true) if this MultiSimpleSpeciesReferencePlugin_t's "compartmentReference" attribute is set. More...
 
int MultiSimpleSpeciesReferencePlugin_setCompartmentReference (MultiSimpleSpeciesReferencePlugin_t *mssrp, const char *compartmentReference)
 Sets the value of the "compartmentReference" attribute of this MultiSimpleSpeciesReferencePlugin_t. More...
 
int MultiSimpleSpeciesReferencePlugin_unsetCompartmentReference (MultiSimpleSpeciesReferencePlugin_t *mssrp)
 Unsets the value of the "compartmentReference" attribute of this MultiSimpleSpeciesReferencePlugin_t. More...
 

Member Function Documentation

char * MultiSimpleSpeciesReferencePlugin_getCompartmentReference ( const MultiSimpleSpeciesReferencePlugin_t *  mssrp)

Returns the value of the "compartmentReference" attribute of this MultiSimpleSpeciesReferencePlugin_t.

Parameters
mssrpthe MultiSimpleSpeciesReferencePlugin_t structure whose compartmentReference is sought.
Returns
the value of the "compartmentReference" attribute of this MultiSimpleSpeciesReferencePlugin_t as a pointer to a string.
Warning
The string returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the string will not be reflected in any resulting SBML document unless the string is added to an SBML Document. Even in this case, the string should be deleted, as adding a string to an SBML Document adds a copy of the string, and does not transfer ownership of that string.
int MultiSimpleSpeciesReferencePlugin_isSetCompartmentReference ( const MultiSimpleSpeciesReferencePlugin_t *  mssrp)

Predicate returning 1 (true) if this MultiSimpleSpeciesReferencePlugin_t's "compartmentReference" attribute is set.

Parameters
mssrpthe MultiSimpleSpeciesReferencePlugin_t structure.
Returns
1 (true) if this MultiSimpleSpeciesReferencePlugin_t's "compartmentReference" attribute has been set, otherwise 0 (false) is returned.
int MultiSimpleSpeciesReferencePlugin_setCompartmentReference ( MultiSimpleSpeciesReferencePlugin_t *  mssrp,
const char *  compartmentReference 
)

Sets the value of the "compartmentReference" attribute of this MultiSimpleSpeciesReferencePlugin_t.

Parameters
mssrpthe MultiSimpleSpeciesReferencePlugin_t structure.
compartmentReferenceconst char * value of the "compartmentReference" attribute to be set.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:
int MultiSimpleSpeciesReferencePlugin_unsetCompartmentReference ( MultiSimpleSpeciesReferencePlugin_t *  mssrp)

Unsets the value of the "compartmentReference" attribute of this MultiSimpleSpeciesReferencePlugin_t.

Parameters
mssrpthe MultiSimpleSpeciesReferencePlugin_t structure.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are: