libSBML Python API
5.8.0
|
This method has multiple variants that differ in the arguments they accept.
Each is described separately below.
Method variant with the following signature:
SBMLLevelVersionConverter()
Creates a new SBMLLevelVersionConverter object.
Method variant with the following signature:
SBMLLevelVersionConverter(SBMLLevelVersionConverter obj)
Copy constructor; creates a copy of an SBMLLevelVersionConverter object.
obj | the SBMLLevelVersionConverter object to copy. |
Public Member Functions | |
def | clone |
def | convert |
def | getDefaultProperties |
def | getDocument |
def | getProperties |
def | getTargetLevel |
def | getTargetNamespaces |
def | getTargetVersion |
def | getValidityFlag |
def | init |
def | matchesProperties |
def | setDocument |
def | setProperties |
def libsbml.SBMLLevelVersionConverter.clone | ( | self | ) |
Python method signature(s):
clone(SBMLLevelVersionConverter self)SBMLLevelVersionConverter
Creates and returns a deep copy of this SBMLConverter object.
def libsbml.SBMLLevelVersionConverter.convert | ( | self | ) |
Python method signature(s):
convert(SBMLLevelVersionConverter self)int
Perform the conversion.
This method causes the converter to do the actual conversion work, that is, to convert the SBMLDocument object set by SBMLConverter.setDocument() and with the configuration options set by SBMLConverter.setProperties().
def libsbml.SBMLLevelVersionConverter.getDefaultProperties | ( | self | ) |
Python method signature(s):
getDefaultProperties(SBMLLevelVersionConverter 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. The run-time properties of the converter object can be adjusted by using the method SBMLConverter.setProperties().
|
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().
def libsbml.SBMLLevelVersionConverter.getTargetLevel | ( | self | ) |
Python method signature(s):
getTargetLevel(SBMLLevelVersionConverter self)long
Returns the target SBML Level for the conversion.
|
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.SBMLLevelVersionConverter.getTargetVersion | ( | self | ) |
Python method signature(s):
getTargetVersion(SBMLLevelVersionConverter self)long
Returns the target SBML Version for the conversion.
def libsbml.SBMLLevelVersionConverter.getValidityFlag | ( | self | ) |
Python method signature(s):
getValidityFlag(SBMLLevelVersionConverter self)bool
Returns the flag indicating whether the conversion has been set to 'strict'.
True
if strict validity has been requested, False
otherwise. def libsbml.SBMLLevelVersionConverter.init | ( | ) |
This method has multiple variants that differ in the arguments they accept.
Each is described separately below.
Method variant with the following signature:
SBMLLevelVersionConverter()
Creates a new SBMLLevelVersionConverter object.
Method variant with the following signature:
SBMLLevelVersionConverter(SBMLLevelVersionConverter obj)
Copy constructor; creates a copy of an SBMLLevelVersionConverter object.
obj | the SBMLLevelVersionConverter object to copy.Python method signature(s): init() |
def libsbml.SBMLLevelVersionConverter.matchesProperties | ( | self, | |
args | |||
) |
Python method signature(s):
matchesProperties(SBMLLevelVersionConverter self, ConversionProperties props)bool
Predicate returning True
if this converter's properties matches a given set of configuration properties.
props | the configuration properties to match. |
True
if this converter's properties match, False
otherwise.
|
inherited |
Python method signature(s):
setDocument(SBMLConverter self, SBMLDocument doc)int
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. |