libSBML C++ API
libSBML 5.8.0 C++ API
|
SBML converter for replacing function definitions.
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 is an SBML converter for manipulating user-defined functions in an SBML file. When invoked on the current model, it performs the following operation:
For example, suppose the model contains a function definition representing the function f(x, y) = x * y. Further suppose this functions invoked somewhere else in the model, in a mathematical formula, as f(s, p). The outcome of running SBMLFunctionDefinitionConverter on the model will be to replace the call to f with the expression s * p.
Public Member Functions | |
virtual SBMLConverter * | clone () const |
Creates and returns a deep copy of this SBMLFunctionDefinitionConverter object. More... | |
virtual int | convert () |
Replaces invocations of each user-defined function with an in-line copy, similar to macro expansion. 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... | |
SBMLFunctionDefinitionConverter () | |
Creates a new SBMLFunctionDefinitionConverter object. More... | |
SBMLFunctionDefinitionConverter (const SBMLFunctionDefinitionConverter &obj) | |
Copy constructor; creates a copy of an SBMLFunctionDefinitionConverter object. More... | |
virtual int | setDocument (const 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... | |
SBMLFunctionDefinitionConverter::SBMLFunctionDefinitionConverter | ( | ) |
Creates a new SBMLFunctionDefinitionConverter object.
SBMLFunctionDefinitionConverter::SBMLFunctionDefinitionConverter | ( | const SBMLFunctionDefinitionConverter & | obj | ) |
Copy constructor; creates a copy of an SBMLFunctionDefinitionConverter object.
obj | the SBMLFunctionDefinitionConverter object to copy. |
|
virtual |
Creates and returns a deep copy of this SBMLFunctionDefinitionConverter object.
Reimplemented from SBMLConverter.
|
virtual |
Replaces invocations of each user-defined function with an in-line copy, similar to macro expansion.
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 SBMLFunctionDefinitionConverter 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.
|
virtualinherited |
Sets the current SBML document to the given SBMLDocument object.
doc | the document to use for this conversion. |
|
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. |