libSBML Perl API  libSBML 5.8.0 Perl API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SBMLLevelVersionConverter Class Reference
Inheritance diagram for SBMLLevelVersionConverter:
[legend]

Detailed Description

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().

See Also
SBMLFunctionDefinitionConverter
SBMLInitialAssignmentConverter
SBMLRuleConverter
SBMLStripPackageConverter
SBMLUnitsConverter

Public Member Functions

virtual SBMLLevelVersionConverterclone () 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 SBMLDocumentgetDocument ()
 Returns the SBML document that is the subject of the conversions. More...
 
virtual const SBMLDocumentgetDocument () const
 Returns the SBML document that is the subject of the conversions. More...
 
virtual ConversionPropertiesgetProperties () const
 Returns the current properties in effect for this converter. More...
 
unsigned int getTargetLevel ()
 Returns the target SBML Level for the conversion. More...
 
virtual SBMLNamespacesgetTargetNamespaces ()
 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...
 
SBMLLevelVersionConverteroperator= (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...
 

Constructor & Destructor Documentation

SBMLLevelVersionConverter::SBMLLevelVersionConverter ( )

Creates a new SBMLLevelVersionConverter object.

SBMLLevelVersionConverter::SBMLLevelVersionConverter ( const SBMLLevelVersionConverter obj)

Copy constructor; creates a copy of an SBMLLevelVersionConverter object.

Parameters
objthe SBMLLevelVersionConverter object to copy.
SBMLLevelVersionConverter::~SBMLLevelVersionConverter ( )
virtual

Destroys this object.

Member Function Documentation

SBMLLevelVersionConverter * SBMLLevelVersionConverter::clone ( ) const
virtual

Creates and returns a deep copy of this SBMLLevelVersionConverter object.

Returns
a (deep) copy of this converter.

Reimplemented from SBMLConverter.

int SBMLLevelVersionConverter::convert ( )
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().

Returns
integer value indicating the success/failure of the operation. The possible values are:

Reimplemented from SBMLConverter.

ConversionProperties SBMLLevelVersionConverter::getDefaultProperties ( ) const
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.

Returns
the ConversionProperties object describing the default properties for this converter.

Reimplemented from SBMLConverter.

SBMLDocument * SBMLConverter::getDocument ( )
virtualinherited

Returns the SBML document that is the subject of the conversions.

Returns
the current SBMLDocument object.
const SBMLDocument * SBMLConverter::getDocument ( ) const
virtualinherited

Returns the SBML document that is the subject of the conversions.

Returns
the current SBMLDocument object, as a const reference.
ConversionProperties * SBMLConverter::getProperties ( ) const
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).

Returns
the currently set configuration properties.
See Also
setProperties()
matchesProperties()
unsigned int SBMLLevelVersionConverter::getTargetLevel ( )

Returns the target SBML Level for the conversion.

Returns
an integer indicating the SBML Level.
SBMLNamespaces * SBMLConverter::getTargetNamespaces ( )
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.

Returns
the SBMLNamespaces object that describes the SBML namespaces in effect.
unsigned int SBMLLevelVersionConverter::getTargetVersion ( )

Returns the target SBML Version for the conversion.

Returns
an integer indicating the Version within the SBML Level.
bool SBMLLevelVersionConverter::getValidityFlag ( )

Returns the flag indicating whether the conversion has been set to "strict".

Returns
true if strict validity has been requested, false otherwise.
bool SBMLLevelVersionConverter::matchesProperties ( const ConversionProperties props) const
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.

Parameters
propsthe properties to match.
Returns
true if this converter's properties match, false otherwise.

Reimplemented from SBMLConverter.

SBMLLevelVersionConverter & SBMLLevelVersionConverter::operator= ( const SBMLLevelVersionConverter rhs)

Assignment operator for SBMLLevelVersionConverter.

Parameters
rhsThe object whose values are used as the basis of the assignment.
Exceptions
SBMLConstructorExceptionThrown if the argument rhs is NULL.
int SBMLConverter::setDocument ( const SBMLDocument doc)
virtualinherited

Sets the current SBML document to the given SBMLDocument object.

Parameters
docthe document to use for this conversion.
Returns
integer value indicating the success/failure of the operation. The set of possible values that may be returned ultimately depends on the specific subclass of SBMLConverter being used, but the default method can return the following values:
int SBMLConverter::setProperties ( const ConversionProperties props)
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.

Parameters
propsthe ConversionProperties object defining the properties to set.
Returns
integer value indicating the success/failure of the operation. The set of possible values that may be returned ultimately depends on the specific subclass of SBMLConverter being used, but the default method can return the following values:
See Also
getProperties()
matchesProperties()