libSBML Python API  5.10.0
 All Classes Namespaces Files Functions Variables Modules Pages
libsbml.RenderExtension Class Reference
Inheritance diagram for libsbml.RenderExtension:
[legend]

Detailed Description

Proxy of C++ RenderExtension class.

Public Member Functions

def addL2Namespaces
 
def clone
 
def enableL2NamespaceForDocument
 
def getDefaultLevel
 
def getDefaultPackageVersion
 
def getDefaultVersion
 
def getLevel
 
def getName
 
def getPackageName
 
def getPackageVersion
 
def getSBMLExtensionNamespaces
 
def getStringFromTypeCode
 
def getURI
 
def getVersion
 
def getXmlnsL2
 
def getXmlnsL3V1V1
 
def isInUse
 
def removeL2Namespaces
 

Member Function Documentation

def libsbml.RenderExtension.addL2Namespaces (   self,
  args 
)

Python method signature(s):

addL2Namespaces(RenderExtension self, XMLNamespaces xmlns)

adds all L2 Extension namespaces to the namespace list.

This method should be overridden by all extensions that want to serialize to an L2 annotation.

def libsbml.RenderExtension.clone (   self)

Python method signature(s):

clone(RenderExtension self)   RenderExtension

Creates and returns a deep copy of this RenderExtension object.

Returns
a (deep) copy of this RenderExtension object
def libsbml.RenderExtension.enableL2NamespaceForDocument (   self,
  args 
)

Python method signature(s):

enableL2NamespaceForDocument(RenderExtension self, SBMLDocument doc)

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

If the extension supports serialization to SBML L2 Annotations, this method should be overrridden, so it will be activated.

def libsbml.RenderExtension.getDefaultLevel ( )

Python method signature(s):

getDefaultLevel()   long

Returns the default SBML Level this extension.

def libsbml.RenderExtension.getDefaultPackageVersion ( )

Python method signature(s):

getDefaultPackageVersion()   long

Returns the default SBML version this extension.

def libsbml.RenderExtension.getDefaultVersion ( )

Python method signature(s):

getDefaultVersion()   long

Returns the default SBML Version this extension.

def libsbml.RenderExtension.getLevel (   self,
  args 
)

Python method signature(s):

getLevel(RenderExtension self, string uri)   long

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

Parameters
urithe string of URI that represents one of versions of layout 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)

Python method signature(s):

getName(RenderExtension self)   string

Returns the name of this package ('fbc')

the name of this package ('fbc')

def libsbml.RenderExtension.getPackageName ( )

Proxy of C++ RenderExtension class.

Python method signature(s):

getPackageName()   string

Returns the package name of this extension.

def libsbml.RenderExtension.getPackageVersion (   self,
  args 
)

Python method signature(s):

getPackageVersion(RenderExtension self, string uri)   long

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

Parameters
urithe string of URI that represents one of versions of layout 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,
  args 
)

Python method signature(s):

getSBMLExtensionNamespaces(RenderExtension self, string uri)   SBMLNamespaces

Returns an SBMLExtensionNamespaces<GroupsExtension> object whose alias type is LayoutPkgNamespace. Null will be returned if the given uri is not defined in the layout package.

Parameters
urithe string of URI that represents one of versions of layout package
Returns
an LayoutPkgNamespace object corresponding to the given uri. None will be returned if the given URI is not defined in layout package.
def libsbml.RenderExtension.getStringFromTypeCode (   self,
  args 
)

Python method signature(s):

getStringFromTypeCode(RenderExtension self, int typeCode)   string *

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

def libsbml.RenderExtension.getURI (   self,
  args 
)

Python method signature(s):

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

Returns the URI (namespace) of the package corresponding to the combination of the given sbml level, sbml version, and package version. Empty string will be returned if no corresponding URI exists.

Parameters
sbmlLevelthe level of SBML
sbmlVersionthe version of SBML
pkgVersionthe version of package
Returns
a string of the package URI
def libsbml.RenderExtension.getVersion (   self,
  args 
)

Python method signature(s):

getVersion(RenderExtension self, string uri)   long

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

Parameters
urithe string of URI that represents one of versions of layout 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 ( )

Python method signature(s):

getXmlnsL2()   string
 
def libsbml.RenderExtension.getXmlnsL3V1V1 ( )

Python method signature(s):

getXmlnsL3V1V1()   string

Returns URI of supported versions of this package.

def libsbml.RenderExtension.isInUse (   self,
  args 
)

Python method signature(s):

isInUse(RenderExtension self, SBMLDocument doc)   bool

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.

Parameters
docthe sbml document to test.
Returns
a boolean indicating whether the extension is actually being used byy the document.
def libsbml.RenderExtension.removeL2Namespaces (   self,
  args 
)

Python method signature(s):

removeL2Namespaces(RenderExtension self, XMLNamespaces xmlns)

Removes the L2 Namespace from a document.

This method should be overridden by all extensions that want to serialize to an L2 annotation.