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 | |
SBMLConverter | clone () |
Creates and returns a deep copy of this SBMLConverter object. More... | |
int | convert () |
Perform the conversion. More... | |
override void | Dispose () |
ConversionProperties | getDefaultProperties () |
Returns the default properties of this converter. More... | |
SBMLDocument | getDocument () |
Returns the SBML document that is the subject of the conversions. More... | |
ConversionProperties | getProperties () |
Returns the current properties in effect for this converter. More... | |
long | getTargetLevel () |
Returns the target SBML Level for the conversion. More... | |
SBMLNamespaces | getTargetNamespaces () |
Returns the target SBML namespaces of the currently set properties. More... | |
long | 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... | |
bool | matchesProperties (ConversionProperties props) |
Predicate returning true if this converter's properties matches a given set of configuration properties. More... | |
SBMLLevelVersionConverter () | |
Creates a new SBMLLevelVersionConverter object. More... | |
SBMLLevelVersionConverter (SBMLLevelVersionConverter obj) | |
Copy constructor; creates a copy of an SBMLLevelVersionConverter object. More... | |
int | setDocument (SBMLDocument doc) |
Sets the current SBML document to the given SBMLDocument object. More... | |
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 |
libsbmlcs.SBMLLevelVersionConverter.SBMLLevelVersionConverter | ( | ) |
Creates a new SBMLLevelVersionConverter object.
libsbmlcs.SBMLLevelVersionConverter.SBMLLevelVersionConverter | ( | SBMLLevelVersionConverter | obj | ) |
Copy constructor; creates a copy of an SBMLLevelVersionConverter object.
obj | the SBMLLevelVersionConverter object to copy. |
SBMLConverter libsbmlcs.SBMLLevelVersionConverter.clone | ( | ) |
Creates and returns a deep copy of this SBMLConverter object.
int libsbmlcs.SBMLLevelVersionConverter.convert | ( | ) |
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().
|
virtual |
Reimplemented from libsbmlcs.SBMLConverter.
ConversionProperties libsbmlcs.SBMLLevelVersionConverter.getDefaultProperties | ( | ) |
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. The run-time properties of the converter object can be adjusted by using the method SBMLConverter::setProperties(ConversionProperties props).
|
inherited |
Returns the SBML document that is the subject of the conversions.
|
inherited |
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).
long libsbmlcs.SBMLLevelVersionConverter.getTargetLevel | ( | ) |
Returns the target SBML Level for the conversion.
|
inherited |
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.
long libsbmlcs.SBMLLevelVersionConverter.getTargetVersion | ( | ) |
Returns the target SBML Version for the conversion.
bool libsbmlcs.SBMLLevelVersionConverter.getValidityFlag | ( | ) |
Returns the flag indicating whether the conversion has been set to 'strict'.
true
if strict validity has been requested, false
otherwise.
|
static |
bool libsbmlcs.SBMLLevelVersionConverter.matchesProperties | ( | ConversionProperties | props | ) |
Predicate returning true
if this converter's properties matches a given set of configuration properties.
props | the configuration properties to match. |
true
if this converter's properties match, false
otherwise.
|
inherited |
Sets the current SBML document to the given SBMLDocument object.
doc | the document to use for this conversion. |
|
inherited |
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. |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
protectedinherited |