libSBML C API
libSBML 5.8.0 C API
|
Class of object that encapsulates a conversion option.
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.
LibSBML provides a number of converters that can perform transformations on SBML documents. These converters allow their behaviors to be controlled by setting property values. Converter properties are communicated using objects of class ConversionProperties, and within such objects, individual options are encapsulated using ConversionOption objects.
A ConversionOption object consists of four parts:
There are no constraints on the values of keys or descriptions; authors of SBML converters are free to choose them as they see fit.
An option in ConversionOption must have a data type declared, to indicate whether it is a string value, an integer, and so forth. The possible types of values are taken from the enumeration ConversionOptionType_t. The following are the possible values:
Enumerator | Meaning |
CNV_TYPE_BOOL | Indicates the value type is a Boolean. |
CNV_TYPE_DOUBLE | Indicates the value type is a double-sized float. |
CNV_TYPE_INT | Indicates the value type is an integer. |
CNV_TYPE_SINGLE | Indicates the value type is a float. |
CNV_TYPE_STRING | Indicates the value type is a string. |