libSBML C# API  libSBML 5.13.0 C# API
libsbmlcs.SBMLInferUnitsConverter Class Reference
Inheritance diagram for libsbmlcs.SBMLInferUnitsConverter:
[legend]

Detailed Description

{core}

Converter for inferring and setting parameter 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 takes an SBML document and attempts to infer units for any Parameter objects whose units are undeclared. It then sets the 'units' attribute of those parameters to the units inferred (if necessary, creating new UnitDefinition objects on the model in the process).

Configuration and use of SBMLInferUnitsConverter

SBMLInferUnitsConverter is enabled by creating a ConversionProperties object with the option 'inferUnits', and passing this properties object to SBMLDocument::convert(). The converter offers no other options.

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 arguments: 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':

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:

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:

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.13.0 :

Public Member Functions

new SBMLConverter clone ()
 Creates and returns a deep copy of this SBMLInferUnitsConverter object. More...
 
new int convert ()
 Perform the conversion. More...
 
override void Dispose ()
 
new ConversionProperties getDefaultProperties ()
 Returns the default properties of this converter. More...
 
new SBMLDocument getDocument ()
 Returns the SBML document that is the subject of the conversions. More...
 
string getName ()
 Returns the name of this converter. More...
 
virtual ConversionProperties getProperties ()
 Returns the current properties in effect for this converter. More...
 
virtual SBMLNamespaces getTargetNamespaces ()
 Returns the target SBML namespaces of the currently set properties. More...
 
new bool matchesProperties (ConversionProperties props)
 Returns true if this converter object's properties match the given properties. More...
 
 SBMLInferUnitsConverter ()
 Creates a new SBMLInferUnitsConverter object. More...
 
 SBMLInferUnitsConverter (SBMLInferUnitsConverter obj)
 Copy constructor; creates a copy of an SBMLInferUnitsConverter object. More...
 
virtual int setDocument (SBMLDocument doc)
 Sets the SBML document to be converted. More...
 
virtual int setProperties (ConversionProperties props)
 Sets the configuration properties to be used by this converter. More...
 
delegate IntPtr SwigDelegateSBMLConverter_0 ()
 
delegate IntPtr SwigDelegateSBMLConverter_1 ()
 
delegate IntPtr SwigDelegateSBMLConverter_2 ()
 
delegate IntPtr SwigDelegateSBMLConverter_3 ()
 
delegate IntPtr SwigDelegateSBMLConverter_4 ()
 
delegate bool SwigDelegateSBMLConverter_5 (IntPtr props)
 
delegate int SwigDelegateSBMLConverter_6 (IntPtr doc)
 
delegate int SwigDelegateSBMLConverter_7 (IntPtr props)
 
delegate IntPtr SwigDelegateSBMLConverter_8 ()
 
delegate int SwigDelegateSBMLConverter_9 ()
 

Static Public Member Functions

static void init ()
 

Protected Attributes

bool swigCMemOwn
 

Constructor & Destructor Documentation

◆ SBMLInferUnitsConverter() [1/2]

libsbmlcs.SBMLInferUnitsConverter.SBMLInferUnitsConverter ( )

Creates a new SBMLInferUnitsConverter object.

◆ SBMLInferUnitsConverter() [2/2]

libsbmlcs.SBMLInferUnitsConverter.SBMLInferUnitsConverter ( SBMLInferUnitsConverter  obj)

Copy constructor; creates a copy of an SBMLInferUnitsConverter object.

Parameters
objthe SBMLInferUnitsConverter object to copy.

Member Function Documentation

◆ clone()

new SBMLConverter libsbmlcs.SBMLInferUnitsConverter.clone ( )

Creates and returns a deep copy of this SBMLInferUnitsConverter object.

Returns
a (deep) copy of this converter.

◆ convert()

new int libsbmlcs.SBMLInferUnitsConverter.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 possible values returned by this function are:

Reimplemented from libsbmlcs.SBMLConverter.

◆ Dispose()

override void libsbmlcs.SBMLInferUnitsConverter.Dispose ( )
virtual

Reimplemented from libsbmlcs.SBMLConverter.

◆ getDefaultProperties()

new ConversionProperties libsbmlcs.SBMLInferUnitsConverter.getDefaultProperties ( )
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 libsbmlcs.SBMLConverter.

◆ getDocument()

new SBMLDocument libsbmlcs.SBMLConverter.getDocument ( )
inherited

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

Returns
the current SBMLDocument object.

◆ getName()

string libsbmlcs.SBMLConverter.getName ( )
inherited

Returns the name of this converter.

Returns
a string, the name of this converter.

◆ getProperties()

virtual ConversionProperties libsbmlcs.SBMLConverter.getProperties ( )
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(ConversionProperties props).

Returns
the currently set configuration properties.
See also
setProperties()
matchesProperties()

◆ getTargetNamespaces()

virtual SBMLNamespaces libsbmlcs.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.

◆ init()

static void libsbmlcs.SBMLInferUnitsConverter.init ( )
static

◆ matchesProperties()

new bool libsbmlcs.SBMLInferUnitsConverter.matchesProperties ( ConversionProperties  props)
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 SBMLInferUnitsConverter 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
propsthe properties to match.
Returns
true if this converter's properties match, false otherwise.

Reimplemented from libsbmlcs.SBMLConverter.

◆ setDocument()

virtual int libsbmlcs.SBMLConverter.setDocument ( SBMLDocument  doc)
virtualinherited

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:

Reimplemented in libsbmlcs.SBMLReactionConverter.

◆ setProperties()

virtual int libsbmlcs.SBMLConverter.setProperties ( ConversionProperties  props)
virtualinherited

Sets the configuration properties to be used by 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()

◆ SwigDelegateSBMLConverter_0()

delegate IntPtr libsbmlcs.SBMLConverter.SwigDelegateSBMLConverter_0 ( )
inherited

◆ SwigDelegateSBMLConverter_1()

delegate IntPtr libsbmlcs.SBMLConverter.SwigDelegateSBMLConverter_1 ( )
inherited

◆ SwigDelegateSBMLConverter_2()

delegate IntPtr libsbmlcs.SBMLConverter.SwigDelegateSBMLConverter_2 ( )
inherited

◆ SwigDelegateSBMLConverter_3()

delegate IntPtr libsbmlcs.SBMLConverter.SwigDelegateSBMLConverter_3 ( )
inherited

◆ SwigDelegateSBMLConverter_4()

delegate IntPtr libsbmlcs.SBMLConverter.SwigDelegateSBMLConverter_4 ( )
inherited

◆ SwigDelegateSBMLConverter_5()

delegate bool libsbmlcs.SBMLConverter.SwigDelegateSBMLConverter_5 ( IntPtr  props)
inherited

◆ SwigDelegateSBMLConverter_6()

delegate int libsbmlcs.SBMLConverter.SwigDelegateSBMLConverter_6 ( IntPtr  doc)
inherited

◆ SwigDelegateSBMLConverter_7()

delegate int libsbmlcs.SBMLConverter.SwigDelegateSBMLConverter_7 ( IntPtr  props)
inherited

◆ SwigDelegateSBMLConverter_8()

delegate IntPtr libsbmlcs.SBMLConverter.SwigDelegateSBMLConverter_8 ( )
inherited

◆ SwigDelegateSBMLConverter_9()

delegate int libsbmlcs.SBMLConverter.SwigDelegateSBMLConverter_9 ( )
inherited

Member Data Documentation

◆ swigCMemOwn

bool libsbmlcs.SBMLConverter.swigCMemOwn
protectedinherited