libSBML Perl API
libSBML 5.10.0 Perl API
|
{core} 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.
Public Member Functions | |
virtual SBMLUnitsConverter * | clone () const |
Creates and returns a deep copy of this SBMLUnitsConverter object. More... | |
virtual int | convert () |
Convers the units in the model to base SI units; namely metre, kilogram, second, Ampere, Kelvin, mole and candela. More... | |
virtual ConversionProperties | getDefaultProperties () const |
Returns the default properties of this converter. More... | |
virtual SBMLDocument * | getDocument () |
Returns the SBML document that is the subject of the conversions. More... | |
virtual const SBMLDocument * | getDocument () const |
Returns the SBML document that is the subject of the conversions. More... | |
virtual ConversionProperties * | getProperties () const |
Returns the current properties in effect for this converter. More... | |
virtual SBMLNamespaces * | getTargetNamespaces () |
Returns the target SBML namespaces of the currently set properties. More... | |
virtual bool | matchesProperties (const ConversionProperties &props) const |
Returns true if this converter object's properties match the given properties. More... | |
SBMLUnitsConverter & | operator= (const SBMLUnitsConverter &rhs) |
Assignment operator for SBMLUnitsConverter. More... | |
SBMLUnitsConverter () | |
Creates a new SBMLUnitsConverter object. More... | |
SBMLUnitsConverter (const SBMLUnitsConverter &obj) | |
Copy constructor; creates a copy of an SBMLUnitsConverter object. More... | |
virtual int | setDocument (const SBMLDocument *doc) |
Sets the current SBML document to the given SBMLDocument object. More... | |
virtual int | setDocument (SBMLDocument *doc) |
Sets the current SBML document to the given SBMLDocument object. More... | |
virtual int | setProperties (const ConversionProperties *props) |
Sets the configuration properties to be used by this converter. More... | |
virtual | ~SBMLUnitsConverter () |
Destroy this object. More... | |
SBMLUnitsConverter::SBMLUnitsConverter | ( | ) |
Creates a new SBMLUnitsConverter object.
SBMLUnitsConverter::SBMLUnitsConverter | ( | const SBMLUnitsConverter & | obj | ) |
Copy constructor; creates a copy of an SBMLUnitsConverter object.
obj | the SBMLUnitsConverter object to copy. |
|
virtual |
Destroy this object.
|
virtual |
Creates and returns a deep copy of this SBMLUnitsConverter object.
Reimplemented from SBMLConverter.
|
virtual |
Convers the units in the model to base SI units; namely metre, kilogram, second, Ampere, Kelvin, mole and candela.
Reimplemented from SBMLConverter.
|
virtual |
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.
Reimplemented from SBMLConverter.
|
virtualinherited |
Returns the SBML document that is the subject of the conversions.
|
virtualinherited |
Returns the SBML document that is the subject of the conversions.
|
virtualinherited |
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(const ConversionProperties *props).
|
virtualinherited |
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.
|
virtual |
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 SBMLUnitsConverter 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. Reimplemented from SBMLConverter.
SBMLUnitsConverter & SBMLUnitsConverter::operator= | ( | const SBMLUnitsConverter & | rhs | ) |
Assignment operator for SBMLUnitsConverter.
rhs | The object whose values are used as the basis of the assignment. |
SBMLConstructorException | Thrown if the argument rhs is NULL . |
|
virtualinherited |
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-const version, which is then usually changed by the converter upon a successful conversion. This function is here solely to preserve backwards compatibility.Reimplemented in SBMLReactionConverter.
|
virtualinherited |
Sets the current SBML document to the given SBMLDocument object.
doc | the document to use for this conversion. |
Reimplemented in SBMLReactionConverter.
|
virtualinherited |
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. |