libSBML Python API
5.11.0
|
Proxy of C++ RenderGraphicalObjectPlugin class.
Public Member Functions | |
def | __init__ (self, args) |
Proxy of C++ RenderGraphicalObjectPlugin class. More... | |
def | clone (self) |
Creates and returns a deep copy of this RenderGraphicalObjectPlugin object. More... | |
def | getElementByMetaId (self, metaid) |
Return the first child object found with a given meta identifier. More... | |
def | getElementBySId (self, id) |
Return the first child object found with a given identifier. More... | |
def | getElementNamespace (self) |
Base class for extending SBML objects in packages. More... | |
def | getLevel (self) |
Returns the SBML Level of the package extension of this plugin object. More... | |
def | getListOfAllElements |
Returns an SBaseList of all child SBase objects, including those nested to an arbitrary depth. More... | |
def | getObjectRole (self) |
Returns the object role string for the object. 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 | 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 | isSetObjectRole (self) |
Returns whether the object role has been set or not. More... | |
def | setElementNamespace (self, uri) |
Sets the XML namespace to which this object belongs. More... | |
def | setObjectRole (self, role) |
Sets the object role string for the object. More... | |
def libsbml.RenderGraphicalObjectPlugin.__init__ | ( | self, | |
args | |||
) |
Proxy of C++ RenderGraphicalObjectPlugin class.
This method has multiple variants; they differ in the arguments they accept.
__init__(string uri, string prefix, RenderPkgNamespaces groupsns) RenderGraphicalObjectPlugin __init__(RenderGraphicalObjectPlugin orig) RenderGraphicalObjectPlugin
Each variant is described separately below.
RenderGraphicalObjectPlugin(stringuri, stringprefix, RenderPkgNamespaces groupsns)
Constructor
RenderGraphicalObjectPlugin(RenderGraphicalObjectPlugin & orig)
Copy constructor. Creates a copy of this SBase object.
def libsbml.RenderGraphicalObjectPlugin.clone | ( | self | ) |
Creates and returns a deep copy of this RenderGraphicalObjectPlugin object.
clone() RenderGraphicalObjectPlugin
|
inherited |
Return the first child object found with a given meta identifier.
getElementByMetaId(string metaid) SBase
This method searches all the subobjects under this one, compares their meta identifiers to metaid
, and returns the first one that machines.
metaid | string, the metaid of the object to find. |
metaid
.
|
inherited |
Return the first child object found with a given identifier.
getElementBySId(string id) SBase
This method searches all the subobjects under this one, compares their identifiers to id
, and returns the first one that machines.
Normally, SId
type identifier values are unique across a model in SBML. However, in some circumstances they may not be, such as if a model is invalid because of multiple objects having the same identifier.
id | string representing the identifier of the object to find |
id
.
|
inherited |
Returns the SBML Level of the package extension of this plugin object.
getLevel() long
|
inherited |
Returns an SBaseList of all child SBase objects, including those nested to an arbitrary depth.
getListOfAllElements(ElementFilter filter=None) SBaseList getListOfAllElements() SBaseList
def libsbml.RenderGraphicalObjectPlugin.getObjectRole | ( | self | ) |
Returns the object role string for the object.
getObjectRole() string
|
inherited |
Returns the short-form name of the package to which this plugin object belongs.
getPackageName() string
|
inherited |
Returns the package version of the package extension of this plugin object.
getPackageVersion() long
|
inherited |
Returns the parent object to which this plugin object is connected.
getParentSBMLObject() SBase
|
inherited |
Returns the XML namespace prefix of the package to which this plugin object belongs.
getPrefix() string
|
inherited |
Returns the SBMLDocument object containing this object instance.
getSBMLDocument() SBMLDocument
This method allows the caller to obtain the SBMLDocument for the current object.
|
inherited |
Returns the XML namespace URI for the package to which this object belongs.
getURI() string
'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().
|
inherited |
Returns the Version within the SBML Level of the package extension of this plugin object.
getVersion() long
def libsbml.RenderGraphicalObjectPlugin.isSetObjectRole | ( | self | ) |
Returns whether the object role has been set or not.
isSetObjectRole() bool
|
inherited |
Sets the XML namespace to which this object belongs.
setElementNamespace(string uri) int
'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/'
.uri | the URI to assign to this object. |
def libsbml.RenderGraphicalObjectPlugin.setObjectRole | ( | self, | |
role | |||
) |
Sets the object role string for the object.
setObjectRole(string role)