MultiSpeciesReferencePlugin_t Class Reference

Detailed Description

multi Extension of SpeciesReference_t for the "multi" package.

The MultiSpeciesReferencePlugin_t class inherits from the MultiSimpleSpeciesReferencePlugin_t class, and extends the SpeciesReference_t class to establish component mappings between the reactant species and the product species when the mappings cannot be inferred from the ids of the SpeciesTypeInstance_t objects. A MultiSpeciesReferencePlugin_t object defines an optional ListOfSpeciesTypeComponentMapInProducts_t child. Only a reaction product can contain the ListOfSpeciesTypeComponentMapInProducts_t child and it is not necessary to store the mappings again in the reactants.

Public Member Functions
int	MultiSpeciesReferencePlugin_addSpeciesTypeComponentMapInProduct (MultiSpeciesReferencePlugin_t *msrp, const SpeciesTypeComponentMapInProduct_t *stcmip)
	Adds a copy of the given SpeciesTypeComponentMapInProduct_t to this MultiSpeciesReferencePlugin_t. More...
SpeciesTypeComponentMapInProduct_t *	MultiSpeciesReferencePlugin_createSpeciesTypeComponentMapInProduct (MultiSpeciesReferencePlugin_t *msrp)
	Creates a new SpeciesTypeComponentMapInProduct_t object, adds it to this MultiSpeciesReferencePlugin_t object and returns the SpeciesTypeComponentMapInProduct_t object created. More...
ListOf_t *	MultiSpeciesReferencePlugin_getListOfSpeciesTypeComponentMapInProducts (MultiSpeciesReferencePlugin_t *msrp)
	Returns a ListOf_t * containing SpeciesTypeComponentMapInProduct_t objects from this MultiSpeciesReferencePlugin_t. More...
unsigned int	MultiSpeciesReferencePlugin_getNumSpeciesTypeComponentMapInProducts (MultiSpeciesReferencePlugin_t *msrp)
	Get the number of SpeciesTypeComponentMapInProduct_t objects in this MultiSpeciesReferencePlugin_t. More...
SpeciesTypeComponentMapInProduct_t *	MultiSpeciesReferencePlugin_getSpeciesTypeComponentMapInProduct (MultiSpeciesReferencePlugin_t *msrp, unsigned int n)
	Get a SpeciesTypeComponentMapInProduct_t from the MultiSpeciesReferencePlugin_t. More...
SpeciesTypeComponentMapInProduct_t *	MultiSpeciesReferencePlugin_getSpeciesTypeComponentMapInProductById (MultiSpeciesReferencePlugin_t *msrp, const char *sid)
	Get a SpeciesTypeComponentMapInProduct_t from the MultiSpeciesReferencePlugin_t based on its identifier. More...
SpeciesTypeComponentMapInProduct_t *	MultiSpeciesReferencePlugin_removeSpeciesTypeComponentMapInProduct (MultiSpeciesReferencePlugin_t *msrp, unsigned int n)
	Removes the nth SpeciesTypeComponentMapInProduct_t from this MultiSpeciesReferencePlugin_t and returns a pointer to it. More...
SpeciesTypeComponentMapInProduct_t *	MultiSpeciesReferencePlugin_removeSpeciesTypeComponentMapInProductById (MultiSpeciesReferencePlugin_t *msrp, const char *sid)
	Removes the SpeciesTypeComponentMapInProduct_t from this MultiSpeciesReferencePlugin_t based on its identifier and returns a pointer to it. More...

Member Function Documentation

int MultiSpeciesReferencePlugin_addSpeciesTypeComponentMapInProduct	(	MultiSpeciesReferencePlugin_t *	msrp,
		const SpeciesTypeComponentMapInProduct_t *	stcmip
	)

Adds a copy of the given SpeciesTypeComponentMapInProduct_t to this MultiSpeciesReferencePlugin_t.

Parameters

msrp	the MultiSpeciesReferencePlugin_t structure to which the SpeciesTypeComponentMapInProduct_t should be added.
stcmip	the SpeciesTypeComponentMapInProduct_t object to add.

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:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED
• LIBSBML_INVALID_OBJECT
• LIBSBML_LEVEL_MISMATCH
• LIBSBML_VERSION_MISMATCH
• LIBSBML_PKG_VERSION_MISMATCH
• LIBSBML_DUPLICATE_OBJECT_ID

SpeciesTypeComponentMapInProduct_t * MultiSpeciesReferencePlugin_createSpeciesTypeComponentMapInProduct

(

MultiSpeciesReferencePlugin_t *

msrp

)

Creates a new SpeciesTypeComponentMapInProduct_t object, adds it to this MultiSpeciesReferencePlugin_t object and returns the SpeciesTypeComponentMapInProduct_t object created.

Parameters

msrp	the MultiSpeciesReferencePlugin_t structure to which the SpeciesTypeComponentMapInProduct_t should be added.

Returns

a new SpeciesTypeComponentMapInProduct_t object instance.

Note

The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

ListOf_t * MultiSpeciesReferencePlugin_getListOfSpeciesTypeComponentMapInProducts

(

MultiSpeciesReferencePlugin_t *

msrp

)

Returns a ListOf_t * containing SpeciesTypeComponentMapInProduct_t objects from this MultiSpeciesReferencePlugin_t.

Parameters

msrp	the MultiSpeciesReferencePlugin_t structure whose ListOfSpeciesTypeComponentMapsInProduct is sought.

Returns

the ListOfSpeciesTypeComponentMapsInProduct from this MultiSpeciesReferencePlugin_t as a ListOf_t *.

Note

The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

See also

MultiSpeciesReferencePlugin_addSpeciesTypeComponentMapInProduct()

MultiSpeciesReferencePlugin_createSpeciesTypeComponentMapInProduct()

MultiSpeciesReferencePlugin_getSpeciesTypeComponentMapInProductById()

MultiSpeciesReferencePlugin_getSpeciesTypeComponentMapInProduct()

MultiSpeciesReferencePlugin_getNumSpeciesTypeComponentMapInProducts()

MultiSpeciesReferencePlugin_removeSpeciesTypeComponentMapInProductById()

MultiSpeciesReferencePlugin_removeSpeciesTypeComponentMapInProduct()

unsigned int MultiSpeciesReferencePlugin_getNumSpeciesTypeComponentMapInProducts

(

MultiSpeciesReferencePlugin_t *

msrp

)

Get the number of SpeciesTypeComponentMapInProduct_t objects in this MultiSpeciesReferencePlugin_t.

Parameters

msrp	the MultiSpeciesReferencePlugin_t structure to query.

Returns

the number of SpeciesTypeComponentMapInProduct_t objects in this MultiSpeciesReferencePlugin_t.

SpeciesTypeComponentMapInProduct_t * MultiSpeciesReferencePlugin_getSpeciesTypeComponentMapInProduct	(	MultiSpeciesReferencePlugin_t *	msrp,
		unsigned int	n
	)

Get a SpeciesTypeComponentMapInProduct_t from the MultiSpeciesReferencePlugin_t.

Parameters

msrp	the MultiSpeciesReferencePlugin_t structure to search.
n	an unsigned int representing the index of the SpeciesTypeComponentMapInProduct_t to retrieve.

Returns

the nth SpeciesTypeComponentMapInProduct_t in the ListOfSpeciesTypeComponentMapsInProduct within this MultiSpeciesReferencePlugin_t. If the index n is invalid, NULL is returned.

Note

The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

SpeciesTypeComponentMapInProduct_t * MultiSpeciesReferencePlugin_getSpeciesTypeComponentMapInProductById	(	MultiSpeciesReferencePlugin_t *	msrp,
		const char *	sid
	)

Get a SpeciesTypeComponentMapInProduct_t from the MultiSpeciesReferencePlugin_t based on its identifier.

Parameters

msrp	the MultiSpeciesReferencePlugin_t structure to search.
sid	a string representing the identifier of the SpeciesTypeComponentMapInProduct_t to retrieve.

Returns

the SpeciesTypeComponentMapInProduct_t in the ListOfSpeciesTypeComponentMapsInProduct within this MultiSpeciesReferencePlugin_t with the given sid or NULL if no such SpeciesTypeComponentMapInProduct_t exists.

Note

The pointer that is returned by this function is not owned by the caller, but may be queried and modified. Any changes made will be reflected in any resulting SBML document containing the pointer's parent.

SpeciesTypeComponentMapInProduct_t * MultiSpeciesReferencePlugin_removeSpeciesTypeComponentMapInProduct	(	MultiSpeciesReferencePlugin_t *	msrp,
		unsigned int	n
	)

Removes the nth SpeciesTypeComponentMapInProduct_t from this MultiSpeciesReferencePlugin_t and returns a pointer to it.

Parameters

msrp	the MultiSpeciesReferencePlugin_t structure to search.
n	an unsigned int representing the index of the SpeciesTypeComponentMapInProduct_t to remove.

Returns

a pointer to the nth SpeciesTypeComponentMapInProduct_t in this MultiSpeciesReferencePlugin_t.

Warning

The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the "disownedItem" in the ListOf_appendAndOwn() or ListOf_insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.

SpeciesTypeComponentMapInProduct_t * MultiSpeciesReferencePlugin_removeSpeciesTypeComponentMapInProductById	(	MultiSpeciesReferencePlugin_t *	msrp,
		const char *	sid
	)

Removes the SpeciesTypeComponentMapInProduct_t from this MultiSpeciesReferencePlugin_t based on its identifier and returns a pointer to it.

Parameters

msrp	the MultiSpeciesReferencePlugin_t structure to search.
sid	a string representing the identifier of the SpeciesTypeComponentMapInProduct_t to remove.

Returns

the SpeciesTypeComponentMapInProduct_t in this MultiSpeciesReferencePlugin_t based on the identifier or NULL if no such SpeciesTypeComponentMapInProduct_t exists.

Warning

The pointer that is returned by this function is owned by the caller, who is responsible for deleting it. Any changes made to the element will not be reflected in any resulting SBML document unless the element is added to an SBML Document. Even in this case, the element's deletion is still the responsibility of the caller with two exceptions: if it is used as the "disownedItem" in the ListOf_appendAndOwn() or ListOf_insertAndOwn() functions. All other functions in libsbml add a copy of the element, and do not transfer ownership of the pointer.