libSBML C++ API  5.11.0
CobraToFbcConverter Class Reference
Inheritance diagram for CobraToFbcConverter:
[legend]

Detailed Description

fbc COBRA to SBML Level 3 'fbc' converter.

Public Member Functions

bool checkCompatibility () const
 Returns a flag whether the level and version of the source document should be checked for compatibility before converting to SBML Level 3. More...
 
virtual CobraToFbcConverterclone () const
 Creates and returns a deep copy of this CobraToFbcConverter. More...
 
 CobraToFbcConverter ()
 Constructor. More...
 
 CobraToFbcConverter (const CobraToFbcConverter &)
 Copy constructor. More...
 
virtual int convert ()
 the actual 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...
 
virtual bool matchesProperties (const ConversionProperties &props) const
 This function determines whether a given converter matches the configuration properties given. More...
 
virtual int setDocument (const SBMLDocument *doc)
 Sets the SBML document to be converted. More...
 
virtual int setDocument (SBMLDocument *doc)
 Sets the SBML document to be converted. More...
 
virtual int setProperties (const ConversionProperties *props)
 Sets the configuration properties to be used by this converter. More...
 
virtual ~CobraToFbcConverter ()
 Destroy this CobraToFbcConverter object. More...
 

Constructor & Destructor Documentation

CobraToFbcConverter::CobraToFbcConverter ( )

Constructor.

CobraToFbcConverter::CobraToFbcConverter ( const CobraToFbcConverter orig)

Copy constructor.

CobraToFbcConverter::~CobraToFbcConverter ( )
virtual

Destroy this CobraToFbcConverter object.

Member Function Documentation

bool CobraToFbcConverter::checkCompatibility ( ) const

Returns a flag whether the level and version of the source document should be checked for compatibility before converting to SBML Level 3.

CobraToFbcConverter * CobraToFbcConverter::clone ( ) const
virtual

Creates and returns a deep copy of this CobraToFbcConverter.

Returns
a (deep) copy of this CobraToFbcConverter.

Reimplemented from SBMLConverter.

int CobraToFbcConverter::convert ( )
virtual

the actual conversion

Returns
status code represeting success/failure/conversion impossible

Reimplemented from SBMLConverter.

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

The properties for the CobraToFbcConverter are: "convert cobra" - the name of this converter

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.
const std::string & SBMLConverter::getName ( ) const
inherited

Returns the name of this converter.

Returns
a string, the name of this converter.
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()
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.
bool CobraToFbcConverter::matchesProperties ( const ConversionProperties props) const
virtual

This function determines whether a given converter matches the configuration properties given.

Parameters
propsthe properties to match
Returns
true if this converter is a match, false otherwise.

Reimplemented from SBMLConverter.

int SBMLConverter::setDocument ( const SBMLDocument doc)
virtualinherited

Sets the SBML document to be converted.

Parameters
docthe document to use for this conversion.
Returns
integer value indicating the success/failure of the operation. The value is drawn from the enumeration OperationReturnValues_t. 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:
Warning
Even though the argument 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 variant of the setDocument() method is here solely to preserve backwards compatibility.

Reimplemented in SBMLReactionConverter.

Examples:
flattenModel.cpp.
int SBMLConverter::setDocument ( SBMLDocument doc)
virtualinherited

Sets the SBML document to be converted.

Parameters
docthe document to use for this conversion.
Returns
integer value indicating the success/failure of the operation. The value is drawn from the enumeration OperationReturnValues_t. 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:

Reimplemented in SBMLReactionConverter.

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 value is drawn from the enumeration OperationReturnValues_t. 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()