libSBML Perl API  libSBML 5.17.2 Perl API
SBMLRateOfConverter Class Reference
Inheritance diagram for SBMLRateOfConverter:
[legend]

Detailed Description

{core}

Converter to inteerchange csymbol 'rateOf' with FunctionDefinition.

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 converter will take an SBML model and either replace the use of csymbol rateOf in the model with a FunctionDefinition, or replace a FunctionDefinition named 'rateOf' with use of the csymbol.

Configuration and use of SBMLRateOfConverter

SBMLRateOfConverter is enabled by creating a ConversionProperties object with the option "replaceRateOf", and passing this properties object to SBMLDocument::convert(). This converter does not offer any additional configuration options.

In addition, this converter offers the following options:

  • "toFunction": If this option has the value true, then the conversion replaces csymbol with functionDefinition, if false, it replaces functionDefinition with csymbol.

Public Member Functions

virtual SBMLRateOfConverterclone () const
 Creates and returns a deep copy of this SBMLRateOfConverter 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...
 
const std::string & getName () const
 Returns the name of this converter. More...
 
virtual ConversionPropertiesgetProperties () const
 Returns the current properties in effect for this converter. More...
 
virtual SBMLNamespacesgetTargetNamespaces ()
 Returns the target SBML namespaces of the currently set properties. More...
 
bool getToFunctionDefinition ()
 Returns the direction of the conversion. More...
 
virtual bool matchesProperties (const ConversionProperties &props) const
 Returns true if this converter object's properties match the given properties. More...
 
 SBMLRateOfConverter ()
 Creates a new SBMLRateOfConverter object. More...
 
 SBMLRateOfConverter (const SBMLRateOfConverter &obj)
 Copy constructor; creates a copy of an SBMLRateOfConverter 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 ~SBMLRateOfConverter ()
 Destroy this SBMLRateOfConverter object. More...
 

Constructor & Destructor Documentation

◆ SBMLRateOfConverter() [1/2]

SBMLRateOfConverter::SBMLRateOfConverter ( )

Creates a new SBMLRateOfConverter object.

◆ SBMLRateOfConverter() [2/2]

SBMLRateOfConverter::SBMLRateOfConverter ( const SBMLRateOfConverter obj)

Copy constructor; creates a copy of an SBMLRateOfConverter object.

Parameters
objthe SBMLRateOfConverter object to copy.

◆ ~SBMLRateOfConverter()

SBMLRateOfConverter::~SBMLRateOfConverter ( )
virtual

Destroy this SBMLRateOfConverter object.

Member Function Documentation

◆ clone()

SBMLRateOfConverter * SBMLRateOfConverter::clone ( ) const
virtual

Creates and returns a deep copy of this SBMLRateOfConverter object.

Returns
a (deep) copy of this converter.

Reimplemented from SBMLConverter.

◆ convert()

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

Reimplemented from SBMLConverter.

◆ getDefaultProperties()

ConversionProperties SBMLRateOfConverter::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.

◆ getDocument() [1/2]

SBMLDocument * SBMLConverter::getDocument ( )
virtualinherited

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

Returns
the current SBMLDocument object.

◆ getDocument() [2/2]

const SBMLDocument * SBMLConverter::getDocument ( ) const
virtualinherited

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

Returns
the current SBMLDocument object.

◆ getName()

const std::string & SBMLConverter::getName ( ) const
inherited

Returns the name of this converter.

Returns
a string, the name of this converter.

◆ getProperties()

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

◆ getTargetNamespaces()

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, in SBMLLevelVersionConverter (the converter for converting SBML documents from one Level+Version combination to another), the actions are fundamentally dependent on the SBML namespaces targeted.

Returns
the SBMLNamespaces object that describes the SBML namespaces in effect, or NULL if none are set.

◆ getToFunctionDefinition()

bool SBMLRateOfConverter::getToFunctionDefinition ( )

Returns the direction of the conversion.

Returns
true if adding functionDefinition has been requested, false otherwise.

◆ matchesProperties()

bool SBMLRateOfConverter::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 SBMLRateOfConverter 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.

◆ setDocument() [1/2]

int SBMLRateOfConverter::setDocument ( const SBMLDocument doc)
virtual

Sets the current SBML document to the given SBMLDocument object.

Parameters
docthe document to use for this conversion.
Warning
Even though the 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 from SBMLConverter.

◆ setDocument() [2/2]

int SBMLRateOfConverter::setDocument ( SBMLDocument doc)
virtual

Sets the current SBML document to the given SBMLDocument object.

Parameters
docthe document to use for this conversion.

Reimplemented from SBMLConverter.

◆ setProperties()

int SBMLConverter::setProperties ( const ConversionProperties props)
virtualinherited

Sets the configuration properties to be used by 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: