Inheritance diagram for libsbml.MultiCompartmentPlugin:

Detailed Description

multi Extension of Compartment for the 'multi' package.

The MultiCompartmentPlugin object is used to extend the standard SBML Compartment base object with an optional 'compartmentType' attribute, a required 'isType' Boolean attribute, and a child ListOfCompartmentReferences. The 'isType' attribute flags whether this Compartment should be treated as a standard SBML Compartment (if False), or as a more generic rule-based 'type' of Compartment (if True). A compartment 'type' is a template (in the sense of prototype) for all Compartment objects referencing it (via 'compartmentType' attributes). A Species object directly referencing a compartment type is not a 'fully defined' species, but rather a 'template' species. If the value of the 'isType' attribute is False, the Compartment object is a 'not-a-type' compartment, and it is similar to a SBML core Compartment except it can reference a compartment type and can have a ListOfCompartmentReferences child. Each child CompartmentReference in the ListOfCompartmentReferences defines a subcompartment of the parent Compartment. The 'compartmentType' attribute identifies this Compartment as the CompartmentType defined elsewhere in the Model. If the 'compartmentType' attribute is set, the 'isType' attribute must be True.

Public Member Functions
def	__init__ (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	addCompartmentReference (self, compartmentReference)
	Adds a copy of the given CompartmentReference object to the ListOfCompartmentReferences. More...

def	clone (self)
	Creates and returns a deep copy of this MultiCompartmentPlugin object. More...

def	createCompartmentReference (self)
	Creates a new CompartmentReference object and adds it to the ListOfCompartmentReferences. More...

def	getCompartmentReference (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	getCompartmentType (self)
	Returns the value of the 'compartmentType' attribute of this compartment. More...

def	getElementByMetaId (self, metaid)
	Return the first child object found with a given meta identifier. More...

def	getElementBySId (self, id)
	Return the first child object found with a given identifier. More...

def	getElementNamespace (self)
	Returns the namespace URI of the package to which this plugin object belongs. More...

def	getIsType (self)
	Returns the value of the 'isType' attribute. More...

def	getLevel (self)
	Returns the SBML Level of the package extension of this plugin object. More...

def	getListOfAllElements (self, filter=None)
	Returns an SBaseList of all child SBase objects, including those nested to an arbitrary depth. More...

def	getListOfCompartmentReferences (self, args)
	Returns the ListOfCompartmentReferences object. More...

def	getNumCompartmentReferences (self)
	Returns the number of CompartmentReference objects in the ListOfCompartmentReferences. More...

def	getPackageName (self)
	Returns the short-form name of the package to which this plugin object belongs. More...

def	getPackageVersion (self)
	Returns the package version of the package extension of this plugin object. More...

def	getParentSBMLObject (self, args)
	Returns the parent object to which this plugin object is connected. More...

def	getPrefix (self)
	Returns the XML namespace prefix of the package to which this plugin object belongs. More...

def	getSBMLDocument (self, args)
	Returns the SBMLDocument object containing this object instance. More...

def	getURI (self)
	Returns the XML namespace URI for the package to which this object belongs. More...

def	getVersion (self)
	Returns the Version within the SBML Level of the package extension of this plugin object. More...

def	hasRequiredElements (self)
	Returns `True` if this object has all the required elements. More...

def	isSetCompartmentType (self)
	Returns `True` if this compartment's 'compartmentType' attribute has been set. More...

def	isSetIsType (self)
	Returns `True` if this compartment's 'isType' attribute has been set. More...

def	isValidTypeForList (self, item)

def	removeCompartmentReference (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...

def	renameMetaIdRefs (self, oldid, newid)
	Replaces all uses of a given meta identifier attribute value with another value. More...

def	renameSIdRefs (self, oldid, newid)
	Replaces all uses of a given `SIdRef` type attribute value with another value. More...

def	renameUnitSIdRefs (self, oldid, newid)
	Replaces all uses of a given `UnitSIdRef` type attribute value with another value. More...

def	setCompartmentType (self, compartmentType)
	Sets the value of the 'compartmentType' attribute on this compartment. More...

def	setElementNamespace (self, uri)
	Sets the XML namespace to which this object belongs. More...

def	setIsType (self, isType)
	Sets the value of the 'isType' attribute. More...

def	unsetCompartmentType (self)
	Unsets the value of the 'compartmentType' attribute. More...

def	unsetIsType (self)
	Unsets the value of the 'isType' attribute. More...

Constructor & Destructor Documentation

def libsbml.MultiCompartmentPlugin.__init__	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

__init__(string uri, string prefix, MultiPkgNamespaces multins)   MultiCompartmentPlugin
__init__(MultiCompartmentPlugin orig)   MultiCompartmentPlugin

Each variant is described separately below.

Method variant with the following signature:

MultiCompartmentPlugin(string uri, string prefix, MultiPkgNamespaces multins)

Creates a new MultiCompartmentPlugin object.

: 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.

Method variant with the following signature:

MultiCompartmentPlugin(MultiCompartmentPlugin orig)

Copy constructor for MultiCompartmentPlugin.

Parameters

orig	the MultiCompartmentPlugin instance to copy.

Member Function Documentation

def libsbml.MultiCompartmentPlugin.addCompartmentReference	(	self,
		compartmentReference
	)

Adds a copy of the given CompartmentReference object to the ListOfCompartmentReferences.

addCompartmentReference(CompartmentReference compartmentReference)   int

Parameters

compartmentReference the CompartmentReference object to add.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

LIBSBML_OPERATION_SUCCESS

def libsbml.MultiCompartmentPlugin.clone ( self )

Creates and returns a deep copy of this MultiCompartmentPlugin object.

clone()   MultiCompartmentPlugin

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

def libsbml.MultiCompartmentPlugin.createCompartmentReference ( self )

Creates a new CompartmentReference object and adds it to the ListOfCompartmentReferences.

createCompartmentReference()   CompartmentReference

Returns: the newly created CompartmentReference object.

def libsbml.MultiCompartmentPlugin.getCompartmentReference	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

getCompartmentReference(long  n)   CompartmentReference
getCompartmentReference(string sid)   CompartmentReference

Each variant is described separately below.

Method variant with the following signature:

getCompartmentReference(long n)

Returns the nth CompartmentReference object from the ListOfCompartmentReferences.

Parameters

n	the index number of the CompartmentReference to get.

Returns: the nth CompartmentReference, or None if the index n is out of range.

Method variant with the following signature:

getCompartmentReference(string sid)

Returns the CompartmentReference with the given identifier sid.

Parameters

sid	the identifier of the CompartmentReference object to get from the ListOfCompartmentReferences.

Returns: the CompartmentReference object with the given identifier in the ListOfCompartmentReferences, or None if no such CompartmentReference exists.

def libsbml.MultiCompartmentPlugin.getCompartmentType ( self )

Returns the value of the 'compartmentType' attribute of this compartment.

getCompartmentType()   string

Returns: the 'compartmentType' attribute value.

def libsbml.SBasePlugin.getElementByMetaId	(	self,
		metaid
	)

inherited

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

getElementByMetaId(string metaid)   SBase

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.

def libsbml.SBasePlugin.getElementBySId	(	self,
		id
	)

inherited

Return the first child object found with a given identifier.

getElementBySId(string id)   SBase

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

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.

def libsbml.SBasePlugin.getElementNamespace ( self )

inherited

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

getElementNamespace()   string

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

def libsbml.MultiCompartmentPlugin.getIsType ( self )

Returns the value of the 'isType' attribute.

getIsType()   bool

Returns: the value of the 'isType' attribute.

def libsbml.SBasePlugin.getLevel ( self )

inherited

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

getLevel()   long

Returns: the SBML Level.

See also: getVersion()

def libsbml.SBasePlugin.getListOfAllElements	(	self,
		filter = `None`
	)

inherited

Returns an SBaseList of all child SBase objects, including those nested to an arbitrary depth.

getListOfAllElements(ElementFilter filter)   SBaseList
getListOfAllElements()   SBaseList

Returns: a list of all objects that are children of this object.

def libsbml.MultiCompartmentPlugin.getListOfCompartmentReferences	(	self,
		args
	)

Returns the ListOfCompartmentReferences object.

getListOfCompartmentReferences()   ListOfCompartmentReferences

Returns: the ListOfCompartmentReferences object within this 'multi' Compartment object.

def libsbml.MultiCompartmentPlugin.getNumCompartmentReferences ( self )

Returns the number of CompartmentReference objects in the ListOfCompartmentReferences.

getNumCompartmentReferences()   long

Returns: the number of CompartmentReference objects.

def libsbml.SBasePlugin.getPackageName ( self )

inherited

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

getPackageName()   string

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

def libsbml.SBasePlugin.getPackageVersion ( self )

inherited

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

getPackageVersion()   long

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

See also: getLevel(); getVersion()

def libsbml.SBasePlugin.getParentSBMLObject	(	self,
		args
	)

inherited

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

getParentSBMLObject()   SBase

Returns: the parent object of this object.

def libsbml.SBasePlugin.getPrefix ( self )

inherited

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

getPrefix()   string

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

def libsbml.SBasePlugin.getSBMLDocument	(	self,
		args
	)

inherited

Returns the SBMLDocument object containing this object instance.

getSBMLDocument()   SBMLDocument

: 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()

def libsbml.SBasePlugin.getURI ( self )

inherited

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

getURI()   string

: 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()

def libsbml.SBasePlugin.getVersion ( self )

inherited

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

getVersion()   long

Returns: the SBML Version.

See also: getLevel()

def libsbml.MultiCompartmentPlugin.hasRequiredElements ( self )

Returns True if this object has all the required elements.

hasRequiredElements()   bool

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

def libsbml.MultiCompartmentPlugin.isSetCompartmentType ( self )

Returns True if this compartment's 'compartmentType' attribute has been set.

isSetCompartmentType()   bool

Returns: True if the 'compartmentType' attribute has been set; otherwise, False is returned.

def libsbml.MultiCompartmentPlugin.isSetIsType ( self )

Returns True if this compartment's 'isType' attribute has been set.

isSetIsType()   bool

Returns: True if the 'isType' attribute has been set; otherwise, False is returned.

def libsbml.SBasePlugin.isValidTypeForList	(	self,
		item
	)

inherited

isValidTypeForList(SBase item)   bool

def libsbml.MultiCompartmentPlugin.removeCompartmentReference	(	self,
		args
	)

This method has multiple variants; they differ in the arguments they accept.

removeCompartmentReference(long  n)   CompartmentReference
removeCompartmentReference(string sid)   CompartmentReference

Each variant is described separately below.

Method variant with the following signature:

removeCompartmentReference(long n)

Removes the nth CompartmentReference object from the ListOfCompartmentReferences.

Parameters

n	the index of the CompartmentReference to remove.

Returns: the CompartmentReference object removed, or None if the given index n is out of range. Note that the caller owns the returned object and is responsible for deleting it.

Method variant with the following signature:

removeCompartmentReference(string sid)

Removes the CompartmentReference object with the given identifier from the ListOfCompartmentReferences.

Parameters

sid	the id of the CompartmentReference to remove.

Returns: the CompartmentReference object removed, or None if no such CompartmentReference exists. Note that the caller owns the returned object and is responsible for deleting it.

def libsbml.SBasePlugin.renameMetaIdRefs	(	self,
		oldid,
		newid
	)

inherited

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

renameMetaIdRefs(string oldid, string newid)

: 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.

def libsbml.SBasePlugin.renameSIdRefs	(	self,
		oldid,
		newid
	)

inherited

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

renameSIdRefs(string oldid, string newid)

: 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.

def libsbml.SBasePlugin.renameUnitSIdRefs	(	self,
		oldid,
		newid
	)

inherited

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

renameUnitSIdRefs(string oldid, string newid)

: 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.

def libsbml.MultiCompartmentPlugin.setCompartmentType	(	self,
		compartmentType
	)

Sets the value of the 'compartmentType' attribute on this compartment.

setCompartmentType(string compartmentType)   int

Parameters

compartmentType the new value for the attribute.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

def libsbml.SBasePlugin.setElementNamespace	(	self,
		uri
	)

inherited

Sets the XML namespace to which this object belongs.

setElementNamespace(string uri)   int

: 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. 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()

def libsbml.MultiCompartmentPlugin.setIsType	(	self,
		isType
	)

Sets the value of the 'isType' attribute.

setIsType(bool isType)   int

Parameters

isType the new value of the attribute.

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

def libsbml.MultiCompartmentPlugin.unsetCompartmentType ( self )

Unsets the value of the 'compartmentType' attribute.

unsetCompartmentType()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

def libsbml.MultiCompartmentPlugin.unsetIsType ( self )

Unsets the value of the 'isType' attribute.

unsetIsType()   int

Returns

integer value indicating success/failure of the function. The possible values returned by this function are:

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation