MultiSpeciesPlugin_t Class Reference

Detailed Description

multi Extension of Species_t for the "multi" package.

The MultiSpeciesPlugin_t class extends the Species_t class to have a new attribute "speciesType", and two extra optional ListOfOutwardBindingSites_t and ListOfSpeciesFeatures_t children. A species may have a ListOfOutwardBindingSites_t child and/or a ListOfSpeciesFeatures_t child only when its speciesType attribute has been defined. The relationship among the elements of a ListOfOutwardBindingSites_t or a ListOfSpeciesFeatures_t is "and".

Public Member Functions
int	MultiSpeciesPlugin_addOutwardBindingSite (MultiSpeciesPlugin_t *msp, const OutwardBindingSite_t *obs)
	Adds a copy of the given OutwardBindingSite_t to this MultiSpeciesPlugin_t. More...
int	MultiSpeciesPlugin_addSpeciesFeature (MultiSpeciesPlugin_t *msp, const SpeciesFeature_t *sf)
	Adds a copy of the given SpeciesFeature_t to this MultiSpeciesPlugin_t. More...
OutwardBindingSite_t *	MultiSpeciesPlugin_createOutwardBindingSite (MultiSpeciesPlugin_t *msp)
	Creates a new OutwardBindingSite_t object, adds it to this MultiSpeciesPlugin_t object and returns the OutwardBindingSite_t object created. More...
SpeciesFeature_t *	MultiSpeciesPlugin_createSpeciesFeature (MultiSpeciesPlugin_t *msp)
	Creates a new SpeciesFeature_t object, adds it to this MultiSpeciesPlugin_t object and returns the SpeciesFeature_t object created. More...
ListOf_t *	MultiSpeciesPlugin_getListOfOutwardBindingSites (MultiSpeciesPlugin_t *msp)
	Returns a ListOf_t * containing OutwardBindingSite_t objects from this MultiSpeciesPlugin_t. More...
ListOf_t *	MultiSpeciesPlugin_getListOfSpeciesFeatures (MultiSpeciesPlugin_t *msp)
	Returns a ListOf_t * containing SpeciesFeature_t objects from this MultiSpeciesPlugin_t. More...
unsigned int	MultiSpeciesPlugin_getNumOutwardBindingSites (MultiSpeciesPlugin_t *msp)
	Get the number of OutwardBindingSite_t objects in this MultiSpeciesPlugin_t. More...
unsigned int	MultiSpeciesPlugin_getNumSpeciesFeatures (MultiSpeciesPlugin_t *msp)
	Get the number of SpeciesFeature_t objects in this MultiSpeciesPlugin_t. More...
OutwardBindingSite_t *	MultiSpeciesPlugin_getOutwardBindingSite (MultiSpeciesPlugin_t *msp, unsigned int n)
	Get an OutwardBindingSite_t from the MultiSpeciesPlugin_t. More...
OutwardBindingSite_t *	MultiSpeciesPlugin_getOutwardBindingSiteById (MultiSpeciesPlugin_t *msp, const char *sid)
	Get an OutwardBindingSite_t from the MultiSpeciesPlugin_t based on its identifier. More...
SpeciesFeature_t *	MultiSpeciesPlugin_getSpeciesFeature (MultiSpeciesPlugin_t *msp, unsigned int n)
	Get a SpeciesFeature_t from the MultiSpeciesPlugin_t. More...
SpeciesFeature_t *	MultiSpeciesPlugin_getSpeciesFeatureById (MultiSpeciesPlugin_t *msp, const char *sid)
	Get a SpeciesFeature_t from the MultiSpeciesPlugin_t based on its identifier. More...
char *	MultiSpeciesPlugin_getSpeciesType (const MultiSpeciesPlugin_t *msp)
	Returns the value of the "speciesType" attribute of this MultiSpeciesPlugin_t. More...
int	MultiSpeciesPlugin_isSetSpeciesType (const MultiSpeciesPlugin_t *msp)
	Predicate returning 1 (true) if this MultiSpeciesPlugin_t's "speciesType" attribute is set. More...
OutwardBindingSite_t *	MultiSpeciesPlugin_removeOutwardBindingSite (MultiSpeciesPlugin_t *msp, unsigned int n)
	Removes the nth OutwardBindingSite_t from this MultiSpeciesPlugin_t and returns a pointer to it. More...
OutwardBindingSite_t *	MultiSpeciesPlugin_removeOutwardBindingSiteById (MultiSpeciesPlugin_t *msp, const char *sid)
	Removes the OutwardBindingSite_t from this MultiSpeciesPlugin_t based on its identifier and returns a pointer to it. More...
SpeciesFeature_t *	MultiSpeciesPlugin_removeSpeciesFeature (MultiSpeciesPlugin_t *msp, unsigned int n)
	Removes the nth SpeciesFeature_t from this MultiSpeciesPlugin_t and returns a pointer to it. More...
SpeciesFeature_t *	MultiSpeciesPlugin_removeSpeciesFeatureById (MultiSpeciesPlugin_t *msp, const char *sid)
	Removes the SpeciesFeature_t from this MultiSpeciesPlugin_t based on its identifier and returns a pointer to it. More...
int	MultiSpeciesPlugin_setSpeciesType (MultiSpeciesPlugin_t *msp, const char *speciesType)
	Sets the value of the "speciesType" attribute of this MultiSpeciesPlugin_t. More...
int	MultiSpeciesPlugin_unsetSpeciesType (MultiSpeciesPlugin_t *msp)
	Unsets the value of the "speciesType" attribute of this MultiSpeciesPlugin_t. More...

Member Function Documentation

int MultiSpeciesPlugin_addOutwardBindingSite	(	MultiSpeciesPlugin_t *	msp,
		const OutwardBindingSite_t *	obs
	)

Adds a copy of the given OutwardBindingSite_t to this MultiSpeciesPlugin_t.

Parameters

msp	the MultiSpeciesPlugin_t structure to which the OutwardBindingSite_t should be added.
obs	the OutwardBindingSite_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

int MultiSpeciesPlugin_addSpeciesFeature	(	MultiSpeciesPlugin_t *	msp,
		const SpeciesFeature_t *	sf
	)

Adds a copy of the given SpeciesFeature_t to this MultiSpeciesPlugin_t.

Parameters

msp	the MultiSpeciesPlugin_t structure to which the SpeciesFeature_t should be added.
sf	the SpeciesFeature_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

OutwardBindingSite_t * MultiSpeciesPlugin_createOutwardBindingSite

(

MultiSpeciesPlugin_t *

msp

)

Creates a new OutwardBindingSite_t object, adds it to this MultiSpeciesPlugin_t object and returns the OutwardBindingSite_t object created.

Parameters

msp	the MultiSpeciesPlugin_t structure to which the OutwardBindingSite_t should be added.

Returns

a new OutwardBindingSite_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.

SpeciesFeature_t * MultiSpeciesPlugin_createSpeciesFeature

(

MultiSpeciesPlugin_t *

msp

)

Creates a new SpeciesFeature_t object, adds it to this MultiSpeciesPlugin_t object and returns the SpeciesFeature_t object created.

Parameters

msp	the MultiSpeciesPlugin_t structure to which the SpeciesFeature_t should be added.

Returns

a new SpeciesFeature_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 * MultiSpeciesPlugin_getListOfOutwardBindingSites

(

MultiSpeciesPlugin_t *

msp

)

Returns a ListOf_t * containing OutwardBindingSite_t objects from this MultiSpeciesPlugin_t.

Parameters

msp	the MultiSpeciesPlugin_t structure whose ListOfOutwardBindingSites_t is sought.

Returns

the ListOfOutwardBindingSites_t from this MultiSpeciesPlugin_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

MultiSpeciesPlugin_addOutwardBindingSite()

MultiSpeciesPlugin_createOutwardBindingSite()

MultiSpeciesPlugin_getOutwardBindingSiteById()

MultiSpeciesPlugin_getOutwardBindingSite()

MultiSpeciesPlugin_getNumOutwardBindingSites()

MultiSpeciesPlugin_removeOutwardBindingSiteById()

MultiSpeciesPlugin_removeOutwardBindingSite()

ListOf_t * MultiSpeciesPlugin_getListOfSpeciesFeatures

(

MultiSpeciesPlugin_t *

msp

)

Returns a ListOf_t * containing SpeciesFeature_t objects from this MultiSpeciesPlugin_t.

Parameters

msp	the MultiSpeciesPlugin_t structure whose ListOfSpeciesFeatures_t is sought.

Returns

the ListOfSpeciesFeatures_t from this MultiSpeciesPlugin_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

MultiSpeciesPlugin_addSpeciesFeature()

MultiSpeciesPlugin_createSpeciesFeature()

MultiSpeciesPlugin_getSpeciesFeatureById()

MultiSpeciesPlugin_getSpeciesFeature()

MultiSpeciesPlugin_getNumSpeciesFeatures()

MultiSpeciesPlugin_removeSpeciesFeatureById()

MultiSpeciesPlugin_removeSpeciesFeature()

unsigned int MultiSpeciesPlugin_getNumOutwardBindingSites

(

MultiSpeciesPlugin_t *

msp

)

Get the number of OutwardBindingSite_t objects in this MultiSpeciesPlugin_t.

Parameters

msp	the MultiSpeciesPlugin_t structure to query.

Returns

the number of OutwardBindingSite_t objects in this MultiSpeciesPlugin_t.

unsigned int MultiSpeciesPlugin_getNumSpeciesFeatures

(

MultiSpeciesPlugin_t *

msp

)

Get the number of SpeciesFeature_t objects in this MultiSpeciesPlugin_t.

Parameters

msp	the MultiSpeciesPlugin_t structure to query.

Returns

the number of SpeciesFeature_t objects in this MultiSpeciesPlugin_t.

OutwardBindingSite_t * MultiSpeciesPlugin_getOutwardBindingSite	(	MultiSpeciesPlugin_t *	msp,
		unsigned int	n
	)

Get an OutwardBindingSite_t from the MultiSpeciesPlugin_t.

Parameters

msp	the MultiSpeciesPlugin_t structure to search.
n	an unsigned int representing the index of the OutwardBindingSite_t to retrieve.

Returns

the nth OutwardBindingSite_t in the ListOfOutwardBindingSites_t within this MultiSpeciesPlugin_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.

OutwardBindingSite_t * MultiSpeciesPlugin_getOutwardBindingSiteById	(	MultiSpeciesPlugin_t *	msp,
		const char *	sid
	)

Get an OutwardBindingSite_t from the MultiSpeciesPlugin_t based on its identifier.

Parameters

msp	the MultiSpeciesPlugin_t structure to search.
sid	a string representing the identifier of the OutwardBindingSite_t to retrieve.

Returns

the OutwardBindingSite_t in the ListOfOutwardBindingSites_t within this MultiSpeciesPlugin_t with the given sid or NULL if no such OutwardBindingSite_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.

SpeciesFeature_t * MultiSpeciesPlugin_getSpeciesFeature	(	MultiSpeciesPlugin_t *	msp,
		unsigned int	n
	)

Get a SpeciesFeature_t from the MultiSpeciesPlugin_t.

Parameters

msp	the MultiSpeciesPlugin_t structure to search.
n	an unsigned int representing the index of the SpeciesFeature_t to retrieve.

Returns

the nth SpeciesFeature_t in the ListOfSpeciesFeatures_t within this MultiSpeciesPlugin_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.

SpeciesFeature_t * MultiSpeciesPlugin_getSpeciesFeatureById	(	MultiSpeciesPlugin_t *	msp,
		const char *	sid
	)

Get a SpeciesFeature_t from the MultiSpeciesPlugin_t based on its identifier.

Parameters

msp	the MultiSpeciesPlugin_t structure to search.
sid	a string representing the identifier of the SpeciesFeature_t to retrieve.

Returns

the SpeciesFeature_t in the ListOfSpeciesFeatures_t within this MultiSpeciesPlugin_t with the given sid or NULL if no such SpeciesFeature_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.

char * MultiSpeciesPlugin_getSpeciesType

(

const MultiSpeciesPlugin_t *

msp

)

Returns the value of the "speciesType" attribute of this MultiSpeciesPlugin_t.

Parameters

msp	the MultiSpeciesPlugin_t structure whose speciesType is sought.

Returns

the value of the "speciesType" attribute of this MultiSpeciesPlugin_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 MultiSpeciesPlugin_isSetSpeciesType

(

const MultiSpeciesPlugin_t *

msp

)

Predicate returning 1 (true) if this MultiSpeciesPlugin_t's "speciesType" attribute is set.

Parameters

msp	the MultiSpeciesPlugin_t structure.

Returns

1 (true) if this MultiSpeciesPlugin_t's "speciesType" attribute has been set, otherwise 0 (false) is returned.

OutwardBindingSite_t * MultiSpeciesPlugin_removeOutwardBindingSite	(	MultiSpeciesPlugin_t *	msp,
		unsigned int	n
	)

Removes the nth OutwardBindingSite_t from this MultiSpeciesPlugin_t and returns a pointer to it.

Parameters

msp	the MultiSpeciesPlugin_t structure to search.
n	an unsigned int representing the index of the OutwardBindingSite_t to remove.

Returns

a pointer to the nth OutwardBindingSite_t in this MultiSpeciesPlugin_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.

OutwardBindingSite_t * MultiSpeciesPlugin_removeOutwardBindingSiteById	(	MultiSpeciesPlugin_t *	msp,
		const char *	sid
	)

Removes the OutwardBindingSite_t from this MultiSpeciesPlugin_t based on its identifier and returns a pointer to it.

Parameters

msp	the MultiSpeciesPlugin_t structure to search.
sid	a string representing the identifier of the OutwardBindingSite_t to remove.

Returns

the OutwardBindingSite_t in this MultiSpeciesPlugin_t based on the identifier or NULL if no such OutwardBindingSite_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.

SpeciesFeature_t * MultiSpeciesPlugin_removeSpeciesFeature	(	MultiSpeciesPlugin_t *	msp,
		unsigned int	n
	)

Removes the nth SpeciesFeature_t from this MultiSpeciesPlugin_t and returns a pointer to it.

Parameters

msp	the MultiSpeciesPlugin_t structure to search.
n	an unsigned int representing the index of the SpeciesFeature_t to remove.

Returns

a pointer to the nth SpeciesFeature_t in this MultiSpeciesPlugin_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.

SpeciesFeature_t * MultiSpeciesPlugin_removeSpeciesFeatureById	(	MultiSpeciesPlugin_t *	msp,
		const char *	sid
	)

Removes the SpeciesFeature_t from this MultiSpeciesPlugin_t based on its identifier and returns a pointer to it.

Parameters

msp	the MultiSpeciesPlugin_t structure to search.
sid	a string representing the identifier of the SpeciesFeature_t to remove.

Returns

the SpeciesFeature_t in this MultiSpeciesPlugin_t based on the identifier or NULL if no such SpeciesFeature_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.

int MultiSpeciesPlugin_setSpeciesType	(	MultiSpeciesPlugin_t *	msp,
		const char *	speciesType
	)

Sets the value of the "speciesType" attribute of this MultiSpeciesPlugin_t.

Parameters

msp	the MultiSpeciesPlugin_t structure.
speciesType	const char * value of the "speciesType" 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:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_INVALID_ATTRIBUTE_VALUE
• LIBSBML_INVALID_OBJECT

int MultiSpeciesPlugin_unsetSpeciesType

(

MultiSpeciesPlugin_t *

msp

)

Unsets the value of the "speciesType" attribute of this MultiSpeciesPlugin_t.

Parameters

msp	the MultiSpeciesPlugin_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:

• LIBSBML_OPERATION_SUCCESS
• LIBSBML_OPERATION_FAILED
• LIBSBML_INVALID_OBJECT