libSBML Python API  5.11.0
libsbml.CobraToFbcConverter Class Reference
Inheritance diagram for libsbml.CobraToFbcConverter:
[legend]

Detailed Description

fbc COBRA to SBML Level 3 'fbc' converter.

Public Member Functions

def __init__ (self, args)
 fbc COBRA to SBML Level 3 'fbc' converter. More...
 
def checkCompatibility (self)
 
def clone (self)
 Creates and returns a deep copy of this CobraToFbcConverter. More...
 
def convert (self)
 
def getDefaultProperties (self)
 Returns the default properties of this converter. More...
 
def getDocument (self, args)
 Returns the SBML document that is the subject of the conversions. More...
 
def getName (self)
 Returns the name of this converter. More...
 
def getProperties (self)
 Returns the current properties in effect for this converter. More...
 
def getTargetNamespaces (self)
 Returns the target SBML namespaces of the currently set properties. More...
 
def matchesProperties (self, props)
 This function determines whether a given converter matches the configuration properties given. More...
 
def setDocument (self, doc)
 This method has multiple variants; they differ in the arguments they accept. More...
 
def setProperties (self, props)
 Sets the configuration properties to be used by this converter. More...
 

Member Function Documentation

def libsbml.CobraToFbcConverter.checkCompatibility (   self)
checkCompatibility()   bool

Returns a flag whether the level and version of the source document should be checked for compatibility before converting to SBML Level 3

def libsbml.CobraToFbcConverter.clone (   self)

Creates and returns a deep copy of this CobraToFbcConverter.

clone()   CobraToFbcConverter
Returns
a (deep) copy of this CobraToFbcConverter.
def libsbml.CobraToFbcConverter.convert (   self)
convert()   int

the actual conversion

Returns
status code represeting success/failure/conversion impossible
def libsbml.CobraToFbcConverter.getDefaultProperties (   self)

Returns the default properties of this converter.

getDefaultProperties()   ConversionProperties

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 properties for the CobraToFbcConverter are: 'convert cobra' - the name of this converter

Returns
the ConversionProperties object describing the default properties for this converter.
def libsbml.SBMLConverter.getDocument (   self,
  args 
)
inherited

Returns the SBML document that is the subject of the conversions.

getDocument()   SBMLDocument
Returns
the current SBMLDocument object.
def libsbml.SBMLConverter.getName (   self)
inherited

Returns the name of this converter.

getName()   string
Returns
a string, the name of this converter.
def libsbml.SBMLConverter.getProperties (   self)
inherited

Returns the current properties in effect for this converter.

getProperties()   ConversionProperties

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().

Returns
the currently set configuration properties.
See also
setProperties()
matchesProperties()
def libsbml.SBMLConverter.getTargetNamespaces (   self)
inherited

Returns the target SBML namespaces of the currently set properties.

getTargetNamespaces()   SBMLNamespaces

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, in SBMLLevelVersionConverter (the converter for converting SBML documents from one Level+Version combination to another), the actions are fundamentally dependent on the SBML namespaces targeted.

Returns
the SBMLNamespaces object that describes the SBML namespaces in effect, or None if none are set.
def libsbml.CobraToFbcConverter.matchesProperties (   self,
  props 
)

This function determines whether a given converter matches the configuration properties given.

matchesProperties(ConversionProperties props)   bool
Parameters
propsthe properties to match
Returns
true if this converter is a match, false otherwise.
def libsbml.SBMLConverter.setDocument (   self,
  doc 
)
inherited

This method has multiple variants; they differ in the arguments they accept.

setDocument(SBMLDocument doc)   int

Each variant is described separately below.


Method variant with the following signature:
setDocument(SBMLDocument doc)

Sets the SBML document to be converted.

Parameters
docthe document to use for this conversion.
Returns
integer value indicating the success/failure of the operation. The set of possible values that may be returned ultimately depends on the specific subclass of SBMLConverter being used, but the default method can return the following:

Method variant with the following signature:
setDocument(SBMLDocument doc)

Sets the SBML document to be converted.

Parameters
docthe document to use for this conversion.
Returns
integer value indicating the success/failure of the operation. The set of possible values that may be returned ultimately depends on the specific subclass of SBMLConverter being used, but the default method can return the following:
def libsbml.SBMLConverter.setProperties (   self,
  props 
)
inherited

Sets the configuration properties to be used by this converter.

setProperties(ConversionProperties props)   int
Parameters
propsthe ConversionProperties object defining the properties to set.
Returns
integer value indicating the success/failure of the operation. The set of possible values that may be returned ultimately depends on the specific subclass of SBMLConverter being used, but the default method can return the following values:
See also
getProperties()
matchesProperties()