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

Detailed Description

comp Flattening converter for the 'comp' package.

Public Member Functions

virtual SBMLConverterclone () const
 Creates and returns a deep copy of this CompFlatteningConverter. More...
 
 CompFlatteningConverter ()
 Constructor. More...
 
 CompFlatteningConverter (const CompFlatteningConverter &)
 Copy constructor. More...
 
virtual int convert ()
 Performs 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...
 
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 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...
 

Constructor & Destructor Documentation

CompFlatteningConverter::CompFlatteningConverter ( )

Constructor.

CompFlatteningConverter::CompFlatteningConverter ( const CompFlatteningConverter orig)

Copy constructor.

Member Function Documentation

SBMLConverter * CompFlatteningConverter::clone ( ) const
virtual

Creates and returns a deep copy of this CompFlatteningConverter.

Returns
a (deep) copy of this CompFlatteningConverter.

Reimplemented from SBMLConverter.

int CompFlatteningConverter::convert ( )
virtual

Performs the actual conversion.

Returns
status code represeting success/failure/conversion impossible

Reimplemented from SBMLConverter.

ConversionProperties CompFlatteningConverter::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 CompFlatteningConverter are:

  • "flatten comp": the name of this converter
  • "basePath": the base directory to find external references in
  • "leavePorts": unused ports should be listed in the flattened model
  • "listModelDefinitions": the model definitions should be listed in the flattened model
  • "ignorePackages": packages that cannot be flattened should be removed
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()
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.
bool CompFlatteningConverter::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 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 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:
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 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()