libSBML C++ API
libSBML 5.8.0 C++ API
|
SBML converter for transforming documents from one Level+Version to another.
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 of one SBML Level+Version combination and attempts to convert it to another Level+Version combination. The target Level+Version is set using an SBMLNamespace object in the ConversionProperties object that controls this converter.
This class is the basis for SBMLDocument::setLevelAndVersion().
Public Member Functions | |
virtual SBMLLevelVersionConverter * | clone () const |
Creates and returns a deep copy of this SBMLLevelVersionConverter 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... | |
unsigned int | getTargetLevel () |
Returns the target SBML Level for the conversion. More... | |
virtual SBMLNamespaces * | getTargetNamespaces () |
Returns the target SBML namespaces of the currently set properties. More... | |
unsigned int | getTargetVersion () |
Returns the target SBML Version for the conversion. More... | |
bool | getValidityFlag () |
Returns the flag indicating whether the conversion has been set to "strict". More... | |
virtual bool | matchesProperties (const ConversionProperties &props) const |
Returns true if this converter object's properties match the given properties. More... | |
SBMLLevelVersionConverter & | operator= (const SBMLLevelVersionConverter &rhs) |
Assignment operator for SBMLLevelVersionConverter. More... | |
SBMLLevelVersionConverter () | |
Creates a new SBMLLevelVersionConverter object. More... | |
SBMLLevelVersionConverter (const SBMLLevelVersionConverter &obj) | |
Copy constructor; creates a copy of an SBMLLevelVersionConverter 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... | |
virtual | ~SBMLLevelVersionConverter () |
Destroys this object. More... | |
SBMLLevelVersionConverter::SBMLLevelVersionConverter | ( | ) |
Creates a new SBMLLevelVersionConverter object.
SBMLLevelVersionConverter::SBMLLevelVersionConverter | ( | const SBMLLevelVersionConverter & | obj | ) |
Copy constructor; creates a copy of an SBMLLevelVersionConverter object.
obj | the SBMLLevelVersionConverter object to copy. |
|
virtual |
Destroys this object.
|
virtual |
Creates and returns a deep copy of this SBMLLevelVersionConverter 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(). 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).
unsigned int SBMLLevelVersionConverter::getTargetLevel | ( | ) |
Returns the target SBML Level for the conversion.
|
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.
unsigned int SBMLLevelVersionConverter::getTargetVersion | ( | ) |
Returns the target SBML Version for the conversion.
bool SBMLLevelVersionConverter::getValidityFlag | ( | ) |
Returns the flag indicating whether the conversion has been set to "strict".
true
if strict validity has been requested, false
otherwise.
|
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 SBMLLevelVersionConverter 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.
SBMLLevelVersionConverter & SBMLLevelVersionConverter::operator= | ( | const SBMLLevelVersionConverter & | rhs | ) |
Assignment operator for SBMLLevelVersionConverter.
rhs | The object whose values are used as the basis of the assignment. |
SBMLConstructorException | Thrown if the argument rhs is NULL . |
|
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. |