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

Detailed Description

{layout}

layout The core module of the 'layout' package extension.

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 getXmlnsXSI
 
def isInUse
 
def removeL2Namespaces
 

Member Function Documentation

def libsbml.LayoutExtension.addL2Namespaces (   self,
  args 
)

Python method signature(s):

addL2Namespaces(LayoutExtension 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.LayoutExtension.clone (   self)

Python method signature(s):

clone(LayoutExtension self)   LayoutExtension

Creates and returns a deep copy of this LayoutExtension object.

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

Python method signature(s):

enableL2NamespaceForDocument(LayoutExtension 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.LayoutExtension.getDefaultLevel ( )

Python method signature(s):

getDefaultLevel()   long

Returns the default SBML Level this extension.

def libsbml.LayoutExtension.getDefaultPackageVersion ( )

Python method signature(s):

getDefaultPackageVersion()   long

Returns the default SBML version this extension.

def libsbml.LayoutExtension.getDefaultVersion ( )

Python method signature(s):

getDefaultVersion()   long

Returns the default SBML Version this extension.

def libsbml.LayoutExtension.getLevel (   self,
  args 
)

Python method signature(s):

getLevel(LayoutExtension self, string uri)   long

Returns the SBML Level for the given URI of this package.

Parameters
urithe string of URI that represents one of versions of the “layout” package
Returns
the SBML Level with the given URI of this package, or 0 if the given URI is invalid.
def libsbml.LayoutExtension.getName (   self)

Python method signature(s):

getName(LayoutExtension self)   string

Returns the name of this package ('layout')

Returns
the name of this package ('layout')
def libsbml.LayoutExtension.getPackageName ( )

{layout}

layout The core module of the 'layout' package extension. Python method signature(s):

getPackageName()   string

Returns the package name of this extension.

def libsbml.LayoutExtension.getPackageVersion (   self,
  args 
)

Python method signature(s):

getPackageVersion(LayoutExtension self, string uri)   long

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

Parameters
urithe string of URI that represents one of versions of the “layout” package
Returns
the package version with the given URI of this package, or 0 if the given URI is invalid.
def libsbml.LayoutExtension.getSBMLExtensionNamespaces (   self,
  args 
)

Python method signature(s):

getSBMLExtensionNamespaces(LayoutExtension self, string uri)   SBMLNamespaces

Returns an LayoutPkgNamespaces object.

Parameters
urithe string of URI that represents one of versions of the “layout” package
Returns
an LayoutPkgNamespace object corresponding to the given uri, or None if the URI is not defined in the Layout package.
def libsbml.LayoutExtension.getStringFromTypeCode (   self,
  args 
)

Python method signature(s):

getStringFromTypeCode(LayoutExtension self, int typeCode)   string *

Takes a type code of the “layout” package and returns a string describing the code.

def libsbml.LayoutExtension.getURI (   self,
  args 
)

Python method signature(s):

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

Returns the namespace URI corresponding to the combination of the given SBML Level, Version, and package version.

Parameters
sbmlLevelthe level of SBML
sbmlVersionthe version of SBML
pkgVersionthe version of package
Returns
a string of the package URI, or an empty string if no corresponding URI exists.
def libsbml.LayoutExtension.getVersion (   self,
  args 
)

Python method signature(s):

getVersion(LayoutExtension self, string uri)   long

Returns the SBML Version for the given URI of this package.

Parameters
urithe string of URI that represents one of versions of the “layout” package
Returns
the SBML version with the given URI of this package, or 0 if the given URI is invalid.
def libsbml.LayoutExtension.getXmlnsL2 ( )

Python method signature(s):

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

Python method signature(s):

getXmlnsL3V1V1()   string

Returns URI of supported versions of this package.

def libsbml.LayoutExtension.getXmlnsXSI ( )

Python method signature(s):

getXmlnsXSI()   string
 
def libsbml.LayoutExtension.isInUse (   self,
  args 
)

Python method signature(s):

isInUse(LayoutExtension self, SBMLDocument doc)   bool

Determines whether this extension is being used by the given SBMLDocument

The implementation returns true if the model object contains one or more layouts.

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

Python method signature(s):

removeL2Namespaces(LayoutExtension 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.