libsbml.RenderExtension Class Reference

Inheritance diagram for libsbml.RenderExtension:

Detailed Description

render Base extension class for the package.

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.

Public Member Functions
def	__init__ (self, args)
	This method has multiple variants; they differ in the arguments they accept. More...
def	addL2Namespaces (self, xmlns)
	adds all L2 Extension namespaces to the namespace list. More...
def	clone (self)
	Creates and returns a deep copy of this RenderExtension object. More...
def	enableL2NamespaceForDocument (self, doc)
	Adds the L2 Namespace to the document and enables the extension. More...
def	getDefaultLevel ()
	Returns the default SBML Level this extension. More...
def	getDefaultPackageVersion ()
	Returns the default SBML version this extension. More...
def	getDefaultVersion ()
	Returns the default SBML Version this extension. More...
def	getLevel (self, uri)
	Returns the SBML level with the given URI of this package. More...
def	getName (self)
def	getNumOfSBasePlugins (self)
	Returns the number of SBasePluginCreatorBase objects stored in this object. More...
def	getNumOfSupportedPackageURI (self)
	Returns the number of supported package namespace URIs. More...
def	getPackageName ()
	Returns the package name of this extension. More...
def	getPackageVersion (self, uri)
	Returns the package version with the given URI of this package. More...
def	getSBMLExtensionNamespaces (self, uri)
	Returns a RenderPkgNamespaces object. More...
def	getStringFromTypeCode (self, typeCode)
	This method takes a type code of groups package and returns a string representing the code. More...
def	getSupportedPackageURI (self, n)
	Returns the nth XML namespace URI. More...
def	getURI (self, sbmlLevel, sbmlVersion, pkgVersion)
	Returns the URI (namespace) of the package corresponding to the combination of the given sbml level, sbml version, and package version. More...
def	getVersion (self, uri)
	Returns the SBML version with the given URI of this package. More...
def	getXmlnsL2 ()
	Returns URI of L2 version of supported versions of this package. More...
def	getXmlnsL3V1V1 ()
	Returns URI of supported versions of this package. More...
def	isEnabled (self)
	Returns True if this package is enabled. More...
def	isInUse (self, doc)
	Determines whether this extension is being used by the given SBMLDocument. More...
def	isSupported (self, uri)
	Returns True if the given XML namespace URI is supported by this package extension. More...
def	removeL2Namespaces (self, xmlns)
	Removes the L2 Namespace from a document. More...
def	setEnabled (self, isEnabled)
	Enable or disable this package. More...

Constructor & Destructor Documentation

def libsbml.RenderExtension.__init__	(		self,
			args
	)

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

__init__()   RenderExtension
__init__(RenderExtension arg2)   RenderExtension

Each variant is described separately below.

---

Method variant with the following signature:

RenderExtension(RenderExtension)

Copy constructor.

---

Method variant with the following signature:

RenderExtension()

Constructor

Member Function Documentation

def libsbml.RenderExtension.addL2Namespaces	(		self,
			xmlns
	)

adds all L2 Extension namespaces to the namespace list.

addL2Namespaces(XMLNamespaces xmlns)

This method is overridden here since Render does serialize to an L2 annotation.

def libsbml.RenderExtension.clone

(

self

)

Creates and returns a deep copy of this RenderExtension object.

clone()   RenderExtension

Returns

a (deep) copy of this RenderExtension object

def libsbml.RenderExtension.enableL2NamespaceForDocument	(		self,
			doc
	)

Adds the L2 Namespace to the document and enables the extension.

enableL2NamespaceForDocument(SBMLDocument doc)

This method is overridden here since Render does serialize to an L2 annotation.

def libsbml.RenderExtension.getDefaultLevel

(

)

Returns the default SBML Level this extension.

getDefaultLevel()   long

def libsbml.RenderExtension.getDefaultPackageVersion

(

)

Returns the default SBML version this extension.

getDefaultPackageVersion()   long

def libsbml.RenderExtension.getDefaultVersion

(

)

Returns the default SBML Version this extension.

getDefaultVersion()   long

def libsbml.RenderExtension.getLevel	(		self,
			uri
	)

Returns the SBML level with the given URI of this package.

getLevel(string uri)   long

Parameters

uri	the string of URI that represents one of the versions of the render package

Returns

the SBML level with the given URI of this package. 0 will be returned if the given URI is invalid.

def libsbml.RenderExtension.getName

(

self

)

getName()   string

Returns the name of this package ('render')

def libsbml.SBMLExtension.getNumOfSBasePlugins (   self )

inherited

Returns the number of SBasePluginCreatorBase objects stored in this object.

getNumOfSBasePlugins()   int

Returns

the total number of SBasePluginCreatorBase objects stored in this SBMLExtension-derived object.

def libsbml.SBMLExtension.getNumOfSupportedPackageURI (   self )

inherited

Returns the number of supported package namespace URIs.

getNumOfSupportedPackageURI()   long

Returns

the number of supported package XML namespace URIs of this package extension.

def libsbml.RenderExtension.getPackageName

(

)

Returns the package name of this extension.

getPackageName()   string

def libsbml.RenderExtension.getPackageVersion	(		self,
			uri
	)

Returns the package version with the given URI of this package.

getPackageVersion(string uri)   long

Parameters

uri	the string of URI that represents one of the versions of the render package

Returns

the package version with the given URI of this package. 0 will be returned if the given URI is invalid.

def libsbml.RenderExtension.getSBMLExtensionNamespaces	(		self,
			uri
	)

Returns a RenderPkgNamespaces object.

getSBMLExtensionNamespaces(string uri)   SBMLNamespaces

None will be returned if the given uri is not defined in the render package.

Parameters

uri	the string of URI that represents one of the versions of the render package

Returns

a RenderPkgNamespaces object corresponding to the given uri. None will be returned if the given URI is not defined in render package.

def libsbml.RenderExtension.getStringFromTypeCode	(		self,
			typeCode
	)

This method takes a type code of groups package and returns a string representing the code.

getStringFromTypeCode(int typeCode)   string  *

def libsbml.SBMLExtension.getSupportedPackageURI (   self,   n  )

inherited

Returns the nth XML namespace URI.

getSupportedPackageURI(long  n)   string

Parameters

n	the index number of the namespace URI being sought.

Returns

a string representing the XML namespace URI understood to be supported by this package. An empty string will be returned if there is no nth URI.

def libsbml.RenderExtension.getURI	(		self,
			sbmlLevel,
			sbmlVersion,
			pkgVersion
	)

Returns the URI (namespace) of the package corresponding to the combination of the given sbml level, sbml version, and package version.

getURI(long  sbmlLevel, long  sbmlVersion, long  pkgVersion)   string

Empty string will be returned if no corresponding URI exists.

Parameters

sbmlLevel	the level of SBML
sbmlVersion	the version of SBML
pkgVersion	the version of package

Returns

a string of the package URI

def libsbml.RenderExtension.getVersion	(		self,
			uri
	)

Returns the SBML version with the given URI of this package.

getVersion(string uri)   long

Parameters

uri	the string of URI that represents one of the versions of the render package

Returns

the SBML version with the given URI of this package. 0 will be returned if the given URI is invalid.

def libsbml.RenderExtension.getXmlnsL2

(

)

Returns URI of L2 version of supported versions of this package.

getXmlnsL2()   string

def libsbml.RenderExtension.getXmlnsL3V1V1

(

)

Returns URI of supported versions of this package.

getXmlnsL3V1V1()   string

def libsbml.SBMLExtension.isEnabled (   self )

inherited

Returns True if this package is enabled.

isEnabled()   bool

Returns

True if this package is enabled, False otherwise.

def libsbml.RenderExtension.isInUse	(		self,
			doc
	)

Determines whether this extension is being used by the given SBMLDocument.

The implementation returns True if the list of layouts contains a global render information, or a layout object contains a local render information object.

isInUse(SBMLDocument doc)   bool

Parameters

doc	the sbml document to test.

Returns

a boolean indicating whether the extension is actually being used byy the document.

def libsbml.SBMLExtension.isSupported (   self,   uri  )

inherited

Returns True if the given XML namespace URI is supported by this package extension.

isSupported(string uri)   bool

Returns

True if the given XML namespace URI (equivalent to a package version) is supported by this package extension, False otherwise.

def libsbml.RenderExtension.removeL2Namespaces	(		self,
			xmlns
	)

Removes the L2 Namespace from a document.

removeL2Namespaces(XMLNamespaces xmlns)

This method is overridden here since Render does serialize to an L2 annotation.

def libsbml.SBMLExtension.setEnabled (   self,   isEnabled  )

inherited

Enable or disable this package.

setEnabled(bool isEnabled)   bool

Parameters

isEnabled

flag indicating whether to enable (if True) or disable (False) this package extension.

Returns

True if this call succeeded; False otherwise.