Inheritance diagram for MultiModelPlugin:

Detailed Description

multi Extension of Model.

This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.

The MultiModelPlugin object is used to extend the standard SBML Model object to allow a ListOfSpeciesTypes child.

Public Member Functions
int	addMultiSpeciesType (const MultiSpeciesType *multiSpeciesType)
	Adds a copy of the given MultiSpeciesType to the ListOfMultiSpeciesTypes in this plugin object. More...

virtual MultiModelPlugin *	clone () const
	Creates and returns a deep copy of this MultiModelPlugin object. More...

BindingSiteSpeciesType *	createBindingSiteSpeciesType ()
	Creates a new BindingSiteSpeciesType object and adds it to the ListOfMultiSpeciesTypes in this plugin object. More...

IntraSpeciesReaction *	createIntraSpeciesReaction ()
	Creates a new IntraSpeciesReaction object and adds it to the ListOfReactions. More...

MultiSpeciesType *	createMultiSpeciesType ()
	Creates a new MultiSpeciesType object and adds it to the ListOfMultiSpeciesTypes in this plugin object. More...

virtual List *	getAllElements (ElementFilter *filter=NULL)
	Returns a List of all child SBase objects, including those nested to an arbitary depth. More...

virtual SBase *	getElementByMetaId (const std::string &metaid)
	Return the first child object found with a given meta identifier. More...

virtual SBase *	getElementBySId (const std::string &id)
	Return the first child object found with a given identifier. More...

const std::string &	getElementNamespace () const
	Returns the namespace URI of the package to which this plugin object belongs. More...

unsigned int	getLevel () const
	Returns the SBML Level of the package extension of this plugin object. More...

const ListOfMultiSpeciesTypes *	getListOfMultiSpeciesTypes () const
	Returns the ListOfMultiSpeciesTypes in this plugin object. More...

ListOfMultiSpeciesTypes *	getListOfMultiSpeciesTypes ()
	Returns the ListOfMultiSpeciesTypes in this plugin object. More...

const MultiSpeciesType *	getMultiSpeciesType (unsigned int n) const
	Returns the MultiSpeciesType object that belongs to the given index. More...

MultiSpeciesType *	getMultiSpeciesType (unsigned int n)
	Returns the MultiSpeciesType object that belongs to the given index. More...

const MultiSpeciesType *	getMultiSpeciesType (const std::string &sid) const
	Returns the MultiSpeciesType object based on its identifier. More...

MultiSpeciesType *	getMultiSpeciesType (const std::string &sid)
	Returns the MultiSpeciesType object based on its identifier. More...

unsigned int	getNumMultiSpeciesTypes () const
	Returns the number of MultiSpeciesType objects in this plugin object. More...

const std::string &	getPackageName () const
	Returns the short-form name of the package to which this plugin object belongs. More...

unsigned int	getPackageVersion () const
	Returns the package version of the package extension of this plugin object. More...

SBase *	getParentSBMLObject ()
	Returns the parent object to which this plugin object is connected. More...

const SBase *	getParentSBMLObject () const
	Returns the parent object to which this plugin object is connected. More...

const std::string &	getPrefix () const
	Returns the XML namespace prefix of the package to which this plugin object belongs. More...

SBMLDocument *	getSBMLDocument ()
	Returns the SBMLDocument object containing this object instance. More...

const SBMLDocument *	getSBMLDocument () const
	Returns the SBMLDocument object containing this object instance. More...

std::string	getURI () const
	Returns the XML namespace URI for the package to which this object belongs. More...

unsigned int	getVersion () const
	Returns the Version within the SBML Level of the package extension of this plugin object. More...

virtual bool	hasRequiredElements () const
	Returns `true` if this object has all the required elements. More...

virtual bool	isValidTypeForList (SBase *item) const

	MultiModelPlugin (const std::string &uri, const std::string &prefix, MultiPkgNamespaces *multins)
	Creates a new MultiModelPlugin object using the given parameters. More...

	MultiModelPlugin (const MultiModelPlugin &orig)
	Copy constructor for MultiModelPlugin. More...

MultiModelPlugin &	operator= (const MultiModelPlugin &rhs)
	Assignment operator for MultiModelPlugin. More...

MultiSpeciesType *	removeMultiSpeciesType (unsigned int n)
	Removes the nth MultiSpeciesType object from this plugin object and returns a pointer to it. More...

MultiSpeciesType *	removeMultiSpeciesType (const std::string &sid)
	Removes the MultiSpeciesType object with the given id from this plugin object and returns a pointer to it. More...

virtual void	renameMetaIdRefs (const std::string &oldid, const std::string &newid)
	Replaces all uses of a given meta identifier attribute value with another value. More...

virtual void	renameSIdRefs (const std::string &oldid, const std::string &newid)
	Replaces all uses of a given `SIdRef` type attribute value with another value. More...

virtual void	renameUnitSIdRefs (const std::string &oldid, const std::string &newid)
	Replaces all uses of a given `UnitSIdRef` type attribute value with another value. More...

int	setElementNamespace (const std::string &uri)
	Sets the XML namespace to which this object belongs. More...

virtual	~MultiModelPlugin ()
	Destructor for MultiModelPlugin. More...

Constructor & Destructor Documentation

MultiModelPlugin::MultiModelPlugin	(	const std::string &	uri,
		const std::string &	prefix,
		MultiPkgNamespaces *	multins
	)

Creates a new MultiModelPlugin object using the given parameters.

: In the XML representation of an SBML document, XML namespaces are used to identify the origin of each XML construct used. XML namespaces are identified by their unique resource identifiers (URIs). The core SBML specifications stipulate the namespaces that must be used for core SBML constructs; for example, all XML elements that belong to SBML Level 3 Version 1 Core must be placed in the XML namespace identified by the URI "http://www.sbml.org/sbml/level3/version1/core". Individual SBML Level 3 packages define their own XML namespaces; for example, all elements belonging to the SBML Level 3 Layout Version 1 package must be placed in the XML namespace "http://www.sbml.org/sbml/level3/version1/layout/version1/".

: The SBMLNamespaces object encapsulates SBML Level/Version/namespaces information. It is used to communicate the SBML Level, Version, and (in Level 3) packages used in addition to SBML Level 3 Core. A common approach to using libSBML's SBMLNamespaces facilities is to create an SBMLNamespaces object somewhere in a program once, then hand that object as needed to object constructors that accept SBMLNamespaces as arguments.

Parameters

uri	the URI of the SBML Level 3 package implemented by this libSBML package extension.
prefix	the XML namespace prefix being used for the package.
multins	the namespaces object for the package.

MultiModelPlugin::MultiModelPlugin ( const MultiModelPlugin & orig )

Copy constructor for MultiModelPlugin.

Parameters

orig	the MultiModelPlugin instance to copy.

MultiModelPlugin::~MultiModelPlugin ( )

virtual

Destructor for MultiModelPlugin.

Member Function Documentation

int MultiModelPlugin::addMultiSpeciesType ( const MultiSpeciesType * multiSpeciesType )

Adds a copy of the given MultiSpeciesType to the ListOfMultiSpeciesTypes in this plugin object.

Parameters

multiSpeciesType the multiSpeciesType to be added.

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

MultiModelPlugin * MultiModelPlugin::clone ( ) const

virtual

Creates and returns a deep copy of this MultiModelPlugin object.

Returns: a (deep) copy of this MultiModelPlugin object.

Reimplemented from SBasePlugin.

BindingSiteSpeciesType * MultiModelPlugin::createBindingSiteSpeciesType ( )

Creates a new BindingSiteSpeciesType object and adds it to the ListOfMultiSpeciesTypes in this plugin object.

Returns: the newly created BindingSiteSpeciesType object.

IntraSpeciesReaction * MultiModelPlugin::createIntraSpeciesReaction ( )

Creates a new IntraSpeciesReaction object and adds it to the ListOfReactions.

Returns: the newly created IntraSpeciesReaction object.

MultiSpeciesType * MultiModelPlugin::createMultiSpeciesType ( )

Creates a new MultiSpeciesType object and adds it to the ListOfMultiSpeciesTypes in this plugin object.

Returns: the newly created MultiSpeciesType object.

List * MultiModelPlugin::getAllElements ( ElementFilter * filter = NULL )

virtual

Returns a List of all child SBase objects, including those nested to an arbitary depth.

Parameters

filter a pointer to an ElementFilter, which causes the function to return only elements that match a particular set of constraints. If NULL (the default), the function will return all child objects.

Returns: a List of pointers to all child objects.

Reimplemented from SBasePlugin.

SBase * SBasePlugin::getElementByMetaId ( const std::string & metaid )

virtualinherited

Return the first child object found with a given meta identifier.

This method searches all the subobjects under this one, compares their meta identifiers to metaid, and returns the first one that machines.

Parameters

metaid string, the metaid of the object to find.

Returns: pointer to the first object found with the given metaid.

Reimplemented in QualModelPlugin, GroupsModelPlugin, CompModelPlugin, CompSBasePlugin, and CompSBMLDocumentPlugin.

SBase * SBasePlugin::getElementBySId ( const std::string & id )

virtualinherited

Return the first child object found with a given identifier.

This method searches all the subobjects under this one, compares their identifiers to id, and returns the first one that machines. It uses SBasePlugin::getAllElements(ElementFilter* filter) to get the list of identifiers, so the order in which identifiers are searched is the order in which they appear in the results returned by that method.

Normally, SId type identifier values are unique across a model in SBML. However, in some circumstances they may not be, such as if a model is invalid because of multiple objects having the same identifier.

Parameters

id	string representing the identifier of the object to find.

Returns: pointer to the first object with the given id.

Reimplemented in QualModelPlugin, GroupsModelPlugin, CompModelPlugin, CompSBasePlugin, and CompSBMLDocumentPlugin.

const std::string & SBasePlugin::getElementNamespace ( ) const

inherited

Returns the namespace URI of the package to which this plugin object belongs.

Returns: the XML namespace URI of the SBML Level 3 package implemented by this libSBML package extension.

unsigned int SBasePlugin::getLevel ( ) const

inherited

Returns the SBML Level of the package extension of this plugin object.

Returns: the SBML Level.

See also: getVersion()

const ListOfMultiSpeciesTypes * MultiModelPlugin::getListOfMultiSpeciesTypes ( ) const

Returns the ListOfMultiSpeciesTypes in this plugin object.

Returns: ListOfMultiSpeciesTypes object in this plugin object.

ListOfMultiSpeciesTypes * MultiModelPlugin::getListOfMultiSpeciesTypes ( )

Returns the ListOfMultiSpeciesTypes in this plugin object.

Returns: ListOfMultiSpeciesTypes object in this plugin object.

const MultiSpeciesType * MultiModelPlugin::getMultiSpeciesType ( unsigned int n ) const

Returns the MultiSpeciesType object that belongs to the given index.

If the index is invalid, NULL is returned.

Parameters

n	the index number of the MultiSpeciesType to get

Returns: the nth MultiSpeciesType in the ListOfMultiSpeciesTypes If the index n is invalid, NULL is returned.

MultiSpeciesType * MultiModelPlugin::getMultiSpeciesType ( unsigned int n )

Returns the MultiSpeciesType object that belongs to the given index.

If the index is invalid, NULL is returned.

Parameters

n	the index number of the MultiSpeciesType to get

Returns: the nth MultiSpeciesType in the ListOfMultiSpeciesTypes If the index n is invalid, NULL is returned.

const MultiSpeciesType * MultiModelPlugin::getMultiSpeciesType ( const std::string & sid ) const

Returns the MultiSpeciesType object based on its identifier.

Parameters

sid	a string representing the id of the MultiSpeciesType to get

Returns: MultiSpeciesType in the ListOfMultiSpeciesTypes with the given id or NULL if no such MultiSpeciesType exists.

MultiSpeciesType * MultiModelPlugin::getMultiSpeciesType ( const std::string & sid )

Returns the MultiSpeciesType object based on its identifier.

Parameters

sid	a string representing the id of the MultiSpeciesType to get

Returns: MultiSpeciesType in the ListOfMultiSpeciesTypes with the given id or NULL if no such MultiSpeciesType exists.

unsigned int MultiModelPlugin::getNumMultiSpeciesTypes ( ) const

Returns the number of MultiSpeciesType objects in this plugin object.

Returns: the number of MultiSpeciesType objects in this plugin object.

const std::string & SBasePlugin::getPackageName ( ) const

inherited

Returns the short-form name of the package to which this plugin object belongs.

Returns: the short-form package name (or nickname) of the SBML package implemented by this package extension.

unsigned int SBasePlugin::getPackageVersion ( ) const

inherited

Returns the package version of the package extension of this plugin object.

Returns: the package version of the package extension of this plugin object.

See also: getLevel(); getVersion()

SBase * SBasePlugin::getParentSBMLObject ( )

inherited

Returns the parent object to which this plugin object is connected.

Returns: the parent object of this object.

const SBase * SBasePlugin::getParentSBMLObject ( ) const

inherited

Returns the parent object to which this plugin object is connected.

Returns: the parent object of this object.

const std::string & SBasePlugin::getPrefix ( ) const

inherited

Returns the XML namespace prefix of the package to which this plugin object belongs.

Returns: the XML namespace prefix of the SBML Level 3 package implemented by this libSBML package extension.

SBMLDocument * SBasePlugin::getSBMLDocument ( )

inherited

Returns the SBMLDocument object containing this object instance.

: LibSBML uses the class SBMLDocument as a top-level container for storing SBML content and data associated with it (such as warnings and error messages). An SBML model in libSBML is contained inside an SBMLDocument object. SBMLDocument corresponds roughly to the class SBML defined in the SBML Level 3 and Level 2 specifications, but it does not have a direct correspondence in SBML Level 1. (But, it is created by libSBML no matter whether the model is Level 1, Level 2 or Level 3.)

This method allows the caller to obtain the SBMLDocument for the current object.

Returns: the parent SBMLDocument object of this plugin object.

See also: getParentSBMLObject()

const SBMLDocument * SBasePlugin::getSBMLDocument ( ) const

inherited

Returns the SBMLDocument object containing this object instance.

: LibSBML uses the class SBMLDocument as a top-level container for storing SBML content and data associated with it (such as warnings and error messages). An SBML model in libSBML is contained inside an SBMLDocument object. SBMLDocument corresponds roughly to the class SBML defined in the SBML Level 3 and Level 2 specifications, but it does not have a direct correspondence in SBML Level 1. (But, it is created by libSBML no matter whether the model is Level 1, Level 2 or Level 3.)

This method allows the caller to obtain the SBMLDocument for the current object.

Returns: the parent SBMLDocument object of this plugin object.

See also: getParentSBMLObject()

std::string SBasePlugin::getURI ( ) const

inherited

Returns the XML namespace URI for the package to which this object belongs.

: In the XML representation of an SBML document, XML namespaces are used to identify the origin of each XML construct used. XML namespaces are identified by their unique resource identifiers (URIs). The core SBML specifications stipulate the namespaces that must be used for core SBML constructs; for example, all XML elements that belong to SBML Level 3 Version 1 Core must be placed in the XML namespace identified by the URI "http://www.sbml.org/sbml/level3/version1/core". Individual SBML Level 3 packages define their own XML namespaces; for example, all elements belonging to the SBML Level 3 Layout Version 1 package must be placed in the XML namespace "http://www.sbml.org/sbml/level3/version1/layout/version1/".

This method first looks into the SBMLNamespaces object possessed by the parent SBMLDocument object of the current object. If this cannot be found, this method returns the result of getElementNamespace().

Returns: a string, the URI of the XML namespace to which this object belongs.

See also: getPackageName(); getElementNamespace(); getSBMLDocument()

unsigned int SBasePlugin::getVersion ( ) const

inherited

Returns the Version within the SBML Level of the package extension of this plugin object.

Returns: the SBML Version.

See also: getLevel()

bool MultiModelPlugin::hasRequiredElements ( ) const

virtual

Returns true if this object has all the required elements.

Returns: true if this object has all the elements required by the package specification; otherwise, false will be returned.

virtual bool SBasePlugin::isValidTypeForList ( SBase * item ) const

virtualinherited

MultiModelPlugin & MultiModelPlugin::operator= ( const MultiModelPlugin & rhs )

Assignment operator for MultiModelPlugin.

Parameters

rhs	the object whose values are used as the basis of the assignment.

MultiSpeciesType * MultiModelPlugin::removeMultiSpeciesType ( unsigned int n )

Removes the nth MultiSpeciesType object from this plugin object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

n	the index of the MultiSpeciesType to remove

Returns: the MultiSpeciesType object removed or NULL index was out of range.

MultiSpeciesType * MultiModelPlugin::removeMultiSpeciesType ( const std::string & sid )

Removes the MultiSpeciesType object with the given id from this plugin object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters

sid	a string representing the id of the MultiSpeciesType to remove

Returns: the MultiSpeciesType object removed or NULL if no such MultiSpeciesType exists.

virtual void SBasePlugin::renameMetaIdRefs	(	const std::string &	oldid,
		const std::string &	newid
	)

virtualinherited

Replaces all uses of a given meta identifier attribute value with another value.

: In SBML, object "meta" identifiers are of the XML data type ID; the SBML object attribute itself is typically named metaid. All attributes that hold values referring to values of type ID are of the XML data type IDREF. They are also sometimes informally referred to as "metaid refs", in analogy to the SBML-defined type SIdRef.

This method works by looking at all meta-identifier attribute values, comparing the identifiers to the value of oldid. If any matches are found, the matching identifiers are replaced with newid. The method does not descend into child elements.

Parameters

oldid	the old identifier.
newid	the new identifier.

virtual void SBasePlugin::renameSIdRefs	(	const std::string &	oldid,
		const std::string &	newid
	)

virtualinherited

Replaces all uses of a given SIdRef type attribute value with another value.

In SBML, object identifiers are of a data type called SId. In SBML Level 3, an explicit data type called SIdRef was introduced for attribute values that refer to SId values; in previous Levels of SBML, this data type did not exist and attributes were simply described to as "referring to an identifier", but the effective data type was the same as SIdRef in Level 3. These and other methods of libSBML refer to the type SIdRef for all Levels of SBML, even if the corresponding SBML specification did not explicitly name the data type.

This method works by looking at all attributes and (if appropriate) mathematical formulas in MathML content, comparing the referenced identifiers to the value of oldid. If any matches are found, the matching values are replaced with newid. The method does not descend into child elements.

Parameters

oldid	the old identifier.
newid	the new identifier.

Reimplemented in FbcReactionPlugin.

virtual void SBasePlugin::renameUnitSIdRefs	(	const std::string &	oldid,
		const std::string &	newid
	)

virtualinherited

Replaces all uses of a given UnitSIdRef type attribute value with another value.

: In SBML, unit definitions have identifiers of type UnitSId. In SBML Level 3, an explicit data type called UnitSIdRef was introduced for attribute values that refer to UnitSId values; in previous Levels of SBML, this data type did not exist and attributes were simply described to as "referring to a unit identifier", but the effective data type was the same as UnitSIdRef in Level 3. These and other methods of libSBML refer to the type UnitSIdRef for all Levels of SBML, even if the corresponding SBML specification did not explicitly name the data type.

This method works by looking at all unit identifier attribute values (including, if appropriate, inside mathematical formulas), comparing the referenced unit identifiers to the value of oldid. If any matches are found, the matching values are replaced with newid. The method does not descend into child elements.

Parameters

oldid	the old identifier.
newid	the new identifier.

int SBasePlugin::setElementNamespace ( const std::string & uri )

inherited

Sets the XML namespace to which this object belongs.

: In the XML representation of an SBML document, XML namespaces are used to identify the origin of each XML construct used. XML namespaces are identified by their unique resource identifiers (URIs). The core SBML specifications stipulate the namespaces that must be used for core SBML constructs; for example, all XML elements that belong to SBML Level 3 Version 1 Core must be placed in the XML namespace identified by the URI "http://www.sbml.org/sbml/level3/version1/core". Individual SBML Level 3 packages define their own XML namespaces; for example, all elements belonging to the SBML Level 3 Layout Version 1 package must be placed in the XML namespace "http://www.sbml.org/sbml/level3/version1/layout/version1/".

Parameters

uri	the URI to assign to this object.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:

LIBSBML_OPERATION_SUCCESS

See also: getElementNamespace()

Examples:: convertLayout.cpp.

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation