libSBML Perl API
libSBML 5.10.0 Perl API
|
{core} SBML converter for replacing initial assignments.
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 replacing InitialAssignment objects (when possible) by setting the initial value attributes on the model objects being assigned. In other words, for every object that is the target of an initial assignment in the model, it evaluates the mathematical expression of the assignment to get a numerical value, and then sets the corresponding attribute of the object to the value. The effects for different kinds of SBML components are as follows:
Component | Effect |
---|---|
Compartment | Sets the value of the size attribute. |
Species | Sets the value of either the initialAmount or the initialConcentration attributes, depending on the value of the Species object's hasOnlySubstanceUnits attribute. |
Parameter | Sets the value of the value attribute. |
SpeciesReference | Sets the value of the stoichiometry attribute in the Reaction object where the SpeciesReference object appears. |
Public Member Functions | |
virtual SBMLConverter * | clone () const |
Creates and returns a deep copy of this SBMLInitialAssignmentConverter 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... | |
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... | |
SBMLInitialAssignmentConverter () | |
Creates a new SBMLInitialAssignmentConverter object. More... | |
SBMLInitialAssignmentConverter (const SBMLInitialAssignmentConverter &obj) | |
Copy constructor; creates a copy of an SBMLInitialAssignmentConverter 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 | ~SBMLInitialAssignmentConverter () |
Destroy this SBMLInitialAssignmentConverter object. More... | |
SBMLInitialAssignmentConverter::SBMLInitialAssignmentConverter | ( | ) |
Creates a new SBMLInitialAssignmentConverter object.
SBMLInitialAssignmentConverter::SBMLInitialAssignmentConverter | ( | const SBMLInitialAssignmentConverter & | obj | ) |
Copy constructor; creates a copy of an SBMLInitialAssignmentConverter object.
obj | the SBMLInitialAssignmentConverter object to copy. |
|
virtual |
Destroy this SBMLInitialAssignmentConverter object.
|
virtual |
Creates and returns a deep copy of this SBMLInitialAssignmentConverter 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.
|
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 SBMLInitialAssignmentConverter 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. |
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. |