libsbml.MultiASTPlugin Class Reference

Inheritance diagram for libsbml.MultiASTPlugin:

Detailed Description

multi Extension of ASTBasePlugin.

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 MultiASTPlugin object is used to extend the standard SBML AST (abstract syntax tree) base object (ASTBase) to allow a 'ci' element (AST_NAME) to have an optional 'speciesReference' attribute. This attribute is used to distinguish which version of a Species should be used in the mathematics. If a 'template' type Species appears as both a reactant and a product in the same Reaction, for example, it may have one amount as a reactant and a different amount as a product, since the same template is being used to match slightly different pools of elements in each case. By defining the 'speciesReference' attribute on an AST_NAME that references that Species, the modeler may determine which amount is being referenced. Similarly, an AST_NAME node may reference a SpeciesFeature that appears in multiple Species in the Reaction, and this attribute can be used to specify which one should be used.

Public Member Functions
def	__init__ (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...
def	clone (self)
	Creates and returns a deep copy of this MultiASTPlugin object. More...
def	getRepresentationType (self)
	Returns the value of the 'representationType' attribute of this MultiASTPlugin. More...
def	getSpeciesReference (self)
	Returns the value of the 'speciesReference' attribute of this MultiASTPlugin. More...
def	isSetRepresentationType (self)
	Predicate returning True if this MultiASTPlugin's 'representationType' attribute is set. More...
def	isSetSpeciesReference (self)
	Predicate returning True if this MultiASTPlugin's 'speciesReference' attribute is set. More...
def	renameSIdRefs (self, oldid, newid)
	Renames the speciesReference SIdRef attribute on this node. More...
def	setRepresentationType (self, representationType)
	Sets the value of the 'representationType' attribute of this MultiASTPlugin. More...
def	setSpeciesReference (self, speciesReference)
	Sets the value of the 'speciesReference' attribute of this MultiASTPlugin. More...
def	unsetRepresentationType (self)
	Unsets the value of the 'representationType' attribute of this MultiASTPlugin. More...
def	unsetSpeciesReference (self)
	Unsets the value of the 'speciesReference' attribute of this MultiASTPlugin. More...

Constructor & Destructor Documentation

def libsbml.MultiASTPlugin.__init__	(		self,
			args
	)

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

__init__(string uri)   MultiASTPlugin
__init__(MultiASTPlugin orig)   MultiASTPlugin

Each variant is described separately below.

---

Method variant with the following signature:

MultiASTPlugin(string uri)

Creates a new MultiASTPlugin 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/'.

Parameters

uri	the URI of the SBML Level 3 package implemented by this libSBML package extension.

---

Method variant with the following signature:

MultiASTPlugin(MultiASTPlugin orig)

Copy constructor.

Parameters

orig	the MultiASTPlugin instance to copy.

Member Function Documentation

def libsbml.MultiASTPlugin.clone

(

self

)

Creates and returns a deep copy of this MultiASTPlugin object.

clone()   MultiASTPlugin

Returns

a (deep) copy of this SBase object

def libsbml.MultiASTPlugin.getRepresentationType

(

self

)

Returns the value of the 'representationType' attribute of this MultiASTPlugin.

getRepresentationType()   string

Returns

the value of the 'representationType' attribute of this MultiASTPlugin as a string.

def libsbml.MultiASTPlugin.getSpeciesReference

(

self

)

Returns the value of the 'speciesReference' attribute of this MultiASTPlugin.

getSpeciesReference()   string

Returns

the value of the 'speciesReference' attribute of this MultiASTPlugin as a string.

def libsbml.MultiASTPlugin.isSetRepresentationType

(

self

)

Predicate returning True if this MultiASTPlugin's 'representationType' attribute is set.

isSetRepresentationType()   bool

Returns

True if this MultiASTPlugin's 'representationType' attribute has been set, otherwise False is returned.

def libsbml.MultiASTPlugin.isSetSpeciesReference

(

self

)

Predicate returning True if this MultiASTPlugin's 'speciesReference' attribute is set.

isSetSpeciesReference()   bool

Returns

True if this MultiASTPlugin's 'speciesReference' attribute has been set, otherwise False is returned.

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

Renames the speciesReference SIdRef attribute on this node.

renameSIdRefs(string oldid, string newid)

Parameters

oldid	the old identifier.
newid	the new identifier.

def libsbml.MultiASTPlugin.setRepresentationType	(		self,
			representationType
	)

Sets the value of the 'representationType' attribute of this MultiASTPlugin.

setRepresentationType(string representationType)   int

Parameters

representationType

string value of the 'representationType' attribute to be set.

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

Calling this function with representationType = None or an empty string is equivalent to calling unsetRepresentationType().

def libsbml.MultiASTPlugin.setSpeciesReference	(		self,
			speciesReference
	)

Sets the value of the 'speciesReference' attribute of this MultiASTPlugin.

setSpeciesReference(string speciesReference)   int

Parameters

speciesReference

string value of the 'speciesReference' attribute to be set.

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

Calling this function with speciesReference = None or an empty string is equivalent to calling unsetSpeciesReference().

def libsbml.MultiASTPlugin.unsetRepresentationType

(

self

)

Unsets the value of the 'representationType' attribute of this MultiASTPlugin.

unsetRepresentationType()   int

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

def libsbml.MultiASTPlugin.unsetSpeciesReference

(

self

)

Unsets the value of the 'speciesReference' attribute of this MultiASTPlugin.

unsetSpeciesReference()   int

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