libSBML Python API
5.11.0
|
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:
CNV_TYPE_
. (See the separate subsection below for more information.) 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 a set of constants whose symbol names begin with the prefix CNV_TYPE_
. 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 float-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. |
Public Member Functions | |
def | __init__ (self, args) |
A single configuration setting for an SBML converter. More... | |
def | clone (self) |
Creates and returns a deep copy of this ConversionOption object. More... | |
def | getBoolValue (self) |
Returns the value of this option as a Boolean. More... | |
def | getDescription (self) |
Returns the description string for this option. More... | |
def | getDoubleValue (self) |
Returns the value of this option as a float . More... | |
def | getFloatValue (self) |
Returns the value of this option as a float . More... | |
def | getIntValue (self) |
Returns the value of this option as an integer . More... | |
def | getKey (self) |
Returns the key for this option. More... | |
def | getType (self) |
Returns the type of this option. More... | |
def | getValue (self) |
Returns the value of this option. More... | |
def | setBoolValue (self, value) |
Set the value of this option to a given Boolean value. More... | |
def | setDescription (self, description) |
Sets the description text for this option. More... | |
def | setDoubleValue (self, value) |
Set the value of this option to a given float value. More... | |
def | setFloatValue (self, value) |
Set the value of this option to a given float value. More... | |
def | setIntValue (self, value) |
Set the value of this option to a given int value. More... | |
def | setKey (self, key) |
Sets the key for this option. More... | |
def | setType (self, type) |
Sets the type of this option. More... | |
def | setValue (self, value) |
Sets the value for this option. More... | |
def libsbml.ConversionOption.clone | ( | self | ) |
Creates and returns a deep copy of this ConversionOption object.
clone() ConversionOption
def libsbml.ConversionOption.getBoolValue | ( | self | ) |
Returns the value of this option as a Boolean.
getBoolValue() bool
def libsbml.ConversionOption.getDescription | ( | self | ) |
Returns the description string for this option.
getDescription() string
def libsbml.ConversionOption.getDoubleValue | ( | self | ) |
Returns the value of this option as a float
.
getDoubleValue() float
def libsbml.ConversionOption.getFloatValue | ( | self | ) |
Returns the value of this option as a float
.
getFloatValue() float
def libsbml.ConversionOption.getIntValue | ( | self | ) |
Returns the value of this option as an integer
.
getIntValue() int
def libsbml.ConversionOption.getKey | ( | self | ) |
Returns the key for this option.
getKey() string
def libsbml.ConversionOption.getType | ( | self | ) |
Returns the type of this option.
getType() long
def libsbml.ConversionOption.getValue | ( | self | ) |
Returns the value of this option.
getValue() string
def libsbml.ConversionOption.setBoolValue | ( | self, | |
value | |||
) |
Set the value of this option to a given Boolean value.
setBoolValue(bool value)
Invoking this method will also set the type of the option to CNV_TYPE_BOOL.
value | the Boolean value to set |
def libsbml.ConversionOption.setDescription | ( | self, | |
description | |||
) |
Sets the description text for this option.
setDescription(string description)
description | the description to set for this option. |
def libsbml.ConversionOption.setDoubleValue | ( | self, | |
value | |||
) |
Set the value of this option to a given float
value.
setDoubleValue (float value)
Invoking this method will also set the type of the option to CNV_TYPE_DOUBLE.
value | the value to set |
def libsbml.ConversionOption.setFloatValue | ( | self, | |
value | |||
) |
Set the value of this option to a given float
value.
setFloatValue(float value)
Invoking this method will also set the type of the option to CNV_TYPE_SINGLE.
value | the value to set |
def libsbml.ConversionOption.setIntValue | ( | self, | |
value | |||
) |
Set the value of this option to a given int
value.
setIntValue(int value)
Invoking this method will also set the type of the option to CNV_TYPE_INT.
value | the value to set |
def libsbml.ConversionOption.setKey | ( | self, | |
key | |||
) |
Sets the key for this option.
setKey(string key)
key | a string representing the key to set. |
def libsbml.ConversionOption.setType | ( | self, | |
type | |||
) |
Sets the type of this option.
setType(long type)
type
argument value must be one of the constants whose names begin with the characters CNV_TYPE_
in the interface class libsbml. type | the type value to use. |
def libsbml.ConversionOption.setValue | ( | self, | |
value | |||
) |
Sets the value for this option.
setValue(string value)
value | the value to set, as a string. |