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

Detailed Description

SBML converter to convert a model's units to SI units.

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 SBML converter converts the units in a model to base SI units, namely metre, kilogram, second, Ampere, Kelvin, mole and candela.

Unit conversion will only be performed on models that are fully unit consistent; that is, all objects have associated units, and there are no literal numbers with no units specified. In the case of an SBML Level 3 model involving math expressions, this means that the timeUnits attribute on the Model object must be set, and if there are any reactions in the model, the extentUnits attribute on the Model object must also be set.

This converter has the additional Boolean property 'removeUnusedUnits' that can be used to tell the converter whether to remove any UnitDefinition objects that are not referred to, after conversion is complete. You can set this value by adding the property using

 prop.addOption('removeUnusedUnits', false);

The converter's default behavior is to remove the unused UnitDefinition objects in the model.

See Also
SBMLFunctionDefinitionConverter
SBMLLevelVersionConverter
SBMLRuleConverter
SBMLStripPackageConverter
SBMLUnitsConverter

Public Member Functions

def clone
 
def convert
 
def getDefaultProperties
 
def getDocument
 
def getProperties
 
def getTargetNamespaces
 
def init
 
def matchesProperties
 
def setDocument
 
def setProperties
 

Member Function Documentation

def libsbml.SBMLUnitsConverter.clone (   self)

Python method signature(s):

clone(SBMLUnitsConverter self)   SBMLUnitsConverter

Creates and returns a deep copy of this SBMLConverter object.

Returns
a (deep) copy of this SBMLConverter object.
def libsbml.SBMLUnitsConverter.convert (   self)

Python method signature(s):

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

Returns
integer value indicating the success/failure of the operation. The set of possible values that may be returned depends on the converter subclass; please consult the documentation for the relevant class to find out what the possibilities are.
def libsbml.SBMLUnitsConverter.getDefaultProperties (   self)

Python method signature(s):

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

Returns
the default properties for the converter.
See Also
setProperties()
matchesProperties()
def libsbml.SBMLConverter.getDocument (   self,
  args 
)
inherited

Python method signature(s):

getDocument(SBMLConverter self)   SBMLDocument
getDocument(SBMLConverter self)   SBMLDocument

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

Returns
the current SBMLDocument object.
def libsbml.SBMLConverter.getProperties (   self)
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().

Returns
the currently set configuration properties.
See Also
setProperties()
matchesProperties()
def libsbml.SBMLConverter.getTargetNamespaces (   self)
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.

Returns
the SBMLNamespaces object that describes the SBML namespaces in effect.
def libsbml.SBMLUnitsConverter.init ( )

SBML converter to convert a model's units to SI units.

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 SBML converter converts the units in a model to base SI units, namely metre, kilogram, second, Ampere, Kelvin, mole and candela.

Unit conversion will only be performed on models that are fully unit consistent; that is, all objects have associated units, and there are no literal numbers with no units specified. In the case of an SBML Level 3 model involving math expressions, this means that the timeUnits attribute on the Model object must be set, and if there are any reactions in the model, the extentUnits attribute on the Model object must also be set.

This converter has the additional Boolean property 'removeUnusedUnits' that can be used to tell the converter whether to remove any UnitDefinition objects that are not referred to, after conversion is complete. You can set this value by adding the property using

 prop.addOption('removeUnusedUnits', false);

The converter's default behavior is to remove the unused UnitDefinition objects in the model.

See Also
SBMLFunctionDefinitionConverter
SBMLLevelVersionConverter
SBMLRuleConverter
SBMLStripPackageConverter
SBMLUnitsConverterPython method signature(s):
init()
def libsbml.SBMLUnitsConverter.matchesProperties (   self,
  args 
)

Python method signature(s):

matchesProperties(SBMLUnitsConverter self, ConversionProperties props)   bool

Predicate returning True if this converter's properties matches a given set of configuration properties.

Parameters
propsthe configuration properties to match.
Returns
True if this converter's properties match, False otherwise.
def libsbml.SBMLConverter.setDocument (   self,
  args 
)
inherited

Python method signature(s):

setDocument(SBMLConverter self, SBMLDocument doc)   int

Sets the current SBML document to the given SBMLDocument object.

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 values:
def libsbml.SBMLConverter.setProperties (   self,
  args 
)
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.

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