Inheritance diagram for libsbml.CompSBMLDocumentPlugin:

Detailed Description

The CompSBMLDocumentPlugin class inherits from the SBMLDocumentPlugin class, and codifies the extensions to the SBMLDocument class defined in the SBML Level 3 Hierarchical Model Composition (“comp”) package. This extension allows multiple Model objects to be defined in a single SBMLDocument, stored in an optional child ListOfModelDefinitions object, as well as define references to Model objects in other files, stored in the optional child ListOfExternalModelDefinitions object. These model definitions, if present, allow Submodel objects to reference other Models to instantiate.

The presence of any ModelDefinition or ExternalModelDefinition in an SBMLDocument does not change the default Model in the file. If a SBMLDocument is submitted somewhere to be simulated, it is still the <model> child of the <sbml> element that should be simulated.

In addition, as all packages do, the CompSBMLDocumentPlugin defines a required flag named required, which indicates whether “comp” constructs can be used to change the core mathematics of the <model> child of the <sbml> element. Because they can, this attribute must be set True.

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

def	addExternalModelDefinition (self, externalModelDefinition)
	Adds a copy of the given ExternalModelDefinition object to the ListOfExternalModelDefinitions. More...

def	addModelDefinition (self, modelDefinition)
	Adds a copy of the given ModelDefinition object to the ListOfModelDefinitions. More...

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

def	createExternalModelDefinition (self)
	Creates a ExternalModelDefinition object, adds it to the end of the ExternalModelDefinition objects list and returns a pointer to the newly created object. More...

def	createModelDefinition (self)
	Creates a ModelDefinition object, adds it to the end of the ModelDefinition objects list and returns a pointer to the newly created object. More...

def	getElementByMetaId (self, metaid)
	Returns the first child element it can find with the given `metaid`, or itself if it has the given `metaid`, or `None` if no such object is found. More...

def	getElementBySId (self, id)
	Returns the first child element found that has the given `id` in the model-wide SId namespace, or `None` if no such object is found. More...

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

def	getExternalModelDefinition (self, args)
	This method has multiple variants; they differ in the arguments they accept. 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	getListOfExternalModelDefinitions (self, args)
	Returns the ListOf object that holds each ExternalModelDefinition. More...

def	getListOfModelDefinitions (self, args)
	Returns the ListOf object that holds each ModelDefinition. More...

def	getModel (self, args)
	Searches the model namespace of the document and returns the Model, ModelDefinition, or ExternalModelDefintion object with the given identifier. More...

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

def	getNumExternalModelDefinitions (self)
	Returns the number of ExternalModelDefinition objects for this SBMLDocumentPlugin. More...

def	getNumModelDefinitions (self)
	Returns the number of ModelDefinition objects for this SBMLDocumentPlugin. 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	getRequired (self)
	Returns the value of the 'required' attribute. 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	isSetRequired (self)
	Returns the value of the 'required' attribute. More...

def	isValidTypeForList (self, item)

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

def	removeModelDefinition (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	setElementNamespace (self, uri)
	Sets the XML namespace to which this object belongs. More...

def	setRequired (self, value)
	Sets the bool value of 'required' attribute of corresponding package in SBMLDocument element. More...

def	unsetRequired (self)
	Unsets the value of the 'required' attribute of this SBMLDocumentPlugin. More...

Constructor & Destructor Documentation

def libsbml.CompSBMLDocumentPlugin.__init__	(	self,
		args
	)

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

__init__(string uri, string prefix, CompPkgNamespaces compns)   CompSBMLDocumentPlugin
__init__(CompSBMLDocumentPlugin orig)   CompSBMLDocumentPlugin

Each variant is described separately below.

Method variant with the following signature:

CompSBMLDocumentPlugin(string uri, string prefix, CompPkgNamespaces compns)

Creates a new CompSBMLDocumentPlugin 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.
compns	the namespaces object for the package.

Method variant with the following signature:

CompSBMLDocumentPlugin(CompSBMLDocumentPlugin orig)

Copy constructor. Creates a copy of this CompSBMLDocumentPlugin object.

Parameters

orig	the instance to copy.

Member Function Documentation

def libsbml.CompSBMLDocumentPlugin.addExternalModelDefinition	(	self,
		externalModelDefinition
	)

Adds a copy of the given ExternalModelDefinition object to the ListOfExternalModelDefinitions.

addExternalModelDefinition(ExternalModelDefinition externalModelDefinition)   int

Parameters

externalModelDefinition the ExternalModelDefinition object to be added to the ListOFExternalModelDefinitions. Fails if the added ExternalModelDefinition is None, does not match the level/version/package of the parent object, or cannot be added to the list of external model definitions.

Returns

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

def libsbml.CompSBMLDocumentPlugin.addModelDefinition	(	self,
		modelDefinition
	)

Adds a copy of the given ModelDefinition object to the ListOfModelDefinitions.

addModelDefinition(ModelDefinition modelDefinition)   int

Parameters

modelDefinition the ModelDefinition object to be added to the ListOfModelDefinitions. Fails if the added ModelDefinition is None, does not match the level/version/package of the parent object, or cannot be added to the list of replaced elements.

Returns

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

def libsbml.CompSBMLDocumentPlugin.clone ( self )

Creates and returns a deep copy of this CompSBMLDocumentPlugin object.

clone()   CompSBMLDocumentPlugin

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

def libsbml.CompSBMLDocumentPlugin.createExternalModelDefinition ( self )

Creates a ExternalModelDefinition object, adds it to the end of the ExternalModelDefinition objects list and returns a pointer to the newly created object.

createExternalModelDefinition()   ExternalModelDefinition

Returns: a newly created ExternalModelDefinition object.

def libsbml.CompSBMLDocumentPlugin.createModelDefinition ( self )

Creates a ModelDefinition object, adds it to the end of the ModelDefinition objects list and returns a pointer to the newly created object.

createModelDefinition()   ModelDefinition

Returns: a newly created ModelDefinition object.

def libsbml.CompSBMLDocumentPlugin.getElementByMetaId	(	self,
		metaid
	)

Returns the first child element it can find with the given metaid, or itself if it has the given metaid, or None if no such object is found.

getElementByMetaId(string metaid)   SBase

Parameters

metaid string representing the meta identifier of the object to find.

Returns: a pointer to the SBase element with the given metaid.

def libsbml.CompSBMLDocumentPlugin.getElementBySId	(	self,
		id
	)

Returns the first child element found that has the given id in the model-wide SId namespace, or None if no such object is found.

getElementBySId(string id)   SBase

Parameters

id	string representing the identifier of the object to find.

Returns: a pointer to the SBase element with the given id.

Note: The comp SBML document plugin has multiple model-wide SId namespaces, so a valid document may well contain multiple elements with the same SId that reside in separate models. It is not recommended to ever call this function—instead, call the function on the child ModelDefinition objects.

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.CompSBMLDocumentPlugin.getExternalModelDefinition	(	self,
		args
	)

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

getExternalModelDefinition(long  n)   ExternalModelDefinition
getExternalModelDefinition(string sid)   ExternalModelDefinition

Each variant is described separately below.

Method variant with the following signature:

getExternalModelDefinition(long n)

Returns the ExternalModelDefinition with the given index.

Parameters

n	the index number of the ExternalModelDefinition to get.

Returns: the nth ExternalModelDefinition in the ListOfExternalModelDefinitions. If the index is invalid, None is returned.

Method variant with the following signature:

getExternalModelDefinition(string sid)

Returns the model definition object based on its identifier.

Parameters

sid	a string representing the identifier of the model definition to get.

Returns: ExternalModelDefinition in the ListOfExternalModelDefinitions with the given sid or None if no such ExternalModelDefinition exists.

See also: getExternalModelDefinition(); getListOfExternalModelDefinitions()

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.CompSBMLDocumentPlugin.getListOfExternalModelDefinitions	(	self,
		args
	)

Returns the ListOf object that holds each ExternalModelDefinition.

getListOfExternalModelDefinitions()   ListOfExternalModelDefinitions

Returns: the ListOf object that each all ExternalModelDefinition.

def libsbml.CompSBMLDocumentPlugin.getListOfModelDefinitions	(	self,
		args
	)

Returns the ListOf object that holds each ModelDefinition.

getListOfModelDefinitions()   ListOfModelDefinitions

Returns: the ListOf object that holds each ModelDefinition.

def libsbml.CompSBMLDocumentPlugin.getModel	(	self,
		args
	)

Searches the model namespace of the document and returns the Model, ModelDefinition, or ExternalModelDefintion object with the given identifier.

getModel(string sid)   SBase

Parameters

sid	a string representing the identifier of the model definition to get.

Returns: The SBase corresponding to the given sid or None if no such model exists. If no such model exists, this will return None.

def libsbml.CompSBMLDocumentPlugin.getModelDefinition	(	self,
		args
	)

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

getModelDefinition(long  n)   ModelDefinition
getModelDefinition(string sid)   ModelDefinition

Each variant is described separately below.

Method variant with the following signature:

getModelDefinition(long n)

Returns the ModelDefinition with the given index.

Parameters

n	the index number of the ModelDefinition to get.

Returns: the nth ModelDefinition in the ListOfModelDefinitions. If the index n is invalid, None is returned.

Method variant with the following signature:

getModelDefinition(string sid)

Returns the model definition object based on its identifier.

Parameters

sid	a string representing the identifier of the model definition to get.

Returns: ModelDefinition in the ListOfModelDefinitions with the given sid or None if no such ModelDefinition exists.

See also: getModelDefinition(); getListOfModelDefinitions()

def libsbml.CompSBMLDocumentPlugin.getNumExternalModelDefinitions ( self )

Returns the number of ExternalModelDefinition objects for this SBMLDocumentPlugin.

getNumExternalModelDefinitions()   long

Returns: the number of ExternalModelDefinition objects for this SBMLDocumentPlugin.

def libsbml.CompSBMLDocumentPlugin.getNumModelDefinitions ( self )

Returns the number of ModelDefinition objects for this SBMLDocumentPlugin.

getNumModelDefinitions()   long

Returns: the number of ModelDefinition 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.SBMLDocumentPlugin.getRequired ( self )

inherited

Returns the value of the 'required' attribute.

getRequired()   bool

: SBML Level 3 requires that every package defines an attribute named 'required' on the root <sbml> element in an SBML file or data stream. The attribute, being in the namespace of the Level 3 package in question, must be prefixed by the XML namespace prefix associated with the package. The value of the 'required' attribute indicates whether constructs in that package may change the mathematical interpretation of constructs defined in SBML Level 3 Core. A 'required' value of True indicates that the package may do so. The value of the attribute is set by the Level 3 package specification, and does not depend on the actual presence or absence of particular package constructs in a given SBML document: in other words, if the package specification defines any construct that can change the model's meaning, the value of the 'required' attribute must always be set to True in any SBML document that uses the package.

The XML namespace declaration for an SBML Level 3 package is an indication that a model makes use of features defined by that package, while the 'required' attribute indicates whether the features may be ignored without compromising the mathematical meaning of the model. Both are necessary for a complete reference to an SBML Level 3 package.

Returns: the bool value of 'required' attribute for the SBML package.

See also: setRequired(); isSetRequired(); unsetRequired()

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.SBMLDocumentPlugin.isSetRequired ( self )

inherited

Returns the value of the 'required' attribute.

isSetRequired()   bool

: SBML Level 3 requires that every package defines an attribute named 'required' on the root <sbml> element in an SBML file or data stream. The attribute, being in the namespace of the Level 3 package in question, must be prefixed by the XML namespace prefix associated with the package. The value of the 'required' attribute indicates whether constructs in that package may change the mathematical interpretation of constructs defined in SBML Level 3 Core. A 'required' value of True indicates that the package may do so. The value of the attribute is set by the Level 3 package specification, and does not depend on the actual presence or absence of particular package constructs in a given SBML document: in other words, if the package specification defines any construct that can change the model's meaning, the value of the 'required' attribute must always be set to True in any SBML document that uses the package.

The XML namespace declaration for an SBML Level 3 package is an indication that a model makes use of features defined by that package, while the 'required' attribute indicates whether the features may be ignored without compromising the mathematical meaning of the model. Both are necessary for a complete reference to an SBML Level 3 package.

Returns: True if the 'required' attribute of this SBMLDocument has been set to True, False otherwise.

def libsbml.SBasePlugin.isValidTypeForList	(	self,
		item
	)

inherited

isValidTypeForList(SBase item)   bool

def libsbml.CompSBMLDocumentPlugin.removeExternalModelDefinition	(	self,
		args
	)

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

removeExternalModelDefinition(long  index)   ExternalModelDefinition
removeExternalModelDefinition(string id)   ExternalModelDefinition

Each variant is described separately below.

Method variant with the following signature:

removeExternalModelDefinition(string id)

Removes the ExternalModelDefinition with the given id.

A pointer to the ExternalModelDefinition that was removed is returned. If no ExternalModelDefinition has been removed, None is returned.

Parameters

id	the id of the ExternalModelDefinition object to remove.

Returns: the ExternalModelDefinition object removed. As mentioned above, the caller owns the returned object. None is returned if the given index is out of range.

Method variant with the following signature:

removeExternalModelDefinition(long index)

Removes the ExternalModelDefinition with the given index.

A pointer to the ExternalModelDefinition that was removed is returned. If no ExternalModelDefinition has been removed, None is returned.

Parameters

index the index of the ExternalModelDefinition object to remove.

Returns: the ExternalModelDefinition object removed. As mentioned above, the caller owns the returned object. None is returned if the given index is out of range.

def libsbml.CompSBMLDocumentPlugin.removeModelDefinition	(	self,
		args
	)

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

removeModelDefinition(long  index)   ModelDefinition
removeModelDefinition(string id)   ModelDefinition

Each variant is described separately below.

Method variant with the following signature:

removeModelDefinition(string id)

Removes the ModelDefinition with the given id from the CompSBMLDocumentPlugin.

A pointer to the ModelDefinition that was removed is returned. If no ModelDefinition has been removed, None is returned.

Parameters

id	the id of the ModelDefinition object to remove.

Returns: the ModelDefinition object removed. As mentioned above, the caller owns the returned object. None is returned if the given index is out of range.

Method variant with the following signature:

removeModelDefinition(long index)

Removes the ModelDefinition with the given index from the CompSBMLDocumentPlugin.

A pointer to the ModelDefinition that was removed is returned. If no ModelDefinition has been removed, None is returned.

Parameters

index the index of the ModelDefinition object to remove.

Returns: the ModelDefinition object removed. As mentioned above, the caller owns the returned object. None is returned if the given index is out of range.

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.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.CompSBMLDocumentPlugin.setRequired	(	self,
		value
	)

Sets the bool value of 'required' attribute of corresponding package in SBMLDocument element.

setRequired(bool value)   int

The only legal value is 'true' for the Hierarchical Model Composition package.

Parameters

value the bool value of 'required' attribute of corresponding package in SBMLDocument element.

Returns

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

def libsbml.SBMLDocumentPlugin.unsetRequired ( self )

inherited

Unsets the value of the 'required' attribute of this SBMLDocumentPlugin.

unsetRequired()   int

Returns

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

LIBSBML_OPERATION_SUCCESS

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation