libSBML Python API  5.10.0
 All Classes Namespaces Files Functions Variables Modules Pages
libsbml.ConversionProperties Class Reference
Inheritance diagram for libsbml.ConversionProperties:
[legend]

Detailed Description

{core}

Class of object that encapsulates the properties of an SBML converter.

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.

The properties of SBML converters are communicated using objects of class ConversionProperties, and within such objects, individual options are encapsulated using ConversionOption objects. The ConversionProperties class provides numerous methods for setting and getting options.

ConversionProperties objects are also used to determine the target SBML namespace when an SBML converter's behavior depends on the intended Level+Version combination of SBML. In addition, it is conceivable that conversions may be affected by SBML Level 3 packages being used by an SBML document. These, too, are communicated by the values of the SBML namespaces set on a ConversionProperties object.

See also
ConversionOption
SBMLNamespaces

Public Member Functions

def addOption
 
def clone
 
def getBoolValue
 
def getDescription
 
def getDoubleValue
 
def getFloatValue
 
def getIntValue
 
def getOption
 
def getTargetNamespaces
 
def getType
 
def getValue
 
def hasOption
 
def hasTargetNamespaces
 
def removeOption
 
def setBoolValue
 
def setDoubleValue
 
def setFloatValue
 
def setIntValue
 
def setTargetNamespaces
 
def setValue
 

Member Function Documentation

def libsbml.ConversionProperties.addOption (   self,
  args 
)

Python method signature(s):

addOption(ConversionProperties self, ConversionOption option)
addOption(ConversionProperties self, string key, string value="", long type=CNV_TYPE_STRING, string description="")
addOption(ConversionProperties self, string key, string value="", long type=CNV_TYPE_STRING)
addOption(ConversionProperties self, string key, string value="")
addOption(ConversionProperties self, string key)
addOption(ConversionProperties self, string key, char * value, string description="")
addOption(ConversionProperties self, string key, char * value)
addOption(ConversionProperties self, string key, bool value, string description="")
addOption(ConversionProperties self, string key, bool value)
addOption(ConversionProperties self, string key, float value, string description="")
addOption(ConversionProperties self, string key, float value)
addOption(ConversionProperties self, string key, float value, string description="")
addOption(ConversionProperties self, string key, float value)
addOption(ConversionProperties self, string key, int value, string description="")
addOption(ConversionProperties self, string key, int value)

This method has multiple variants that differ in the arguments they accept. Each is described separately below.


Method variant with the following signature:
addOption(ConversionOption option)

Adds a copy of the given option to this properties object.

Parameters
optionthe option to add

Method variant with the following signature:
addOption(string key, float value, string description='')

Adds a new ConversionOption object with the given parameters.

Parameters
keythe key for the new option
valuethe float value of that option
description(optional) the description for the option

Method variant with the following signature:
addOption(string key, int value, string description='')

Adds a new ConversionOption object with the given parameters.

Parameters
keythe key for the new option
valuethe integer value of that option
description(optional) the description for the option

Method variant with the following signature:
addOption(string key, float value, string description='')

Adds a new ConversionOption object with the given parameters.

Parameters
keythe key for the new option
valuethe float value of that option
description(optional) the description for the option

Method variant with the following signature:
addOption(string key, string value, string description='')

Adds a new ConversionOption object with the given parameters.

Parameters
keythe key for the new option
valuethe string value of that option
description(optional) the description for the option

Method variant with the following signature:
addOption(string key, bool value, string description='')

Adds a new ConversionOption object with the given parameters.

Parameters
keythe key for the new option
valuethe boolean value of that option
description(optional) the description for the option

Method variant with the following signature:
addOption(string key, string value='', long type=CNV_TYPE_STRING, string description='')

Adds a new ConversionOption object with the given parameters.

Parameters
keythe key for the new option
value(optional) the value of that option
type(optional) the type of the option
description(optional) the description for the option
def libsbml.ConversionProperties.clone (   self)

{core}

Class of object that encapsulates the properties of an SBML converter.

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.

The properties of SBML converters are communicated using objects of class ConversionProperties, and within such objects, individual options are encapsulated using ConversionOption objects. The ConversionProperties class provides numerous methods for setting and getting options.

ConversionProperties objects are also used to determine the target SBML namespace when an SBML converter's behavior depends on the intended Level+Version combination of SBML. In addition, it is conceivable that conversions may be affected by SBML Level 3 packages being used by an SBML document. These, too, are communicated by the values of the SBML namespaces set on a ConversionProperties object.

See also
ConversionOption
SBMLNamespaces Python method signature(s):
clone(ConversionProperties self)   ConversionProperties

Creates and returns a deep copy of this ConversionProperties object.

Returns
a (deep) copy of this ConversionProperties object.
def libsbml.ConversionProperties.getBoolValue (   self,
  args 
)

Python method signature(s):

getBoolValue(ConversionProperties self, string key)   bool

Returns the value of the given option as a Boolean.

Parameters
keythe key for the option.
Returns
the boolean value of the option with the given key.
def libsbml.ConversionProperties.getDescription (   self,
  args 
)

Python method signature(s):

getDescription(ConversionProperties self, string key)   string

Returns the description string for a given option in this properties object.

Parameters
keythe key for the option.
Returns
the description text of the option with the given key.
def libsbml.ConversionProperties.getDoubleValue (   self,
  args 
)

Python method signature(s):

getDoubleValue(ConversionProperties self, string key)   float

Returns the value of the given option as a float.

Parameters
keythe key for the option.
Returns
the float value of the option with the given key.
def libsbml.ConversionProperties.getFloatValue (   self,
  args 
)

Python method signature(s):

getFloatValue(ConversionProperties self, string key)   float

Returns the value of the given option as a float.

Parameters
keythe key for the option.
Returns
the float value of the option with the given key.
def libsbml.ConversionProperties.getIntValue (   self,
  args 
)

Python method signature(s):

getIntValue(ConversionProperties self, string key)   int

Returns the value of the given option as an integer.

Parameters
keythe key for the option.
Returns
the int value of the option with the given key.
def libsbml.ConversionProperties.getOption (   self,
  args 
)

Python method signature(s):

getOption(ConversionProperties self, string key)   ConversionOption

Returns the ConversionOption object for a given key.

Parameters
keythe key for the option.
Returns
the option with the given key.
def libsbml.ConversionProperties.getTargetNamespaces (   self)

Python method signature(s):

getTargetNamespaces(ConversionProperties self)   SBMLNamespaces

Returns the current target SBML namespace.

Returns
the SBMLNamepaces object expressing the target namespace.
def libsbml.ConversionProperties.getType (   self,
  args 
)

Python method signature(s):

getType(ConversionProperties self, string key)   long

Returns the type of a given option in this properties object.

Parameters
keythe key for the option.
Returns
the type of the option with the given key.
def libsbml.ConversionProperties.getValue (   self,
  args 
)

Python method signature(s):

getValue(ConversionProperties self, string key)   string

Returns the value of the given option as a string.

Parameters
keythe key for the option.
Returns
the string value of the option with the given key.
def libsbml.ConversionProperties.hasOption (   self,
  args 
)

Python method signature(s):

hasOption(ConversionProperties self, string key)   bool

Returns True if this properties object contains an option with the given key.

Parameters
keythe key of the option to find.
Returns
True if an option with the given key exists in this properties object, False otherwise.
def libsbml.ConversionProperties.hasTargetNamespaces (   self)

Python method signature(s):

hasTargetNamespaces(ConversionProperties self)   bool

Returns True if the target SBML namespace has been set.

Returns
True if the target namespace has been set, False otherwise.
def libsbml.ConversionProperties.removeOption (   self,
  args 
)

Python method signature(s):

removeOption(ConversionProperties self, string key)   ConversionOption

Removes the option with the given key from this properties object.

Parameters
keythe key for the new option to remove
Returns
the removed option
def libsbml.ConversionProperties.setBoolValue (   self,
  args 
)

Python method signature(s):

setBoolValue(ConversionProperties self, string key, bool value)

Sets the value of the given option to a Boolean.

Parameters
keythe key for the option.
valuethe new Boolean value.
def libsbml.ConversionProperties.setDoubleValue (   self,
  args 
)

Python method signature(s):

setDoubleValue(ConversionProperties self, string key, float value)

Sets the value of the given option to a float.

Parameters
keythe key for the option.
valuethe new float value.
def libsbml.ConversionProperties.setFloatValue (   self,
  args 
)

Python method signature(s):

setFloatValue(ConversionProperties self, string key, float value)

Sets the value of the given option to a float.

Parameters
keythe key for the option.
valuethe new float value.
def libsbml.ConversionProperties.setIntValue (   self,
  args 
)

Python method signature(s):

setIntValue(ConversionProperties self, string key, int value)

Sets the value of the given option to an integer.

Parameters
keythe key for the option.
valuethe new integer value.
def libsbml.ConversionProperties.setTargetNamespaces (   self,
  args 
)

Python method signature(s):

setTargetNamespaces(ConversionProperties self, SBMLNamespaces targetNS)

Sets the target namespace.

Parameters
targetNSthe target namespace to use.
def libsbml.ConversionProperties.setValue (   self,
  args 
)

Python method signature(s):

setValue(ConversionProperties self, string key, string value)

Sets the value of the given option to a string.

Parameters
keythe key for the option
valuethe new value