Inheritance diagram for SBMLUnitsConverter:

Detailed Description

Converts a model's existing 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, that is, using only the units metre, kilogram, second, ampere, kelvin, mole and candela.

Unit conversion will only be performed on models that are fully unit consistent, meaning that all objects have units associated with them and there are no literal numbers with unspecified units. 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.

Configuration and use of SBMLUnitsConverter

SBMLUnitsConverter is enabled by creating a ConversionProperties object with the option "units", and passing this properties object to SBMLDocument::convert(). This converter takes one optional option:

"removeUnusedUnits": the value of this property should be a Boolean. If it is true, it tells the unit convert to remove any unused UnitDefinition objects after conversion is complete. ("Unused" units are units that are not referenced by any object in the model.) If the value is false, unused UnitDefinition objects are not removed from the model. The default is true.

General information about the use of SBML converters

The use of all the converters follows a similar approach. First, one creates a ConversionProperties object and calls ConversionProperties::addOption() on this object with one argument: a text string that identifies the desired converter. (The text string is specific to each converter; consult the documentation for a given converter to find out how it should be enabled.)

Next, for some converters, the caller can optionally set some converter-specific properties using additional calls to ConversionProperties::addOption(). Many converters provide the ability to configure their behavior to some extent; this is realized through the use of properties that offer different options. The default property values for each converter can be interrogated using the method SBMLConverter::getDefaultProperties() on the converter class in question .

Finally, the caller should invoke the method SBMLDocument::convert() with the ConversionProperties object as an argument.

Example of invoking an SBML converter

The following code fragment illustrates an example using SBMLReactionConverter, which is invoked using the option string "replaceReactions":

ConversionProperties props;

props.addOption("replaceReactions");

In the case of SBMLReactionConverter, there are no options to affect its behavior, so the next step is simply to invoke the converter on an SBMLDocument object. Continuing the example code:

// Assume that the variable "document" has been set to an SBMLDocument object.
int status = document->convert(props);
if (status != LIBSBML_OPERATION_SUCCESS)
{
  cerr << "Unable to perform conversion due to the following:" << endl;
  document->printErrors(cerr);
}

Here is an example of using a converter that offers an option. The following code invokes SBMLStripPackageConverter to remove the SBML Level 3 Layout package from a model. It sets the name of the package to be removed by adding a value for the option named "package" defined by that converter:

ConversionProperties props;
props.addOption("stripPackage");
props.addOption("package", "layout");
int status = document->convert(props);
if (status != LIBSBML_OPERATION_SUCCESS)
{
    cerr << "Unable to strip the Layout package from the model";
    cerr << "Error returned: " << status;
}

Available SBML converters in libSBML

LibSBML provides a number of built-in converters; by convention, their names end in Converter. The following are the built-in converters provided by libSBML 5.18.0:

Public Member Functions
virtual SBMLUnitsConverter *	clone () const
	Creates and returns a deep copy of this SBMLUnitsConverter object. More...

virtual int	convert ()
	Perform the conversion. 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...

const std::string &	getName () const
	Returns the name of this converter. 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 SBML document to be converted. More...

virtual int	setDocument (SBMLDocument *doc)
	Sets the SBML document to be converted. More...

virtual int	setProperties (const ConversionProperties *props)
	Sets the configuration properties to be used by this converter. More...

virtual	~SBMLUnitsConverter ()
	Destroy this object. More...

Constructor & Destructor Documentation

SBMLUnitsConverter::SBMLUnitsConverter ( )

Creates a new SBMLUnitsConverter object.

SBMLUnitsConverter::SBMLUnitsConverter ( const SBMLUnitsConverter & obj )

Copy constructor; creates a copy of an SBMLUnitsConverter object.

Parameters

obj	the SBMLUnitsConverter object to copy.

SBMLUnitsConverter::~SBMLUnitsConverter ( )

virtual

Destroy this object.

Member Function Documentation

SBMLUnitsConverter * SBMLUnitsConverter::clone ( ) const

virtual

Creates and returns a deep copy of this SBMLUnitsConverter object.

Returns: a (deep) copy of this converter.

Reimplemented from SBMLConverter.

int SBMLUnitsConverter::convert ( )

virtual

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 success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

Reimplemented from SBMLConverter.

ConversionProperties SBMLUnitsConverter::getDefaultProperties ( ) const

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.

Returns: the ConversionProperties object describing the default properties for this converter.

Reimplemented from SBMLConverter.

SBMLDocument * SBMLConverter::getDocument ( )

virtualinherited

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

Returns: the current SBMLDocument object.

const SBMLDocument * SBMLConverter::getDocument ( ) const

virtualinherited

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

Returns: the current SBMLDocument object.

const std::string & SBMLConverter::getName ( ) const

inherited

Returns the name of this converter.

Returns: a string, the name of this converter.

ConversionProperties * SBMLConverter::getProperties ( ) const

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

Returns: the currently set configuration properties.

See also: setProperties(); matchesProperties()

SBMLNamespaces * SBMLConverter::getTargetNamespaces ( )

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, 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 NULL if none are set.

bool SBMLUnitsConverter::matchesProperties ( const ConversionProperties & props ) const

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.

Parameters

props the properties to match.

Returns: true if this converter's properties match, false otherwise.

Reimplemented from SBMLConverter.

SBMLUnitsConverter & SBMLUnitsConverter::operator= ( const SBMLUnitsConverter & rhs )

Assignment operator for SBMLUnitsConverter.

Parameters

rhs	the object whose values are used as the basis of the assignment.

int SBMLConverter::setDocument ( const SBMLDocument * doc )

virtualinherited

Sets the SBML document to be converted.

Parameters

doc	the document to use for this conversion.

Returns

integer value indicating the success/failure of the operation. The value is drawn from the enumeration OperationReturnValues_t. 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:

LIBSBML_OPERATION_SUCCESS

Warning: Even though the argument 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 variant of the setDocument() method is here solely to preserve backwards compatibility.

Reimplemented in SBMLReactionConverter, and SBMLRateOfConverter.

Examples:: flattenModel.cpp.

int SBMLConverter::setDocument ( SBMLDocument * doc )

virtualinherited

Sets the SBML document to be converted.

Parameters

doc	the document to use for this conversion.

Returns

integer value indicating the success/failure of the operation. The value is drawn from the enumeration OperationReturnValues_t. 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:

LIBSBML_OPERATION_SUCCESS

Reimplemented in SBMLReactionConverter, and SBMLRateOfConverter.

int SBMLConverter::setProperties ( const ConversionProperties * props )

virtualinherited

Sets the configuration properties to be used by this converter.

Parameters

props the ConversionProperties object defining the properties to set.

Returns

integer value indicating the success/failure of the operation. The value is drawn from the enumeration OperationReturnValues_t. 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()

Detailed Description

Configuration and use of SBMLUnitsConverter

General information about the use of SBML converters

Example of invoking an SBML converter

Available SBML converters in libSBML

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation