libSBML Perl API
libSBML 5.17.2 Perl API
|
{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).
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.
Public Member Functions | |
virtual SBMLInferUnitsConverter * | clone () const |
Creates and returns a deep copy of this SBMLInferUnitsConverter 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... | |
SBMLInferUnitsConverter & | operator= (const SBMLInferUnitsConverter &rhs) |
Assignment operator for SBMLInferUnitsConverter. More... | |
SBMLInferUnitsConverter () | |
Creates a new SBMLInferUnitsConverter object. More... | |
SBMLInferUnitsConverter (const SBMLInferUnitsConverter &obj) | |
Copy constructor; creates a copy of an SBMLInferUnitsConverter 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 | ~SBMLInferUnitsConverter () |
Destroys this object. More... | |
SBMLInferUnitsConverter::SBMLInferUnitsConverter | ( | ) |
Creates a new SBMLInferUnitsConverter object.
SBMLInferUnitsConverter::SBMLInferUnitsConverter | ( | const SBMLInferUnitsConverter & | obj | ) |
Copy constructor; creates a copy of an SBMLInferUnitsConverter object.
obj | the SBMLInferUnitsConverter object to copy. |
|
virtual |
Destroys this object.
|
virtual |
Creates and returns a deep copy of this SBMLInferUnitsConverter object.
Reimplemented from SBMLConverter.
|
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().
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.
|
inherited |
Returns the name of this converter.
|
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, 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.
NULL
if none are set.
|
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.
props | the properties to match. |
true
if this converter's properties match, false
otherwise. Reimplemented from SBMLConverter.
SBMLInferUnitsConverter & SBMLInferUnitsConverter::operator= | ( | const SBMLInferUnitsConverter & | rhs | ) |
Assignment operator for SBMLInferUnitsConverter.
rhs | the object whose values are used as the basis of the assignment. |
|
virtualinherited |
Sets the SBML document to be converted.
doc | the document to use for this conversion. |
Reimplemented in SBMLReactionConverter, and SBMLRateOfConverter.
|
virtualinherited |
Sets the SBML document to be converted.
doc | the document to use for this conversion. |
Reimplemented in SBMLReactionConverter, and SBMLRateOfConverter.
|
virtualinherited |
Sets the configuration properties to be used by this converter.
props | the ConversionProperties object defining the properties to set. |