libSBML Python API
5.10.0
|
{core}
SBML converter for replacing function definitions.This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. It is a class used in the implementation of extra functionality provided by libSBML.
This is an SBML converter for manipulating user-defined functions in an SBML file. When invoked on the current model, it performs the following operation:
For example, suppose the model contains a function definition representing the function f(x, y) = x * y. Further suppose this functions invoked somewhere else in the model, in a mathematical formula, as f(s, p). The outcome of running SBMLFunctionDefinitionConverter on the model will be to replace the call to f with the expression s * p.
Public Member Functions | |
def | clone |
def | convert |
def | getDefaultProperties |
def | getDocument |
def | getProperties |
def | getTargetNamespaces |
def | init |
def | matchesProperties |
def | setDocument |
def | setProperties |
def libsbml.SBMLFunctionDefinitionConverter.clone | ( | self | ) |
Python method signature(s):
clone(SBMLFunctionDefinitionConverter self)SBMLConverter
Creates and returns a deep copy of this SBMLFunctionDefinitionConverter object.
def libsbml.SBMLFunctionDefinitionConverter.convert | ( | self | ) |
Python method signature(s):
convert(SBMLFunctionDefinitionConverter self)int
Replaces invocations of each user-defined function with an in-line copy, similar to macro expansion.
def libsbml.SBMLFunctionDefinitionConverter.getDefaultProperties | ( | self | ) |
Python method signature(s):
getDefaultProperties(SBMLFunctionDefinitionConverter self)ConversionProperties
Returns the default properties of this converter.
A given converter exposes one or more properties that can be adjusted in order to influence the behavior of the converter. This method returns the default property settings for this converter. It is meant to be called in order to discover all the settings for the converter object.
|
inherited |
Python method signature(s):
getDocument(SBMLConverter self)SBMLDocument getDocument(SBMLConverter self)
SBMLDocument
Returns the SBML document that is the subject of the conversions.
|
inherited |
Python method signature(s):
getProperties(SBMLConverter self)ConversionProperties
Returns the current properties in effect for this converter.
A given converter exposes one or more properties that can be adjusted in order to influence the behavior of the converter. This method returns the current properties for this converter; in other words, the settings in effect at this moment. To change the property values, you can use SBMLConverter.setProperties().
|
inherited |
Python method signature(s):
getTargetNamespaces(SBMLConverter self)SBMLNamespaces
Returns the target SBML namespaces of the currently set properties.
SBML namespaces are used by libSBML to express the Level+Version of the SBML document (and, possibly, any SBML Level 3 packages in use). Some converters' behavior is affected by the SBML namespace configured in the converter. For example, the actions of SBMLLevelVersionConverter, the converter for converting SBML documents from one Level+Version combination to another, are fundamentally dependent on the SBML namespaces being targeted.
def libsbml.SBMLFunctionDefinitionConverter.init | ( | ) |
{core}
SBML converter for replacing function definitions.This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. It is a class used in the implementation of extra functionality provided by libSBML.
This is an SBML converter for manipulating user-defined functions in an SBML file. When invoked on the current model, it performs the following operation:
For example, suppose the model contains a function definition representing the function f(x, y) = x * y. Further suppose this functions invoked somewhere else in the model, in a mathematical formula, as f(s, p). The outcome of running SBMLFunctionDefinitionConverter on the model will be to replace the call to f with the expression s * p.
init()
def libsbml.SBMLFunctionDefinitionConverter.matchesProperties | ( | self, | |
args | |||
) |
Python method signature(s):
matchesProperties(SBMLFunctionDefinitionConverter self, ConversionProperties props)bool
Returns True
if this converter object's properties match the given properties.
A typical use of this method involves creating a ConversionProperties object, setting the options desired, and then calling this method on an SBMLFunctionDefinitionConverter object to find out if the object's property values match the given ones. This method is also used by SBMLConverterRegistry.getConverterFor() to search across all registered converters for one matching particular properties.
props | the properties to match. |
True
if this converter's properties match, False
otherwise.
|
inherited |
Python method signature(s):
setDocument(SBMLConverter self, SBMLDocument doc)int setDocument(SBMLConverter self, SBMLDocument doc)
int
This method has multiple variants that differ in the arguments they accept. Each is described separately below.
setDocument(SBMLDocument doc)
Sets the current SBML document to the given SBMLDocument object.
doc | the document to use for this conversion. |
doc
is 'const', it is immediately cast to a non-version, which is then usually changed by the converter upon a successful conversion. This function is here solely to preserve backwards compatibility.setDocument(SBMLDocument doc)
Sets the current SBML document to the given SBMLDocument object.
doc | the document to use for this conversion. |
|
inherited |
Python method signature(s):
setProperties(SBMLConverter self, ConversionProperties props)int
Sets the configuration properties to be used by this converter.
A given converter exposes one or more properties that can be adjusted in order to influence the behavior of the converter. This method sets the current properties for this converter.
props | the ConversionProperties object defining the properties to set. |